SALES: 1-800-867-1380

Get Job Collection (Scheduler API)

Updated: April 30, 2014

The Get Job Collection operation gets the details of a job collection

The Get Job Collection request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-id> with your cloud service ID, and <job-collection-id> with the ID of the job collection.

 

Method Request URI

GET

https://management.core.windows.net/<subscription-id>/cloudservices/<cloud-service-id>/resources/scheduler/~/jobCollections/<job-collection-id>?api-version=2014-04-01

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 2012-03-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:




<Resource xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CloudServiceSettings><GeoRegion>uswest</GeoRegion></CloudServiceSettings>
<ETag>081b6f87-a5ca-43e9-9d66-f02889264486</ETag>
<IntrinsicSettings/>
<Name>JC101</Name>
<OperationStatus>
<Error><HttpCode>200</HttpCode><Message>OK</Message></Error><Result>Succeeded</Result>
</OperationStatus>



Below are key elements of this response body

 

Response Header Description

GeoRegion

Specifies the location of the data center where the resource is hosted.

ETag

Specifies the ETag associated with the resource.

Name

The name of the resource

OperationStatus

Specifies the result of the operation. The possible values can be InProgress, Succeeded, or Failed.

Error/HttpCode

Specifies the HTTP response code.

Error/Message

Specifies the error or success message.

Error/ExtendedCode

Specifies the extended error code.

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:


GET https://management.core.windows.net/mysub/cloudservices/mycs/resources/scheduler/~/jobCollections/myjc?api-version=2014-04-01

The request is sent with the following headers:


x-ms-version: 2013-03-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:


HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 517
Content-Type: application/xml; charset=utf-8
Expires: -1
Server: 1.0.6198.12 (rd_rdfe_stable.131001-0757) Microsoft-HTTPAPI/2.0
x-ms-servedbyregion: ussouth
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
x-ms-request-id: 7ed210a570df2a3b901b70c5cac72f9c
Date: Sat, 26 Oct 2013 23:11:19 GMT
 
<Resource xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><CloudServiceSettings><GeoRegion>uswest</GeoRegion></CloudServiceSettings><ETag>f4e5ec22-2de3-4746-84fb-bde500112493</ETag><IntrinsicSettings/><Name>myjc</Name><OperationStatus><Error><HttpCode>200</HttpCode><Message>OK</Message></Error><Result>Succeeded</Result></OperationStatus><PromotionCode></PromotionCode><SchemaVersion>1.1</SchemaVersion><State>Started</State><Type>jobcollections</Type></Resource>



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft