Get Cloud Services

 

Updated: May 7, 2015

The Get All Cloud Services operation gets all the cloud services in a subscription. This helps you determine if you have already created a cloud service or if you need to create a new one. This is also needed if you want to enumerate your resources.

The Get All Cloud Services request is specified as follows. Replace <subscription-id> with your subscription ID

Method

Request URI

GET

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

The following table describes required and optional 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-06-01 or a later version.

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. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header

Description

x-ms-request-id

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. See Tracking Asynchronous Service Management Requests for more information.

The format of the response body is as follows:



<CloudServices xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CloudService>
    <Name>cswestus</Name>
    <Label>MyCloudServiceInWestUS</Label>
    <Description>Happy Cloud Service</Description>
    <GeoRegion>West US</GeoRegion>
    <Resources/>
</CloudService>
<CloudService>
    <Name>MYCS2</Name>
    <Label>MyCloudServiceInUSWest</Label>
    <Description>Happier Cloud Service</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>jc1</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>f4e5ec22-2de3-4746-84fb-bde500112493</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Create</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
    </Resources>
</CloudService>
<CloudService>
    <Name>MYCS</Name>
    <Label>MyCloudServiceInUSWest</Label>
    <Description>Happy Cloud Service</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC1</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>e1142d49-9efe-4388-bd2b-c68e1cc8c35a</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Update</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC2</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>93cc9425-18d1-486f-858d-fd135b174765</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Create</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC200</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>d722876e-08f0-4861-8c74-2f5d76a40aa8</ETag>
            <State>Started</State>
            <IntrinsicSettings>
                <Quota>
                    <MaxJobCount>12</MaxJobCount>
                </Quota>
            </IntrinsicSettings>
            <OperationStatus>
                <Type>Update</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
    </Resources>
</CloudService>
<CloudService>
    <Name>MYCSAPP</Name>
    <Label>MyApp</Label>
    <Description>My Cloud Service for app</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources/>
</CloudService>
</CloudServices>


Any management certificate associated with the subscription specified by <Subscription-Id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests

The following sample URI makes a request for fictional subscription named mysub and fictional cloud service mycs and gets completed jobs in the fictional job collection myjc:


GET https://management.core.windows.net/<subscription-id>/cloudservices




The request is sent with the following headers:


x-ms-version: 2013-06-01
Host: management.core.windows.net

The request is sent with the following XML body:

(Empty)

After the request has been sent, the following response is returned:



<CloudServices xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CloudService>
    <Name>cswestus</Name>
    <Label>MyCloudServiceInWestUS</Label>
    <Description>Happy Cloud Service</Description>
    <GeoRegion>West US</GeoRegion>
    <Resources/>
</CloudService>
<CloudService>
    <Name>MYCS2</Name>
    <Label>MyCloudServiceInUSWest</Label>
    <Description>Happier Cloud Service</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>jc1</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>f4e5ec22-2de3-4746-84fb-bde500112493</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Create</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
    </Resources>
</CloudService>
<CloudService>
    <Name>MYCS</Name>
    <Label>MyCloudServiceInUSWest</Label>
    <Description>Happy Cloud Service</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC1</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>e1142d49-9efe-4388-bd2b-c68e1cc8c35a</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Update</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC2</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>93cc9425-18d1-486f-858d-fd135b174765</ETag>
            <State>Started</State>
            <IntrinsicSettings/>
            <OperationStatus>
                <Type>Create</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
        <Resource>
            <ResourceProviderNamespace>scheduler</ResourceProviderNamespace>
            <Type>jobcollections</Type>
            <Name>JC200</Name>
            <SchemaVersion>1.1</SchemaVersion>
            <ETag>d722876e-08f0-4861-8c74-2f5d76a40aa8</ETag>
            <State>Started</State>
            <IntrinsicSettings>
                <Quota>
                    <MaxJobCount>12</MaxJobCount>
                </Quota>
            </IntrinsicSettings>
            <OperationStatus>
                <Type>Update</Type>
                <Result>Succeeded</Result>
            </OperationStatus>
            <Label/>
        </Resource>
    </Resources>
</CloudService>
<CloudService>
    <Name>MYCSAPP</Name>
    <Label>MyApp</Label>
    <Description>My Cloud Service for app</Description>
    <GeoRegion>uswest</GeoRegion>
    <Resources/>
</CloudService>
</CloudServices>


Show: