Get Cloud Service

 

The Get Cloud Service operation gets all the resources (job collections) in the cloud service.

Request

The Get Cloud Service request is specified as follows. Replace <subscription-id> with your subscription ID and <cloud-service-id> with your cloud service ID.

Method

Request URI

GET

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

Request Headers

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.

Request Body

None.

Response

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

Status Code

A successful operation returns status code 200 (OK).

Response Headers

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.

Response Body

The format of the response body is as follows:

<CloudService xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Name>MYCS</Name>
<Label>MyCloudServiceInUSWest</Label>
<Description>Happy Cloud Service</Description>
<GeoRegion>ussouth</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>

Authorization

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

Sample Request and Response

The following sample URI makes a request for fictional subscription named mysub and fictional cloud service mycs:

GET https://management.core.windows.net/mysub/cloudservices/mycs

The request is sent with the following headers:

x-ms-version: 2013-06-01
Host: management.core.windows.net
Accept: application/xml
Content-Type: application/xml
Content-Length: 0

The request is sent with the following XML body:

(Empty)

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

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 1371
Content-Type: application/xml; charset=utf-8
ETag: 64ac8d6b-6020-45d4-9334-e4dc89714215
Server: 1.0.6198.18 (rd_rdfe_stable.131024-2205) Microsoft-HTTPAPI/2.0
x-ms-servedbyregion: ussouth
x-ms-request-id: a84284353935299d9bd0c03050749cab
Date: Thu, 31 Oct 2013 00:14:19 GMT

<?xml version="1.0"?>
<CloudService xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Name>MYCS</Name>
<Label>MyCloudServiceInUSWest</Label>
<Description>Happy Cloud Service</Description>
<GeoRegion>ussouth</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>

See Also

What is Scheduler?
Get Started Using Scheduler in the Management Portal
Scheduler Concepts, Terminology, and Entity Hierarchy
How to Build Complex Schedules and Advanced Recurrence with Azure Scheduler
Scheduler PowerShell Cmdlets Reference
Scheduler High-Availability and Reliability
Scheduler Outbound Authentication
Scheduler Limits, Defaults, and Error Codes
Plans and Billing in Azure Scheduler
Azure Scheduler Pricing
Azure Scheduler Videos
Register Subscription
Get Resource Provider Properties
Create Cloud Service2
Get Cloud Service (Scheduler API)
Get Cloud Services2
Delete Cloud Service2
Create Job1
Update Job1
Get Job1
Delete Job2
Check Name Availability1
Create Job Collection
Update Job Collection
Get Job Collection
Delete Job Collection
Get All Jobs
Get Job History1