---
title: "POST /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability"
method: POST
path: "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability"
tags: ["CheckNameAvailability"]
---

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

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

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Check if a DigitalTwinsInstance name is available.

## Path parameters

- `subscriptionId` string, required
- `location` string, required

## Query parameters

- `api-version` string, required

## Request body

- CheckNameRequest: The result returned from a database check name availability request.
  - `name` string, required: Resource name.
  - `type` 'Microsoft.DigitalTwins/digitalTwinsInstances', required: The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances.

## Response `200`

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.

- CheckNameResult: The result returned from a check name availability request.
  - `nameAvailable` boolean: Specifies a Boolean value that indicates if the name is available.
  - `message` string, 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.

## Other responses

- `default`: Error response describing why the operation failed.

---

[API](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins.md) - [All operations](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins/revisions/0244c7a17143?raw)
