List Resource Extensions

 

Updated: July 10, 2015

The List Resource Extensions operation lists the resource extensions that are available to add to a Virtual Machine.

The List Resource Extensions request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/resourceextensions

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2013-11-01 or higher.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

The following example shows the format of the response body:

Copy 

<?xml version="1.0" encoding="utf-8"?>
<ResourceExtensions xmlns=”http://schemas.microsoft.com/windowsazure”>
  <ResourceExtension>
    <Publisher>name-of-publisher</Publisher>
    <Name>name-of-extension</Name>    
    <Version>version-of-extension</Version>
    <Label>label-of-extension</Label>
    <Description>description-of-extension</Description>
    <PublicConfigurationSchema>base-64-encoded-xsd-for-extension-settings</PublicConfigurationSchema>
    <PrivateConfigurationSchema>base-64-encoded-xsd-for-extension-settings</PrivateConfigurationSchema>
    <SampleConfig>base-64-encoded-sample-XML-for-extension</SampleConfig>
    <ReplicationCompleted>indicator-of-replication-status</ReplicationCompleted>
    <Eula> HYPERLINK "http://www.contoso.com/42588280809/eula%3c/Eula" eula-of-extension</Eula>
    <PrivacyUri>privacy-policy-of-extension</PrivacyUri>
    <HomepageUri>homepage-of-extension</HomepageUri>
    <IsJsonExtension>indicator-of-JSON-support</IsJsonExtension>
    <IsInternalExtension>indication-of-extension-location</IsInternalExtension>
    <DisallowMajorVersionUpgrade>indicator-of-version-upgrade</DisallowMajorVersionUpgrade>
    <CompanyName>name-of-publishing-company</CompanyName>
    <SupportedOS>supported-operating-system</SupportedOS>
    <PublishedDate>publish-date-of-extension</PublishedDate>
  </ResourceExtension>
</ResourceExtensions>

The following table describes the elements of the response body.

Element name

Description

Publisher

The publisher namespace of the extension. The publisher namespace for Azure extensions is Microsoft.WindowsAzure.Extensions.

Name

Specifies the name of the extension.

Version

Specifies the version of the extension.

Label

Specifies the label that is used to identify the extension.

Description

Specifies the description of the extension.

PublicConfigurationSchema

Specifies the base64-encoded schema of the public configuration.

PrivateConfigurationSchema

Specifies the base64-encoded schema of the private configuration.

SampleConfig

Specifies a sample configuration file for the resource extension.

ReplicationCompleted

Indicates whether the version of the extension has been replicated to all regions.

Possible values are:

  • true

  • false

true if the extension version can be used to create or update a deployment; otherwise, false indicating that the version of the extension is not ready to be used in all regions.

The ReplicationCompleted element is only available using version 2014-04-01 or higher.

Eula

Specifies a URI that points to the End User License Agreement (EULA) for the version of the extension.

The Eula element is only available using version 2014-04-01 or higher.

PrivacyUri

Specifies a URI that points to the privacy statement for the version of extension.

The PrivacyUri element is only available using version 2014-04-01 or higher.

HomepageUri

Specifies the URI that points to the homepage for the version of extension.

The HomepageUri element is only available using version 2014-04-01 or higher.

IsJsonExtension

Indicates whether the version of the extension accepts a JSON based configuration.

Possible values are:

  • true

  • false

true if the extension accepts a JSON based configuration; otherwise, false and the extension accepts an XML based configuration.

The IsJsonExtension element is only available using version 2014-04-01 or higher.

IsInternalExtension

Indicates whether the version of the extension is available for public use. This value is only listed for the publisher of the extension.

Possible values are:

  • true

  • false

The IsInternalExtension element is only available using version 2014-05-01 or higher.

DisallowMajorVersionUpgrade

Indicates whether the version of the extension supports major upgrades.

  • true

  • false

The DisallowMajorVersionUpgrade element is only available using version 2014-05-01 or higher.

CompanyName

Specifies the name of the company that published the extension.

The CompanyName element is only available using version 2014-06-01 or higher.

SupportedOS

Specifies the operating system that the extension runs on.

The SupportedOS element is only available using version 2014-06-01 or higher.

PublishedDate

Specifies the date when the extension was published.

The PublishedDate element is only available using version 2014-06-01 or higher.

Show: