Post subscriptionssubscriptionidprovidersmicrosoft.digitaltwinslocationslocationchecknameavailability — azuredigitaltwinsmanagementclient

v5

latestSwagger 2.0raw.githubusercontent.com2020-06-04122035.3 KB

CheckNameAvailability

Check if a DigitalTwinsInstance name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability

Path parameters

subscriptionIdstring required

The subscription identifier.

locationstring required

Location of DigitalTwinsInstance.

Query parameters

api-version'2020-03-01-preview' required

Version of the DigitalTwinsInstance Management API.

Request body

namestring required

Resource name.

type'Microsoft.DigitalTwins/digitalTwinsInstances' required

The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances.

Response

This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the DigitalTwins service name is available. If the name is not available, the body contains the reason.

nameAvailableboolean

Specifies a Boolean value that indicates if the name is available.

namestring

The name that was checked.

messagestring

Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.

reason'Invalid' | 'AlreadyExists'

Message providing the reason why the given name is invalid.