category Zend
package Zend_Service_WindowsAzure
subpackage Management
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Creates a new Zend_Service_WindowsAzure_Management instance

__construct(string $subscriptionId, string $certificatePath, string $certificatePassphrase, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null

Parameters

$subscriptionId

string

Subscription ID

$certificatePath

string

Management certificate path (.PEM)

$certificatePassphrase

string

Management certificate passphrase

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Clean configuration

_cleanConfiguration(string $configuration) : string

Parameters

$configuration

string

Configuration to clean.

Returns

string

The Add Certificate operation adds a certificate to the subscription.

addCertificate(string $serviceName, string $certificateData, string $certificatePassword, string $certificateFormat = 'pfx'

Parameters

$serviceName

string

The service name

$certificateData

string

Certificate data

$certificatePassword

string

The certificate password

$certificateFormat

string

The certificate format. Currently, only 'pfx' is supported.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Change Deployment Configuration request may be specified as follows.

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

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.

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$configuration

string

XML configuration represented as a string

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Change Deployment Configuration request may be specified as follows.

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

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.

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$configuration

string

XML configuration represented as a string

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

createAffinityGroup(string $name, string $label, string $description = '', string $location = ''

Parameters

$name

string

A name for the affinity group that is unique to the subscription.

$label

string

A label for the affinity group. The label may be up to 100 characters in length.

$description

string

A description for the affinity group. The description may be up to 1024 characters in length.

$location

string

The location where the affinity group will be created. To list available locations, use the List Locations operation.

Creates a new Zend_Service_WindowsAzure_Storage_Blob instance for the current account

createBlobClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) : \Zend_Service_WindowsAzure_Storage_Blob

Parameters

$serviceName

string

the service name to create a storage client for.

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Returns

\Zend_Service_WindowsAzure_Storage_Blob

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

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

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$name

string

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.

$label

string

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.

$packageUrl

string

The service configuration file for the deployment.

$configuration

string

A label for this deployment, up to 100 characters in length.

$startDeployment

boolean

Indicates whether to start the deployment immediately after it is created.

$treatWarningsAsErrors

boolean

Indicates whether to treat package validation warnings as errors.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

createHostedService(string $serviceName, string $label, string $description = '', string $location = null, string $affinityGroup = null

Parameters

$serviceName

string

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

$label

string

A label for the hosted service. The label may be up to 100 characters in length.

$description

string

A description for the hosted service. The description may be up to 1024 characters in length.

$location

string

Required if AffinityGroup is not specified. The location where the hosted service will be created.

$affinityGroup

string

Required if Location is not specified. The name of an existing affinity group associated with this subscription.

Builds a query string from an array of elements

createQueryStringFromArray($queryString) : string
Static

Parameters

$queryString

Returns

stringAssembled query string

Creates a new Zend_Service_WindowsAzure_Storage_Queue instance for the current account

createQueueClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) : \Zend_Service_WindowsAzure_Storage_Queue

Parameters

$serviceName

string

the service name to create a storage client for.

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Returns

\Zend_Service_WindowsAzure_Storage_Queue

Creates a new Zend_Service_WindowsAzure_Storage_Table instance for the current account

createTableClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) : \Zend_Service_WindowsAzure_Storage_Table

Parameters

$serviceName

string

the service name to create a storage client for.

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Returns

\Zend_Service_WindowsAzure_Storage_Table

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

deleteAffinityGroup(string $name) 

Parameters

$name

string

The name for the affinity group that should be deleted.

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

deleteCertificate($serviceName, string $algorithm = '', string $thumbprint = ''

Parameters

$serviceName

$algorithm

string

Algorithm

$thumbprint

string

Thumbprint

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Delete Deployment operation deletes the specified deployment.

deleteDeploymentByDeploymentId(string $serviceName, string $deploymentId) 

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Delete Deployment operation deletes the specified deployment.

deleteDeploymentBySlot(string $serviceName, string $deploymentSlot) 

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

deleteHostedService(string $serviceName) 

Parameters

$serviceName

string

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

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

getAffinityGroupProperties(string $affinityGroupName) : \Zend_Service_WindowsAzure_Management_AffinityGroupInstance

Parameters

$affinityGroupName

string

The affinity group name.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_AffinityGroupInstance

Get base URL for creating requests

getBaseUrl() : string

Returns

string

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

getCertificate($serviceName, string $algorithm = '', string $thumbprint = '') : \Zend_Service_WindowsAzure_Management_CertificateInstance

Parameters

$serviceName

$algorithm

string

Algorithm

$thumbprint

string

Thumbprint

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_CertificateInstance

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

getDeploymentByDeploymentId(string $serviceName, string $deploymentId) : \Zend_Service_WindowsAzure_Management_DeploymentInstance

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_DeploymentInstance

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

getDeploymentBySlot(string $serviceName, string $deploymentSlot) : \Zend_Service_WindowsAzure_Management_DeploymentInstance

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_DeploymentInstance

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.

getHostedServiceProperties(string $serviceName) : \Zend_Service_WindowsAzure_Management_HostedServiceInstance

Parameters

$serviceName

string

The name of your service.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_HostedServiceInstance

Retrieve HTTP client channel

getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface

Returns

\Zend_Http_Client_Adapter_Interface

Returns the last request ID.

getLastRequestId() : string

Returns

string

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

getOperationStatus(string $requestId = '') : \Zend_Service_WindowsAzure_Management_OperationStatusInstance

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

Parameters

$requestId

string

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

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_OperationStatusInstance

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

getStorageAccountKeys(string $serviceName) : array

Parameters

$serviceName

string

The name of your service.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayAn array of strings

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.

getStorageAccountProperties(string $serviceName) : \Zend_Service_WindowsAzure_Management_StorageServiceInstance

Parameters

$serviceName

string

The name of your service.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_StorageServiceInstance

Returns the Windows Azure subscription ID

getSubscriptionId() : string

Returns

string

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

listAffinityGroups() : array

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_AffinityGroupInstance

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

listCertificates(string $serviceName) : array

Parameters

$serviceName

string

The service name

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_CertificateInstance

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

listHostedServices() : array

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayAn array of Zend_Service_WindowsAzure_Management_HostedServiceInstance

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

listLocations() : array

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_LocationInstance

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.

listOperatingSystemFamilies() : array

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_OperatingSystemFamilyInstance

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.

listOperatingSystems() : array

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.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_OperatingSystemInstance

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

listStorageAccounts() : array

Returns

arrayAn array of Zend_Service_WindowsAzure_Management_StorageServiceInstance

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

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

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

Parameters

$startTime

string

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.

$endTime

string

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.

$objectIdFilter

string

Returns subscription operations only for the specified object type and object ID.

$operationResultFilter

string

Returns subscription operations only for the specified result status, either Succeeded, Failed, or InProgress.

$continuationToken

string

Internal usage.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Management_SubscriptionOperationInstance

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

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

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$roleInstanceName

string

The role instance name

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

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

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$roleInstanceName

string

The role instance name

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

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

Parameters

$serviceName

string

The name of your service.

$key

string

The key to regenerate (primary or secondary)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

arrayAn array of strings

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

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

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$roleInstanceName

string

The role instance name

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

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

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$roleInstanceName

string

The role instance name

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Set the HTTP client channel to use

setHttpClientChannel(\Zend_Http_Client_Adapter_Interface|string $adapterInstance = 'Zend_Http_Client_Adapter_Socket'

Parameters

$adapterInstance

\Zend_Http_Client_Adapter_Interfacestring

Adapter instance or adapter class name.

Updates a deployment's role instance count.

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

Parameters

$serviceName

string

The service name

$deploymentId

$roleName

stringarray

The role name

$instanceCount

stringarray

The instance count

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Updates a deployment's role instance count.

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

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$roleName

stringarray

The role name

$instanceCount

stringarray

The instance count

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

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

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.

Parameters

$serviceName

string

The service name.

$productionDeploymentName

string

The name of the production deployment.

$sourceDeploymentName

string

The name of the source deployment.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

updateAffinityGroup(string $name, string $label, string $description = ''

Parameters

$name

string

The name for the affinity group that should be updated.

$label

string

A label for the affinity group. The label may be up to 100 characters in length.

$description

string

A description for the affinity group. The description may be up to 1024 characters in length.

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

updateDeploymentStatusByDeploymentId(string $serviceName, string $deploymentId, string $status = 'running'

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$status

string

The deployment status (running|suspended)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

updateDeploymentStatusBySlot(string $serviceName, string $deploymentSlot, string $status = 'running'

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$status

string

The deployment status (running|suspended)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

updateHostedService(string $serviceName, string $label, string $description = ''

Parameters

$serviceName

string

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

$label

string

A label for the hosted service. The label may be up to 100 characters in length.

$description

string

A description for the hosted service. The description may be up to 1024 characters in length.

The Upgrade Deployment operation initiates an upgrade.

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

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$label

string

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.

$packageUrl

string

The service configuration file for the deployment.

$configuration

string

A label for this deployment, up to 100 characters in length.

$mode

string

The type of upgrade to initiate. Possible values are Auto or Manual.

$roleToUpgrade

string

The name of the specific role to upgrade.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Upgrade Deployment operation initiates an upgrade.

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

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$label

string

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.

$packageUrl

string

The service configuration file for the deployment.

$configuration

string

A label for this deployment, up to 100 characters in length.

$mode

string

The type of upgrade to initiate. Possible values are Auto or Manual.

$roleToUpgrade

string

The name of the specific role to upgrade.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

URL encode function

urlencode(string $value) : string
Static

Parameters

$value

string

Value to encode

Returns

stringEncoded value

Wait for an operation to complete

waitForOperation(string $requestId = '', integer $sleepInterval = 250) : \Zend_Service_WindowsAzure_Management_OperationStatusInstance

Parameters

$requestId

string

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

$sleepInterval

integer

Sleep interval in milliseconds.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_OperationStatusInstance

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

walkUpgradeDomainByDeploymentId(string $serviceName, string $deploymentId, integer $upgradeDomain = 0

Parameters

$serviceName

string

The service name

$deploymentId

string

The deployment ID as listed on the Windows Azure management portal

$upgradeDomain

integer

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.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

walkUpgradeDomainBySlot(string $serviceName, string $deploymentSlot, integer $upgradeDomain = 0

Parameters

$serviceName

string

The service name

$deploymentSlot

string

The deployment slot (production or staging)

$upgradeDomain

integer

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.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Change Deployment Configuration request may be specified as follows.

_configureDeployment(string $operationUrl, string $configuration) 

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.

Parameters

$operationUrl

string

The operation url

$configuration

string

XML configuration represented as a string

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Converts an XmlElement into a Zend_Service_WindowsAzure_Management_DeploymentInstance

_convertXmlElementToDeploymentInstance(object $xmlService) : \Zend_Service_WindowsAzure_Management_DeploymentInstance

Parameters

$xmlService

object

The XML Element

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_DeploymentInstance

The Delete Deployment operation deletes the specified deployment.

_deleteDeployment(string $operationUrl) 

Parameters

$operationUrl

string

The operation url

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

_getDeployment(string $operationUrl) : \Zend_Service_WindowsAzure_Management_DeploymentInstance

Parameters

$operationUrl

string

The operation url

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Returns

\Zend_Service_WindowsAzure_Management_DeploymentInstance

Get error message from Zend_Http_Response

_getErrorMessage(\Zend_Http_Response $response, string $alternativeError = 'Unknown error.') : string

Parameters

$response

\Zend_Http_Response

Repsonse

$alternativeError

string

Alternative error message

Returns

string

Parse result from Zend_Http_Response

_parseResponse(\Zend_Http_Response $response = null) : object

Parameters

$response

\Zend_Http_Response

Response from HTTP call

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

object

Perform request using Zend_Http_Client channel

_performRequest(string $path = '/', string $queryString = '', string $httpVerb = \Zend_Http_Client::GET, array $headers = array(), mixed $rawData = null) : \Zend_Http_Response

Parameters

$path

string

Path

$queryString

string

Query string

$httpVerb

string

HTTP verb the request will use

$headers

array

x-ms headers to add

$rawData

mixed

Optional RAW HTTP data to be sent over the wire

Returns

\Zend_Http_Response

Reboots or reimages a role instance.

_rebootOrReimageRoleInstance(string $operationUrl, string $operation = 'reboot'

Parameters

$operationUrl

string

The operation url

$operation

string

The operation (reboot|reimage)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

_updateDeploymentStatus(string $operationUrl, string $status = 'running'

Parameters

$operationUrl

string

The operation url

$status

string

The deployment status (running|suspended)

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

Updates instance count in configuration XML.

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

Parameters

$roleName

stringarray

The role name

$instanceCount

stringarray

The instance count

$configuration

string

XML configuration represented as a string

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

The Upgrade Deployment operation initiates an upgrade.

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

Parameters

$operationUrl

string

The operation url

$label

string

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.

$packageUrl

string

The service configuration file for the deployment.

$configuration

string

A label for this deployment, up to 100 characters in length.

$mode

string

The type of upgrade to initiate. Possible values are Auto or Manual.

$roleToUpgrade

string

The name of the specific role to upgrade.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

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

_walkUpgradeDomain(string $operationUrl, integer $upgradeDomain = 0

Parameters

$operationUrl

string

The operation url

$upgradeDomain

integer

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.

Exceptions

\Zend_Service_WindowsAzure_Management_Exception

 Properties

 

Current API version

$_apiVersion : string

Default

'2011-02-25'
 

Management certificate passphrase

$_certificatePassphrase : string

Default

''
 

Management certificate path (.PEM)

$_certificatePath : string

Default

''
 

Zend_Http_Client channel used for communication with REST services

$_httpClientChannel : \Zend_Http_Client

Default

null
 

Returns the last request ID

$_lastRequestId : string

Default

null
 

Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance

$_retryPolicy : \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Default

null
 

Subscription ID

$_subscriptionId : string

Default

''

 Constants

 

OP_AFFINITYGROUPS

OP_AFFINITYGROUPS = "affinitygroups" 
 

OP_HOSTED_SERVICES

OP_HOSTED_SERVICES = "services/hostedservices" 
 

OP_LOCATIONS

OP_LOCATIONS = "locations" 
 

OP_OPERATINGSYSTEMFAMILIES

OP_OPERATINGSYSTEMFAMILIES = "operatingsystemfamilies" 
 

OP_OPERATINGSYSTEMS

OP_OPERATINGSYSTEMS = "operatingsystems" 
 

Operations

OP_OPERATIONS = "operations" 
 

OP_STORAGE_ACCOUNTS

OP_STORAGE_ACCOUNTS = "services/storageservices" 
 

Management service URL

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