Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]

Class: Microsoft_WindowsAzure_Management_Client

Source Location: /WindowsAzure/Management/Client.php

Class Overview




Author(s):

Copyright:

  • Copyright (c) 2009 - 2010, RealDolmen (http://www.realdolmen.com)

Variables

Constants

Methods



Class Details

[line 48]


Tags:

copyright:  Copyright (c) 2009 - 2010, RealDolmen (http://www.realdolmen.com)
license:  http://phpazure.codeplex.com/license


[ Top ]


Class Variables

$_apiVersion =  '2011-02-25'

[line 71]

Current API version



Tags:

access:  protected

Type:   string


[ Top ]

$_certificatePassphrase =  ''

[line 92]

Management certificate passphrase



Tags:

access:  protected

Type:   string


[ Top ]

$_certificatePath =  ''

[line 85]

Management certificate path (.PEM)



Tags:

access:  protected

Type:   string


[ Top ]

$_httpClientChannel =  null

[line 99]

Microsoft_Http_Client channel used for communication with REST services



Tags:

access:  protected



[ Top ]

$_lastRequestId =  null

[line 113]

Returns the last request ID



Tags:

access:  protected

Type:   string


[ Top ]

$_retryPolicy =  null

[line 106]

Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance



Tags:

access:  protected



[ Top ]

$_subscriptionId =  ''

[line 78]

Subscription ID



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


static method createQueryStringFromArray [line 317]

static string createQueryStringFromArray( array $queryString)

Builds a query string from an array of elements



Tags:

return:  Assembled query string
access:  public


Parameters:

array   $queryString   Array of elements

[ Top ]

static method urlencode [line 306]

static string urlencode( string $value)

URL encode function



Tags:

return:  Encoded value
access:  public


Parameters:

string   $value   Value to encode

[ Top ]

constructor __construct [line 123]

Microsoft_WindowsAzure_Management_Client __construct( string $subscriptionId, string $certificatePath, string $certificatePassphrase, [Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Management instance



Tags:

access:  public


Parameters:

string   $subscriptionId   Subscription ID
string   $certificatePath   Management certificate path (.PEM)
string   $certificatePassphrase   Management certificate passphrase
Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract   $retryPolicy   Retry policy to use when making requests

[ Top ]

method addCertificate [line 1820]

void addCertificate( string $serviceName, string $certificateData, string $certificatePassword, [string $certificateFormat = 'pfx'])

The Add Certificate operation adds a certificate to the subscription.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $certificateData   Certificate data
string   $certificatePassword   The certificate password
string   $certificateFormat   The certificate format. Currently, only 'pfx' is supported.

[ Top ]

method configureDeploymentByDeploymentId [line 1383]

void configureDeploymentByDeploymentId( string $serviceName, string $deploymentId, string $configuration)

The Change Deployment Configuration request may be specified as follows.

Note that you can change a deployment's configuration either by specifying the deployment environment (staging or production), or by specifying the deployment's unique name.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
string   $configuration   XML configuration represented as a string

[ Top ]

method configureDeploymentBySlot [line 1352]

void configureDeploymentBySlot( string $serviceName, string $deploymentSlot, string $configuration)

The Change Deployment Configuration request may be specified as follows.

Note that you can change a deployment's configuration either by specifying the deployment environment (staging or production), or by specifying the deployment's unique name.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $configuration   XML configuration represented as a string

[ Top ]

method createAffinityGroup [line 1927]

void createAffinityGroup( string $name, string $label, [string $description = ''], [string $location = ''])

The Create Affinity Group operation creates a new affinity group for the specified subscription.



Tags:

access:  public


Parameters:

string   $name   A name for the affinity group that is unique to the subscription.
string   $label   A label for the affinity group. The label may be up to 100 characters in length.
string   $description   A description for the affinity group. The description may be up to 1024 characters in length.
string   $location   The location where the affinity group will be created. To list available locations, use the List Locations operation.

[ Top ]

method createBlobClientForService [line 495]

Microsoft_WindowsAzure_Storage_Blob createBlobClientForService( string $serviceName, [Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage_Blob instance for the current account



Tags:

access:  public


Parameters:

string   $serviceName   the service name to create a storage client for.
Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract   $retryPolicy   Retry policy to use when making requests

[ Top ]

method createDeployment [line 901]

void createDeployment( string $serviceName, string $deploymentSlot, string $name, string $label, string $packageUrl, string $configuration, [boolean $startDeployment = false], [boolean $treatWarningsAsErrors = false])

The Create Deployment operation uploads a new service package and creates a new deployment on staging or production.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $name   The name for the deployment. The deployment ID as listed on the Windows Azure management portal must be unique among other deployments for the hosted service.
string   $label   A URL that refers to the location of the service package in the Blob service. The service package must be located in a storage account beneath the same subscription.
string   $packageUrl   The service configuration file for the deployment.
string   $configuration   A label for this deployment, up to 100 characters in length.
boolean   $startDeployment   Indicates whether to start the deployment immediately after it is created.
boolean   $treatWarningsAsErrors   Indicates whether to treat package validation warnings as errors.

[ Top ]

method createHostedService [line 755]

void createHostedService( string $serviceName, string $label, [string $description = ''], [string $location = null], [string $affinityGroup = null])

The Create Hosted Service operation creates a new hosted service in Windows Azure.



Tags:

access:  public


Parameters:

string   $serviceName   A name for the hosted service that is unique to the subscription.
string   $label   A label for the hosted service. The label may be up to 100 characters in length.
string   $description   A description for the hosted service. The description may be up to 1024 characters in length.
string   $location   Required if AffinityGroup is not specified. The location where the hosted service will be created.
string   $affinityGroup   Required if Location is not specified. The name of an existing affinity group associated with this subscription.

[ Top ]

method createQueueClientForService [line 543]

Microsoft_WindowsAzure_Storage_Queue createQueueClientForService( string $serviceName, [Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage_Queue instance for the current account



Tags:

access:  public


Parameters:

string   $serviceName   the service name to create a storage client for.
Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract   $retryPolicy   Retry policy to use when making requests

[ Top ]

method createTableClientForService [line 519]

Microsoft_WindowsAzure_Storage_Table createTableClientForService( string $serviceName, [Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage_Table instance for the current account



Tags:

access:  public


Parameters:

string   $serviceName   the service name to create a storage client for.
Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract   $retryPolicy   Retry policy to use when making requests

[ Top ]

method deleteAffinityGroup [line 1992]

void deleteAffinityGroup( string $name)

The Delete Affinity Group operation deletes an affinity group in the specified subscription.



Tags:

access:  public


Parameters:

string   $name   The name for the affinity group that should be deleted.

[ Top ]

method deleteCertificate [line 1858]

void deleteCertificate( $serviceName, [string $algorithm = ''], [string $thumbprint = ''], string $serviceName|$certificateUrl)

The Delete Certificate operation deletes a certificate from the subscription's certificate store.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName|$certificateUrl   The service name -or- the certificate URL
string   $algorithm   Algorithm
string   $thumbprint   Thumbprint
   $serviceName  

[ Top ]

method deleteDeploymentByDeploymentId [line 1073]

void deleteDeploymentByDeploymentId( string $serviceName, string $deploymentId)

The Delete Deployment operation deletes the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal

[ Top ]

method deleteDeploymentBySlot [line 1052]

void deleteDeploymentBySlot( string $serviceName, string $deploymentSlot)

The Delete Deployment operation deletes the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)

[ Top ]

method deleteHostedService [line 821]

void deleteHostedService( string $serviceName)

The Delete Hosted Service operation deletes the specified hosted service in Windows Azure.



Tags:

access:  public


Parameters:

string   $serviceName   A name for the hosted service that is unique to the subscription.

[ Top ]

method getAffinityGroupProperties [line 2014]

Microsoft_WindowsAzure_Management_AffinityGroupInstance getAffinityGroupProperties( string $affinityGroupName)

The Get Affinity Group Properties operation returns the system properties associated with the specified affinity group.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $affinityGroupName   The affinity group name.

[ Top ]

method getBaseUrl [line 201]

string getBaseUrl( )

Get base URL for creating requests



Tags:

access:  public


[ Top ]

method getCertificate [line 1781]

Microsoft_WindowsAzure_Management_CertificateInstance getCertificate( $serviceName, [string $algorithm = ''], [string $thumbprint = ''], string $serviceName|$certificateUrl)

The Get Certificate operation returns the public data for the specified certificate.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName|$certificateUrl   The service name -or- the certificate URL
string   $algorithm   Algorithm
string   $thumbprint   Thumbprint
   $serviceName  

[ Top ]

method getDeploymentByDeploymentId [line 976]

Microsoft_WindowsAzure_Management_DeploymentInstance getDeploymentByDeploymentId( string $serviceName, string $deploymentId)

The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal

[ Top ]

method getDeploymentBySlot [line 953]

Microsoft_WindowsAzure_Management_DeploymentInstance getDeploymentBySlot( string $serviceName, string $deploymentSlot)

The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)

[ Top ]

method getHostedServiceProperties [line 845]

Microsoft_WindowsAzure_Management_HostedServiceInstance getHostedServiceProperties( string $serviceName)

The Get Hosted Service Properties operation retrieves system properties

for the specified hosted service. These properties include the service name and service type; the name of the affinity group to which the service belongs, or its location if it is not part of an affinity group; and optionally, information on the service's deployments.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The name of your service.

[ Top ]

method getHttpClientChannel [line 171]

Microsoft_Http_Client_Adapter_Interface getHttpClientChannel( )

Retrieve HTTP client channel



Tags:

access:  public


[ Top ]

method getLastRequestId [line 191]

string getLastRequestId( )

Returns the last request ID.



Tags:

access:  public


[ Top ]

method getOperationStatus [line 348]

Microsoft_WindowsAzure_Management_OperationStatusInstance getOperationStatus( [string $requestId = ''])

The Get Operation Status operation returns the status of the specified operation.

After calling an asynchronous operation, you can call Get Operation Status to determine whether the operation has succeed, failed, or is still in progress.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $requestId   The request ID. If omitted, the last request ID will be used.

[ Top ]

method getStorageAccountKeys [line 642]

array getStorageAccountKeys( string $serviceName)

The Get Storage Keys operation returns the primary and secondary access keys for the specified storage account.



Tags:

return:  An array of strings
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The name of your service.

[ Top ]

method getStorageAccountProperties [line 607]

Microsoft_WindowsAzure_Management_StorageServiceInstance getStorageAccountProperties( string $serviceName)

The Get Storage Account Properties operation returns the system properties for the specified storage account. These properties include: the address, description, and label of the storage account; and the name of the affinity group to which the service belongs, or its geo-location if it is not part of an affinity group.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The name of your service.

[ Top ]

method getSubscriptionId [line 181]

string getSubscriptionId( )

Returns the Windows Azure subscription ID



Tags:

access:  public


[ Top ]

method listAffinityGroups [line 1886]

array listAffinityGroups( )

The List Affinity Groups operation lists the affinity groups associated with the specified subscription.



Tags:

return:  Array of Microsoft_WindowsAzure_Management_AffinityGroupInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


[ Top ]

method listCertificates [line 1734]

array listCertificates( string $serviceName)

The List Certificates operation lists all certificates associated with the specified hosted service.



Tags:

return:  Array of Microsoft_WindowsAzure_Management_CertificateInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name

[ Top ]

method listHostedServices [line 715]

array listHostedServices( )

The List Hosted Services operation lists the hosted services available under the current subscription.



Tags:

return:  An array of Microsoft_WindowsAzure_Management_HostedServiceInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


[ Top ]

method listLocations [line 2081]

array listLocations( )

The List Locations operation lists all of the data center locations that are valid for your subscription.



Tags:

return:  Array of Microsoft_WindowsAzure_Management_LocationInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


[ Top ]

method listOperatingSystemFamilies [line 2170]

array listOperatingSystemFamilies( )

The List OS Families operation lists the guest operating system families

available in Windows Azure, and also lists the operating system versions available for each family. Currently Windows Azure supports two operating system families: the Windows Azure guest operating system that is substantially compatible with Windows Server 2008 SP2, and the Windows Azure guest operating system that is substantially compatible with Windows Server 2008 R2.




Tags:

return:  Array of Microsoft_WindowsAzure_Management_OperatingSystemFamilyInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


[ Top ]

method listOperatingSystems [line 2123]

array listOperatingSystems( )

The List Operating Systems operation lists the versions of the guest operating system that are currently available in Windows Azure. The 2010-10-28 version of List Operating Systems also indicates what family an operating system version belongs to.

Currently Windows Azure supports two operating system families: the Windows Azure guest operating system that is substantially compatible with Windows Server 2008 SP2, and the Windows Azure guest operating system that is substantially compatible with Windows Server 2008 R2.




Tags:

return:  Array of Microsoft_WindowsAzure_Management_OperatingSystemInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


[ Top ]

method listStorageAccounts [line 566]

array listStorageAccounts( )

The List Storage Accounts operation lists the storage accounts available under the current subscription.



Tags:

return:  An array of Microsoft_WindowsAzure_Management_StorageServiceInstance
access:  public


[ Top ]

method listSubscriptionOperations [line 388]

array listSubscriptionOperations( string $startTime, string $endTime, [string $objectIdFilter = null], [string $operationResultFilter = null], [string $continuationToken = null])

The List Subscription Operations operation returns a list of create, update, and delete operations that were performed on a subscription during the specified timeframe.

Documentation on the parameters can be found at http://msdn.microsoft.com/en-us/library/gg715318.aspx.




Tags:

return:  Array of Microsoft_WindowsAzure_Management_SubscriptionOperationInstance
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $startTime   The start of the timeframe to begin listing subscription operations in UTC format. This parameter and the $endTime parameter indicate the timeframe to retrieve subscription operations. This parameter cannot indicate a start date of more than 90 days in the past.
string   $endTime   The end of the timeframe to begin listing subscription operations in UTC format. This parameter and the $startTime parameter indicate the timeframe to retrieve subscription operations.
string   $objectIdFilter   Returns subscription operations only for the specified object type and object ID.
string   $operationResultFilter   Returns subscription operations only for the specified result status, either Succeeded, Failed, or InProgress.
string   $continuationToken   Internal usage.

[ Top ]

method rebootRoleInstanceByDeploymentId [line 1643]

void rebootRoleInstanceByDeploymentId( string $serviceName, string $deploymentId, string $roleInstanceName)

The Reboot Role Instance operation requests a reboot of a role instance that is running in a deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
string   $roleInstanceName   The role instance name

[ Top ]

method rebootRoleInstanceBySlot [line 1617]

void rebootRoleInstanceBySlot( string $serviceName, string $deploymentSlot, string $roleInstanceName)

The Reboot Role Instance operation requests a reboot of a role instance that is running in a deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $roleInstanceName   The role instance name

[ Top ]

method regenerateStorageAccountKey [line 674]

array regenerateStorageAccountKey( string $serviceName, [string $key = 'primary'])

The Regenerate Keys operation regenerates the primary or secondary access key for the specified storage account.



Tags:

return:  An array of strings
throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The name of your service.
string   $key   The key to regenerate (primary or secondary)

[ Top ]

method reimageRoleInstanceByDeploymentId [line 1694]

void reimageRoleInstanceByDeploymentId( string $serviceName, string $deploymentId, string $roleInstanceName)

The Reimage Role Instance operation requests a reimage of a role instance that is running in a deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
string   $roleInstanceName   The role instance name

[ Top ]

method reimageRoleInstanceBySlot [line 1668]

void reimageRoleInstanceBySlot( string $serviceName, string $deploymentSlot, string $roleInstanceName)

The Reimage Role Instance operation requests a reimage of a role instance that is running in a deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $roleInstanceName   The role instance name

[ Top ]

method setHttpClientChannel [line 161]

void setHttpClientChannel( [Microsoft_Http_Client_Adapter_Interface|string $adapterInstance = 'Microsoft_Http_Client_Adapter_Socket'])

Set the HTTP client channel to use



Tags:

access:  public


Parameters:

Microsoft_Http_Client_Adapter_Interface|string   $adapterInstance   Adapter instance or adapter class name.

[ Top ]

method setInstanceCountByDeploymentId [line 1280]

void setInstanceCountByDeploymentId( string $serviceName, $deploymentId, string|array $roleName, string|array $instanceCount, string $deploymentSlot)

Updates a deployment's role instance count.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string|array   $roleName   The role name
string|array   $instanceCount   The instance count
   $deploymentId  

[ Top ]

method setInstanceCountBySlot [line 1250]

void setInstanceCountBySlot( string $serviceName, string $deploymentSlot, string|array $roleName, string|array $instanceCount)

Updates a deployment's role instance count.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string|array   $roleName   The role name
string|array   $instanceCount   The instance count

[ Top ]

method swapDeployment [line 1022]

void swapDeployment( string $serviceName, string $productionDeploymentName, string $sourceDeploymentName)

The Swap Deployment operation initiates a virtual IP swap between the staging and production deployment environments for a service.

If the service is currently running in the staging environment, it will be swapped to the production environment. If it is running in the production environment, it will be swapped to staging.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name.
string   $productionDeploymentName   The name of the production deployment.
string   $sourceDeploymentName   The name of the source deployment.

[ Top ]

method updateAffinityGroup [line 1962]

void updateAffinityGroup( string $name, string $label, [string $description = ''])

The Update Affinity Group operation updates the label and/or the description for an affinity group for the specified subscription.



Tags:

access:  public


Parameters:

string   $name   The name for the affinity group that should be updated.
string   $label   A label for the affinity group. The label may be up to 100 characters in length.
string   $description   A description for the affinity group. The description may be up to 1024 characters in length.

[ Top ]

method updateDeploymentStatusByDeploymentId [line 1135]

void updateDeploymentStatusByDeploymentId( string $serviceName, string $deploymentId, [string $status = 'running'])

The Update Deployment Status operation initiates a change in deployment status.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
string   $status   The deployment status (running|suspended)

[ Top ]

method updateDeploymentStatusBySlot [line 1109]

void updateDeploymentStatusBySlot( string $serviceName, string $deploymentSlot, [string $status = 'running'])

The Update Deployment Status operation initiates a change in deployment status.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $status   The deployment status (running|suspended)

[ Top ]

method updateHostedService [line 794]

void updateHostedService( string $serviceName, string $label, [string $description = ''])

The Update Hosted Service operation updates the label and/or the description for a hosted service in Windows Azure.



Tags:

access:  public


Parameters:

string   $serviceName   A name for the hosted service that is unique to the subscription.
string   $label   A label for the hosted service. The label may be up to 100 characters in length.
string   $description   A description for the hosted service. The description may be up to 1024 characters in length.

[ Top ]

method upgradeDeploymentByDeploymentId [line 1485]

void upgradeDeploymentByDeploymentId( string $serviceName, string $deploymentId, string $label, string $packageUrl, string $configuration, [string $mode = 'auto'], [string $roleToUpgrade = null])

The Upgrade Deployment operation initiates an upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
string   $label   A URL that refers to the location of the service package in the Blob service. The service package must be located in a storage account beneath the same subscription.
string   $packageUrl   The service configuration file for the deployment.
string   $configuration   A label for this deployment, up to 100 characters in length.
string   $mode   The type of upgrade to initiate. Possible values are Auto or Manual.
string   $roleToUpgrade   The name of the specific role to upgrade.

[ Top ]

method upgradeDeploymentBySlot [line 1439]

void upgradeDeploymentBySlot( string $serviceName, string $deploymentSlot, string $label, string $packageUrl, string $configuration, [string $mode = 'auto'], [string $roleToUpgrade = null])

The Upgrade Deployment operation initiates an upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
string   $label   A URL that refers to the location of the service package in the Blob service. The service package must be located in a storage account beneath the same subscription.
string   $packageUrl   The service configuration file for the deployment.
string   $configuration   A label for this deployment, up to 100 characters in length.
string   $mode   The type of upgrade to initiate. Possible values are Auto or Manual.
string   $roleToUpgrade   The name of the specific role to upgrade.

[ Top ]

method waitForOperation [line 470]

Microsoft_WindowsAzure_Management_OperationStatusInstance waitForOperation( [string $requestId = ''], [int $sleepInterval = 250])

Wait for an operation to complete



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $requestId   The request ID. If omitted, the last request ID will be used.
int   $sleepInterval   Sleep interval in milliseconds.

[ Top ]

method walkUpgradeDomainByDeploymentId [line 1575]

void walkUpgradeDomainByDeploymentId( string $serviceName, string $deploymentId, [int $upgradeDomain = 0])

The Walk Upgrade Domain operation specifies the next upgrade domain to be walked during an in-place upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentId   The deployment ID as listed on the Windows Azure management portal
int   $upgradeDomain   An integer value that identifies the upgrade domain to walk. Upgrade domains are identified with a zero-based index: the first upgrade domain has an ID of 0, the second has an ID of 1, and so on.

[ Top ]

method walkUpgradeDomainBySlot [line 1553]

void walkUpgradeDomainBySlot( string $serviceName, string $deploymentSlot, [int $upgradeDomain = 0])

The Walk Upgrade Domain operation specifies the next upgrade domain to be walked during an in-place upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  public


Parameters:

string   $serviceName   The service name
string   $deploymentSlot   The deployment slot (production or staging)
int   $upgradeDomain   An integer value that identifies the upgrade domain to walk. Upgrade domains are identified with a zero-based index: the first upgrade domain has an ID of 0, the second has an ID of 1, and so on.

[ Top ]

method _cleanConfiguration [line 2228]

string _cleanConfiguration( string $configuration)

Clean configuration



Tags:

access:  public


Parameters:

string   $configuration   Configuration to clean.

[ Top ]

method _configureDeployment [line 1412]

void _configureDeployment( string $operationUrl, string $configuration)

The Change Deployment Configuration request may be specified as follows.

Note that you can change a deployment's configuration either by specifying the deployment environment (staging or production), or by specifying the deployment's unique name.




Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url
string   $configuration   XML configuration represented as a string

[ Top ]

method _convertXmlElementToDeploymentInstance [line 1178]

Microsoft_WindowsAzure_Management_DeploymentInstance _convertXmlElementToDeploymentInstance( object $xmlService)

Converts an XmlElement into a Microsoft_WindowsAzure_Management_DeploymentInstance



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

object   $xmlService   The XML Element

[ Top ]

method _deleteDeployment [line 1092]

void _deleteDeployment( string $operationUrl)

The Delete Deployment operation deletes the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url

[ Top ]

method _getDeployment [line 997]

Microsoft_WindowsAzure_Management_DeploymentInstance _getDeployment( string $operationUrl)

The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url

[ Top ]

method _getErrorMessage [line 329]

string _getErrorMessage( $response, [string $alternativeError = 'Unknown error.'])

Get error message from Microsoft_Http_Response



Tags:

access:  protected


Parameters:

Microsoft_Http_Response   $response   Repsonse
string   $alternativeError   Alternative error message

[ Top ]

method _parseResponse [line 277]

object _parseResponse( [ $response = null])

Parse result from Microsoft_Http_Response



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  protected


Parameters:

Microsoft_Http_Response   $response   Response from HTTP call

[ Top ]

method _performRequest [line 216]

Microsoft_Http_Response _performRequest( [string $path = '/'], [string $queryString = ''], [string $httpVerb = Microsoft_Http_Client::GET], [array $headers = array()], [mixed $rawData = null])

Perform request using Microsoft_Http_Client channel



Tags:

access:  protected


Parameters:

string   $path   Path
string   $queryString   Query string
string   $httpVerb   HTTP verb the request will use
array   $headers   x-ms headers to add
mixed   $rawData   Optional RAW HTTP data to be sent over the wire

[ Top ]

method _rebootOrReimageRoleInstance [line 1717]

void _rebootOrReimageRoleInstance( string $operationUrl, [string $operation = 'reboot'])

Reboots or reimages a role instance.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url
string   $operation   The operation (reboot|reimage)

[ Top ]

method _updateDeploymentStatus [line 1159]

void _updateDeploymentStatus( string $operationUrl, [string $status = 'running'])

The Update Deployment Status operation initiates a change in deployment status.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url
string   $status   The deployment status (running|suspended)

[ Top ]

method _updateInstanceCountInConfiguration [line 1309]

void _updateInstanceCountInConfiguration( string|array $roleName, string|array $instanceCount, string $configuration)

Updates instance count in configuration XML.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string|array   $roleName   The role name
string|array   $instanceCount   The instance count
string   $configuration   XML configuration represented as a string

[ Top ]

method _upgradeDeployment [line 1530]

void _upgradeDeployment( string $operationUrl, string $label, string $packageUrl, string $configuration, string $mode, string $roleToUpgrade)

The Upgrade Deployment operation initiates an upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url
string   $label   A URL that refers to the location of the service package in the Blob service. The service package must be located in a storage account beneath the same subscription.
string   $packageUrl   The service configuration file for the deployment.
string   $configuration   A label for this deployment, up to 100 characters in length.
string   $mode   The type of upgrade to initiate. Possible values are Auto or Manual.
string   $roleToUpgrade   The name of the specific role to upgrade.

[ Top ]

method _walkUpgradeDomain [line 1596]

void _walkUpgradeDomain( string $operationUrl, [int $upgradeDomain = 0])

The Walk Upgrade Domain operation specifies the next upgrade domain to be walked during an in-place upgrade.



Tags:

throws:  Microsoft_WindowsAzure_Management_Exception
access:  protected


Parameters:

string   $operationUrl   The operation url
int   $upgradeDomain   An integer value that identifies the upgrade domain to walk. Upgrade domains are identified with a zero-based index: the first upgrade domain has an ID of 0, the second has an ID of 1, and so on.

[ Top ]


Class Constants

OP_AFFINITYGROUPS =  "affinitygroups"

[line 61]


[ Top ]

OP_HOSTED_SERVICES =  "services/hostedservices"

[line 60]


[ Top ]

OP_LOCATIONS =  "locations"

[line 62]


[ Top ]

OP_OPERATINGSYSTEMFAMILIES =  "operatingsystemfamilies"

[line 64]


[ Top ]

OP_OPERATINGSYSTEMS =  "operatingsystems"

[line 63]


[ Top ]

OP_OPERATIONS =  "operations"

[line 58]

Operations


[ Top ]

OP_STORAGE_ACCOUNTS =  "services/storageservices"

[line 59]


[ Top ]

URL_MANAGEMENT =  "https://management.core.windows.net"

[line 53]

Management service URL


[ Top ]



Documentation generated on Wed, 18 May 2011 12:06:18 +0200 by phpDocumentor 1.4.3