Delen via


Check Name Availability - DigitalTwins CheckNameAvailability

Controleer of een DigitalTwinsInstance-naam beschikbaar is.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability?api-version=2023-01-31

URI-parameters

Name In Vereist Type Description
location
path True

string

Locatie van DigitalTwinsInstance.

subscriptionId
path True

string

De abonnements-id.

api-version
query True

string

Versie van de DigitalTwinsInstance Management-API.

Aanvraagbody

Name Vereist Type Description
name True

string

Resourcenaam.

type True

Type

Het type resource, bijvoorbeeld Microsoft.DigitalTwins/digitalTwinsInstances.

Antwoorden

Name Type Description
200 OK

CheckNameResult

Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerd antwoord dat aangeeft of de DigitalTwins-servicenaam beschikbaar is. Als de naam niet beschikbaar is, bevat de hoofdtekst de reden.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Check name Availability

Sample Request

POST https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/WestUS2/checkNameAvailability?api-version=2023-01-31

{
  "name": "myadtinstance",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances"
}

Sample Response

{
  "nameAvailable": false,
  "message": "Name 'myadtinstance' is already taken. Please specify a different name",
  "reason": "AlreadyExists"
}

Definities

Name Description
CheckNameRequest

Het resultaat dat wordt geretourneerd van een aanvraag voor de beschikbaarheid van een databasecontrolenaam.

CheckNameResult

Het resultaat dat is geretourneerd door een aanvraag voor beschikbaarheid van een controlenaam.

ErrorDefinition

Foutdefinitie.

ErrorResponse

Foutreactie.

reason

Bericht met de reden waarom de opgegeven naam ongeldig is.

Type

Het type resource, bijvoorbeeld Microsoft.DigitalTwins/digitalTwinsInstances.

CheckNameRequest

Het resultaat dat wordt geretourneerd van een aanvraag voor de beschikbaarheid van een databasecontrolenaam.

Name Type Description
name

string

Resourcenaam.

type

Type

Het type resource, bijvoorbeeld Microsoft.DigitalTwins/digitalTwinsInstances.

CheckNameResult

Het resultaat dat is geretourneerd door een aanvraag voor beschikbaarheid van een controlenaam.

Name Type Description
message

string

Bericht met een niet-beschikbare naam vanwege een conflict of een beschrijving van de naamgevingsregels die worden geschonden.

nameAvailable

boolean

Hiermee geeft u een Booleaanse waarde die aangeeft of de naam beschikbaar is.

reason

reason

Bericht met de reden waarom de opgegeven naam ongeldig is.

ErrorDefinition

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

details

ErrorDefinition[]

Interne foutdetails.

message

string

Beschrijving van de fout.

ErrorResponse

Foutreactie.

Name Type Description
error

ErrorDefinition

Foutbeschrijving

reason

Bericht met de reden waarom de opgegeven naam ongeldig is.

Name Type Description
AlreadyExists

string

Invalid

string

Type

Het type resource, bijvoorbeeld Microsoft.DigitalTwins/digitalTwinsInstances.

Name Type Description
Microsoft.DigitalTwins/digitalTwinsInstances

string