Class: Microsoft_WindowsAzure_Management_Client
Source Location: /WindowsAzure/Management/Client.php
Author(s):
Copyright:
- Copyright (c) 2009 - 2010, RealDolmen (http://www.realdolmen.com)
|
|
|
|
Class Details
Class Variables
Class Methods
static method createQueryStringFromArray [line 317]
static string createQueryStringFromArray(
array
$queryString)
|
|
Builds a query string from an array of elements
Tags:
Parameters:
static method urlencode [line 306]
static string urlencode(
string
$value)
|
|
URL encode function
Tags:
Parameters:
constructor __construct [line 123]
Creates a new Microsoft_WindowsAzure_Management instance
Tags:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
method createBlobClientForService [line 495]
Creates a new Microsoft_WindowsAzure_Storage_Blob instance for the current account
Tags:
Parameters:
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:
Parameters:
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:
Parameters:
method createQueueClientForService [line 543]
Creates a new Microsoft_WindowsAzure_Storage_Queue instance for the current account
Tags:
Parameters:
method createTableClientForService [line 519]
Creates a new Microsoft_WindowsAzure_Storage_Table instance for the current account
Tags:
Parameters:
method deleteAffinityGroup [line 1992]
void deleteAffinityGroup(
string
$name)
|
|
The Delete Affinity Group operation deletes an affinity group in the specified subscription.
Tags:
Parameters:
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:
Parameters:
method deleteDeploymentByDeploymentId [line 1073]
void deleteDeploymentByDeploymentId(
string
$serviceName, string
$deploymentId)
|
|
The Delete Deployment operation deletes the specified deployment.
Tags:
Parameters:
method deleteDeploymentBySlot [line 1052]
void deleteDeploymentBySlot(
string
$serviceName, string
$deploymentSlot)
|
|
The Delete Deployment operation deletes the specified deployment.
Tags:
Parameters:
method deleteHostedService [line 821]
void deleteHostedService(
string
$serviceName)
|
|
The Delete Hosted Service operation deletes the specified hosted service in Windows Azure.
Tags:
Parameters:
method getAffinityGroupProperties [line 2014]
The Get Affinity Group Properties operation returns the system properties associated with the specified affinity group.
Tags:
Parameters:
method getBaseUrl [line 201]
Get base URL for creating requests
Tags:
method getCertificate [line 1781]
The Get Certificate operation returns the public data for the specified certificate.
Tags:
Parameters:
method getDeploymentByDeploymentId [line 976]
The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.
Tags:
Parameters:
method getDeploymentBySlot [line 953]
The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.
Tags:
Parameters:
method getHostedServiceProperties [line 845]
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:
Parameters:
method getHttpClientChannel [line 171]
Retrieve HTTP client channel
Tags:
method getLastRequestId [line 191]
string getLastRequestId(
)
|
|
Returns the last request ID.
Tags:
method getOperationStatus [line 348]
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:
Parameters:
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:
Parameters:
method getStorageAccountProperties [line 607]
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:
Parameters:
method getSubscriptionId [line 181]
string getSubscriptionId(
)
|
|
Returns the Windows Azure subscription ID
Tags:
method listAffinityGroups [line 1886]
array listAffinityGroups(
)
|
|
The List Affinity Groups operation lists the affinity groups associated with the specified subscription.
Tags:
method listCertificates [line 1734]
array listCertificates(
string
$serviceName)
|
|
The List Certificates operation lists all certificates associated with the specified hosted service.
Tags:
Parameters:
method listHostedServices [line 715]
array listHostedServices(
)
|
|
The List Hosted Services operation lists the hosted services available under the current subscription.
Tags:
method listLocations [line 2081]
The List Locations operation lists all of the data center locations that are valid for your subscription.
Tags:
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:
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:
method listStorageAccounts [line 566]
array listStorageAccounts(
)
|
|
The List Storage Accounts operation lists the storage accounts available under the current subscription.
Tags:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
method setHttpClientChannel [line 161]
Set the HTTP client channel to use
Tags:
Parameters:
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:
Parameters:
method setInstanceCountBySlot [line 1250]
void setInstanceCountBySlot(
string
$serviceName, string
$deploymentSlot, string|array
$roleName, string|array
$instanceCount)
|
|
Updates a deployment's role instance count.
Tags:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
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:
Parameters:
method waitForOperation [line 470]
Wait for an operation to complete
Tags:
Parameters:
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:
Parameters:
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:
Parameters:
method _cleanConfiguration [line 2228]
string _cleanConfiguration(
string
$configuration)
|
|
Clean configuration
Tags:
Parameters:
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:
Parameters:
method _convertXmlElementToDeploymentInstance [line 1178]
Converts an XmlElement into a Microsoft_WindowsAzure_Management_DeploymentInstance
Tags:
Parameters:
method _deleteDeployment [line 1092]
void _deleteDeployment(
string
$operationUrl)
|
|
The Delete Deployment operation deletes the specified deployment.
Tags:
Parameters:
method _getDeployment [line 997]
The Get Deployment operation returns configuration information, status, and system properties for the specified deployment.
Tags:
Parameters:
method _getErrorMessage [line 329]
string _getErrorMessage(
$response, [string
$alternativeError = 'Unknown error.'])
|
|
Get error message from Microsoft_Http_Response
Tags:
Parameters:
method _parseResponse [line 277]
object _parseResponse(
[
$response = null])
|
|
Parse result from Microsoft_Http_Response
Tags:
Parameters:
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:
Parameters:
method _rebootOrReimageRoleInstance [line 1717]
void _rebootOrReimageRoleInstance(
string
$operationUrl, [string
$operation = 'reboot'])
|
|
Reboots or reimages a role instance.
Tags:
Parameters:
method _updateDeploymentStatus [line 1159]
void _updateDeploymentStatus(
string
$operationUrl, [string
$status = 'running'])
|
|
The Update Deployment Status operation initiates a change in deployment status.
Tags:
Parameters:
method _updateInstanceCountInConfiguration [line 1309]
void _updateInstanceCountInConfiguration(
string|array
$roleName, string|array
$instanceCount, string
$configuration)
|
|
Updates instance count in configuration XML.
Tags:
Parameters:
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:
Parameters:
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:
Parameters:
Class Constants
|
|