Post subscriptionssubscriptionidprovidersmicrosoft.digitaltwinslocationslocationchecknameavailability — digitaltwins-microsoft-digitaltwins-digitaltwins

v7

latestSwagger 2.02026-07-13223776.2 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-versionstring 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.

messagestring nullable

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

reason'Invalid' | 'AlreadyExists' nullable

Message providing the reason why the given name is invalid.