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 |
__construct(string $subscriptionId, string $certificatePath, string $certificatePassphrase, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
)
string
Subscription ID
string
Management certificate path (.PEM)
string
Management certificate passphrase
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
_cleanConfiguration(string $configuration) : string
string
Configuration to clean.
string
addCertificate(string $serviceName, string $certificateData, string $certificatePassword, string $certificateFormat = 'pfx'
)
string
The service name
string
Certificate data
string
The certificate password
string
The certificate format. Currently, only 'pfx' is supported.
\Zend_Service_WindowsAzure_Management_Exception |
---|
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.
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
string
XML configuration represented as a string
\Zend_Service_WindowsAzure_Management_Exception |
---|
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.
string
The service name
string
The deployment slot (production or staging)
string
XML configuration represented as a string
\Zend_Service_WindowsAzure_Management_Exception |
---|
createAffinityGroup(string $name, string $label, string $description= ''
, string $location= ''
)
string
A name for the affinity group that is unique to the subscription.
string
A label for the affinity group. The label may be up to 100 characters in length.
string
A description for the affinity group. The description may be up to 1024 characters in length.
string
The location where the affinity group will be created. To list available locations, use the List Locations operation.
createBlobClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
) : \Zend_Service_WindowsAzure_Storage_Blob
string
the service name to create a storage client for.
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
\Zend_Service_WindowsAzure_Storage_Blob
createDeployment(string $serviceName, string $deploymentSlot, string $name, string $label, string $packageUrl, string $configuration, boolean $startDeployment= false
, boolean $treatWarningsAsErrors= false
)
string
The service name
string
The deployment slot (production or staging)
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.
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.
string
The service configuration file for the deployment.
string
A label for this deployment, up to 100 characters in length.
boolean
Indicates whether to start the deployment immediately after it is created.
boolean
Indicates whether to treat package validation warnings as errors.
\Zend_Service_WindowsAzure_Management_Exception |
---|
createHostedService(string $serviceName, string $label, string $description= ''
, string $location= null
, string $affinityGroup= null
)
string
A name for the hosted service that is unique to the subscription.
string
A label for the hosted service. The label may be up to 100 characters in length.
string
A description for the hosted service. The description may be up to 1024 characters in length.
string
Required if AffinityGroup is not specified. The location where the hosted service will be created.
string
Required if Location is not specified. The name of an existing affinity group associated with this subscription.
createQueryStringFromArray($queryString) : string
string
Assembled query stringcreateQueueClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
) : \Zend_Service_WindowsAzure_Storage_Queue
string
the service name to create a storage client for.
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
\Zend_Service_WindowsAzure_Storage_Queue
createTableClientForService(string $serviceName, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
) : \Zend_Service_WindowsAzure_Storage_Table
string
the service name to create a storage client for.
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
\Zend_Service_WindowsAzure_Storage_Table
deleteAffinityGroup(string $name)
string
The name for the affinity group that should be deleted.
deleteCertificate($serviceName, string $algorithm= ''
, string $thumbprint= ''
)
string
Algorithm
string
Thumbprint
\Zend_Service_WindowsAzure_Management_Exception |
---|
deleteDeploymentByDeploymentId(string $serviceName, string $deploymentId)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
\Zend_Service_WindowsAzure_Management_Exception |
---|
deleteDeploymentBySlot(string $serviceName, string $deploymentSlot)
string
The service name
string
The deployment slot (production or staging)
\Zend_Service_WindowsAzure_Management_Exception |
---|
deleteHostedService(string $serviceName)
string
A name for the hosted service that is unique to the subscription.
getAffinityGroupProperties(string $affinityGroupName) : \Zend_Service_WindowsAzure_Management_AffinityGroupInstance
string
The affinity group name.
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_AffinityGroupInstance
getBaseUrl() : string
string
getCertificate($serviceName, string $algorithm= ''
, string $thumbprint= ''
) : \Zend_Service_WindowsAzure_Management_CertificateInstance
string
Algorithm
string
Thumbprint
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_CertificateInstance
getDeploymentByDeploymentId(string $serviceName, string $deploymentId) : \Zend_Service_WindowsAzure_Management_DeploymentInstance
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_DeploymentInstance
getDeploymentBySlot(string $serviceName, string $deploymentSlot) : \Zend_Service_WindowsAzure_Management_DeploymentInstance
string
The service name
string
The deployment slot (production or staging)
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_DeploymentInstance
getHostedServiceProperties(string $serviceName) : \Zend_Service_WindowsAzure_Management_HostedServiceInstance
string
The name of your service.
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_HostedServiceInstance
getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
\Zend_Http_Client_Adapter_Interface
getLastRequestId() : string
string
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.
string
The request ID. If omitted, the last request ID will be used.
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_OperationStatusInstance
getStorageAccountKeys(string $serviceName) : array
string
The name of your service.
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
An array of stringsgetStorageAccountProperties(string $serviceName) : \Zend_Service_WindowsAzure_Management_StorageServiceInstance
string
The name of your service.
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_StorageServiceInstance
getSubscriptionId() : string
string
listAffinityGroups() : array
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
Array of Zend_Service_WindowsAzure_Management_AffinityGroupInstancelistCertificates(string $serviceName) : array
string
The service name
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
Array of Zend_Service_WindowsAzure_Management_CertificateInstancelistHostedServices() : array
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
An array of Zend_Service_WindowsAzure_Management_HostedServiceInstancelistLocations() : array
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
Array of Zend_Service_WindowsAzure_Management_LocationInstancelistStorageAccounts() : array
array
An array of Zend_Service_WindowsAzure_Management_StorageServiceInstancelistSubscriptionOperations(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.
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.
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.
string
Returns subscription operations only for the specified object type and object ID.
string
Returns subscription operations only for the specified result status, either Succeeded, Failed, or InProgress.
string
Internal usage.
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
Array of Zend_Service_WindowsAzure_Management_SubscriptionOperationInstancerebootRoleInstanceByDeploymentId(string $serviceName, string $deploymentId, string $roleInstanceName)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
string
The role instance name
\Zend_Service_WindowsAzure_Management_Exception |
---|
rebootRoleInstanceBySlot(string $serviceName, string $deploymentSlot, string $roleInstanceName)
string
The service name
string
The deployment slot (production or staging)
string
The role instance name
\Zend_Service_WindowsAzure_Management_Exception |
---|
regenerateStorageAccountKey(string $serviceName, string $key = 'primary'
) : array
string
The name of your service.
string
The key to regenerate (primary or secondary)
\Zend_Service_WindowsAzure_Management_Exception |
---|
array
An array of stringsreimageRoleInstanceByDeploymentId(string $serviceName, string $deploymentId, string $roleInstanceName)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
string
The role instance name
\Zend_Service_WindowsAzure_Management_Exception |
---|
reimageRoleInstanceBySlot(string $serviceName, string $deploymentSlot, string $roleInstanceName)
string
The service name
string
The deployment slot (production or staging)
string
The role instance name
\Zend_Service_WindowsAzure_Management_Exception |
---|
setHttpClientChannel(\Zend_Http_Client_Adapter_Interface|string $adapterInstance = 'Zend_Http_Client_Adapter_Socket'
)
\Zend_Http_Client_Adapter_Interface
string
Adapter instance or adapter class name.
setInstanceCountByDeploymentId(string $serviceName, $deploymentId, string|array $roleName, string|array $instanceCount)
string
The service name
string
array
The role name
string
array
The instance count
\Zend_Service_WindowsAzure_Management_Exception |
---|
setInstanceCountBySlot(string $serviceName, string $deploymentSlot, string|array $roleName, string|array $instanceCount)
string
The service name
string
The deployment slot (production or staging)
string
array
The role name
string
array
The instance count
\Zend_Service_WindowsAzure_Management_Exception |
---|
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.
string
The service name.
string
The name of the production deployment.
string
The name of the source deployment.
\Zend_Service_WindowsAzure_Management_Exception |
---|
updateAffinityGroup(string $name, string $label, string $description = ''
)
string
The name for the affinity group that should be updated.
string
A label for the affinity group. The label may be up to 100 characters in length.
string
A description for the affinity group. The description may be up to 1024 characters in length.
updateDeploymentStatusByDeploymentId(string $serviceName, string $deploymentId, string $status = 'running'
)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
string
The deployment status (running|suspended)
\Zend_Service_WindowsAzure_Management_Exception |
---|
updateDeploymentStatusBySlot(string $serviceName, string $deploymentSlot, string $status = 'running'
)
string
The service name
string
The deployment slot (production or staging)
string
The deployment status (running|suspended)
\Zend_Service_WindowsAzure_Management_Exception |
---|
updateHostedService(string $serviceName, string $label, string $description = ''
)
string
A name for the hosted service that is unique to the subscription.
string
A label for the hosted service. The label may be up to 100 characters in length.
string
A description for the hosted service. The description may be up to 1024 characters in length.
upgradeDeploymentByDeploymentId(string $serviceName, string $deploymentId, string $label, string $packageUrl, string $configuration, string $mode= 'auto'
, string $roleToUpgrade= null
)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
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.
string
The service configuration file for the deployment.
string
A label for this deployment, up to 100 characters in length.
string
The type of upgrade to initiate. Possible values are Auto or Manual.
string
The name of the specific role to upgrade.
\Zend_Service_WindowsAzure_Management_Exception |
---|
upgradeDeploymentBySlot(string $serviceName, string $deploymentSlot, string $label, string $packageUrl, string $configuration, string $mode= 'auto'
, string $roleToUpgrade= null
)
string
The service name
string
The deployment slot (production or staging)
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.
string
The service configuration file for the deployment.
string
A label for this deployment, up to 100 characters in length.
string
The type of upgrade to initiate. Possible values are Auto or Manual.
string
The name of the specific role to upgrade.
\Zend_Service_WindowsAzure_Management_Exception |
---|
urlencode(string $value) : string
string
Value to encode
string
Encoded valuewaitForOperation(string $requestId= ''
, integer $sleepInterval= 250
) : \Zend_Service_WindowsAzure_Management_OperationStatusInstance
string
The request ID. If omitted, the last request ID will be used.
integer
Sleep interval in milliseconds.
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_OperationStatusInstance
walkUpgradeDomainByDeploymentId(string $serviceName, string $deploymentId, integer $upgradeDomain = 0
)
string
The service name
string
The deployment ID as listed on the Windows Azure management portal
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.
\Zend_Service_WindowsAzure_Management_Exception |
---|
walkUpgradeDomainBySlot(string $serviceName, string $deploymentSlot, integer $upgradeDomain = 0
)
string
The service name
string
The deployment slot (production or staging)
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.
\Zend_Service_WindowsAzure_Management_Exception |
---|
_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.
string
The operation url
string
XML configuration represented as a string
\Zend_Service_WindowsAzure_Management_Exception |
---|
_convertXmlElementToDeploymentInstance(object $xmlService) : \Zend_Service_WindowsAzure_Management_DeploymentInstance
object
The XML Element
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_DeploymentInstance
_deleteDeployment(string $operationUrl)
string
The operation url
\Zend_Service_WindowsAzure_Management_Exception |
---|
_getDeployment(string $operationUrl) : \Zend_Service_WindowsAzure_Management_DeploymentInstance
string
The operation url
\Zend_Service_WindowsAzure_Management_Exception |
---|
\Zend_Service_WindowsAzure_Management_DeploymentInstance
_getErrorMessage(\Zend_Http_Response $response, string $alternativeError = 'Unknown error.'
) : string
\Zend_Http_Response
Repsonse
string
Alternative error message
string
_parseResponse(\Zend_Http_Response $response = null
) : object
\Zend_Http_Response
Response from HTTP call
\Zend_Service_WindowsAzure_Exception |
---|
object
_performRequest(string $path= '/'
, string $queryString= ''
, string $httpVerb= \Zend_Http_Client::GET
, array $headers= array()
, mixed $rawData= null
) : \Zend_Http_Response
string
Path
string
Query string
string
HTTP verb the request will use
array
x-ms headers to add
mixed
Optional RAW HTTP data to be sent over the wire
\Zend_Http_Response
_rebootOrReimageRoleInstance(string $operationUrl, string $operation = 'reboot'
)
string
The operation url
string
The operation (reboot|reimage)
\Zend_Service_WindowsAzure_Management_Exception |
---|
_updateDeploymentStatus(string $operationUrl, string $status = 'running'
)
string
The operation url
string
The deployment status (running|suspended)
\Zend_Service_WindowsAzure_Management_Exception |
---|
_updateInstanceCountInConfiguration(string|array $roleName, string|array $instanceCount, string $configuration)
string
array
The role name
string
array
The instance count
string
XML configuration represented as a string
\Zend_Service_WindowsAzure_Management_Exception |
---|
_upgradeDeployment(string $operationUrl, string $label, string $packageUrl, string $configuration, string $mode, string $roleToUpgrade)
string
The operation url
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.
string
The service configuration file for the deployment.
string
A label for this deployment, up to 100 characters in length.
string
The type of upgrade to initiate. Possible values are Auto or Manual.
string
The name of the specific role to upgrade.
\Zend_Service_WindowsAzure_Management_Exception |
---|
_walkUpgradeDomain(string $operationUrl, integer $upgradeDomain = 0
)
string
The operation url
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.
\Zend_Service_WindowsAzure_Management_Exception |
---|
$_apiVersion : string
'2011-02-25'
$_certificatePassphrase : string
''
$_certificatePath : string
''
$_httpClientChannel : \Zend_Http_Client
null
$_lastRequestId : string
null
$_retryPolicy : \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
null
$_subscriptionId : string
''
OP_AFFINITYGROUPS = "affinitygroups"
OP_HOSTED_SERVICES = "services/hostedservices"
OP_LOCATIONS = "locations"
OP_OPERATINGSYSTEMFAMILIES = "operatingsystemfamilies"
OP_OPERATINGSYSTEMS = "operatingsystems"
OP_OPERATIONS = "operations"
OP_STORAGE_ACCOUNTS = "services/storageservices"
URL_MANAGEMENT = "https://management.core.windows.net"