Updated: June 29, 2015
The Add Extension asynchronous operation adds an available extension to your cloud service. In Microsoft Azure, a process can run as an extension of a cloud service. You can find the available extension by using the List Available Extensions operation.
The Add Extension request may be specified as follows. Replace <subscription-id> with your subscription ID and <cloudservice-name> with the name of the cloud service.
You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. This header should be set to 2013-03-01 or a later version. For more information about versioning headers, see Service Management Versioning.
The following example shows the format of the request body:
<?xml version="1.0" encoding="utf-8"?> <Extension xmlns=”http://schemas.microsoft.com/windowsazure”> <ProviderNameSpace>namespace-of-extension</ProviderNameSpace> <Type>type-of-extension</Type> <Id>identifier-of-extension</Id> <Thumbprint>thumbprint-of-encryption-certificate</Thumbprint> <ThumbprintAlgorithm>thumbprint-algorithm</ThumbprintAlgorithm> <PublicConfiguration>base-64-encoded-xsd-for-extension-public-configuration</PublicConfiguration> <PrivateConfiguration>base-64-encoded-xsd-for-extension-private-configuration</PrivateConfiguration> <Version>version-of-extension</Version> </Extension>
The following table describes the elements of the request body.
Required. Specifies the provider namespace of the extension. The provider namespace for Azure extensions is Microsoft.Windows.Azure.Extensions.
Required. Specifies the type of the extension.
Required. Specifies the identifier of the extension.
Optional. Specifies the thumbprint of the certificate that is used to encrypt the configuration specified in PrivateConfiguration. If this element is not specified, a certificate may be automatically generated and added to the cloud service.
Optional. Specifies the thumbprint algorithm of the certificate that is used to encrypt the configuration specified in PrivateConfiguration.
Optional. Specifies the public configuration that is defined using the schema returned by the List Available Extensions operation.
Optional. Specifies the private configuration that is defined using the schema returned by the List Available Extensions operation.
Optional. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.*), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.
The response includes an HTTP status code, a set of response headers, and a response body.
A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call Get Operation Status with the value of the header to determine whether the operation is complete, has failed, or is still in progress.