Check Name Availability (Scheduler API)
Updated: January 13, 2015
The Check Name Availability operation checks if a new job collection with the given name may be created, or if it is unavailable. The result of the operation is a Boolean ‘true’ or ‘false.’
The Check Name Availability 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 whose availability you would like to check.
Required. Set to value “checknameavailability” for this operation
Required. Set to the name of the job collection whose availability you’d like to check
The following table describes required and optional request headers.
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.
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:
<?xml version="1.0"?> <ResourceNameAvailabilityResponse xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <IsAvailable>false</IsAvailable> </ResourceNameAvailabilityResponse>
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
GET https://management.core.windows.net/mysub/cloudservices/mycs/resources/scheduler/jobCollections/?op=checknameavailability&resourceName=JC1 HTTP/1.1
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; charset=utf-8
The request is sent with the following XML body:
After the request has been sent, the following response is returned:
HTTP/1.1 200 OK Cache-Control: no-cache Content-Length: 203 Content-Type: application/xml; charset=utf-8 Server: 1.0.6198.12 (rd_rdfe_stable.131001-0757) Microsoft-HTTPAPI/2.0 x-ms-servedbyregion: ussouth x-ms-request-id: dc15a602d28b203ab4b748251ffca86f Date: Sat, 26 Oct 2013 06:46:46 GMT <?xml version="1.0"?> <ResourceNameAvailabilityResponse xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <IsAvailable>false</IsAvailable> </ResourceNameAvailabilityResponse>
ConceptsScheduler Concepts, Terminology, and Entity Hierarchy
Get Started Using Scheduler in the Management Portal
Scheduler REST API Reference
Scheduler Outbound Authentication
Scheduler High-Availability and Reliability
Scheduler Limits, Defaults, and Error Codes
Register Subscription (Scheduler API)
Get Resource Provider Properties (Scheduler API)
Create Cloud Service (Scheduler API)
Get Cloud Service (Scheduler API)
Get Cloud Services (Scheduler API)
Delete Cloud Service (Scheduler API)
Create Job (Scheduler API)
Update Job (Scheduler API)
Get Job (Scheduler API)
Delete Job (Scheduler API)
Create Job Collection (Scheduler API)
Update Job Collection (Scheduler API)
Get Job Collection (Scheduler API)
Delete Job Collection (Scheduler API)
Get All Jobs (Scheduler API)
Get Job History (Scheduler API)