SALES: 1-800-867-1380

Create Job Collection (Scheduler API)

Updated: May 7, 2015

The Create Job Collection request creates a new job collection.

The Create 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 you’d like to create. There are no “default” pre-existing job collections; every job collection must be manually created.

 

Method Request URI

PUT

https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-id>/resources/scheduler/jobCollections/<job-collection-id>

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 format of the request body is as follows. The InstrincSettings element is optional, but allows you to specify quotas and settings at the job collection level, as shown below. Plan may be Free or Standard. MaxJobCount and MaxRecurrence control the maximum job count in the collection and the maximum recurrence of the collection respectively.


<Resource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
<IntrinsicSettings>
    <Plan>Standard</Plan>
    <Quota>
        <MaxJobCount>10</MaxJobCount>
        <MaxRecurrence>
            <Frequency>Second</Frequency>
            <Interval>1</Interval>
        </MaxRecurrence>
    </Quota>
</IntrinsicSettings>
</Resource>

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

A successful operation returns status code 202 (Accepted).

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.

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:


PUT https://management.core.windows.net/mysub /cloudServices/mycs/resources/scheduler/jobCollections/JC1 

The request is sent with the following headers:


x-ms-version: 2013-06-01
Host: management.core.windows.net
Content-Type: application/xml; charset=utf-8
Accept: application/xml
Content-Length: 123

The request is sent with the following XML body:


<Resource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure"></Resource>

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


HTTP/1.1 202 Accepted
Cache-Control: no-cache
Content-Length: 0
ETag: 09fc72f3-4d1b-4a28-a4bd-ed1edf8845fa
Server: 1.0.6198.18 (rd_rdfe_stable.131024-2205) Microsoft-HTTPAPI/2.0
x-ms-servedbyregion: ussouth
x-ms-request-id: 7c448bbc2aab2191b356e570ccf8d2d6
Date: Wed, 30 Oct 2013 02:05:47 GMT

See Also

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