Iot Dps Resource - Check Provisioning Service Name Availability

Referentie

Service:: IoT Hub Device Provisioning Service

API-versie:: 2022-12-12

Controleer of de naam van een inrichtingsservice beschikbaar is. Hiermee wordt gecontroleerd of de naam syntactisch geldig is en of de naam bruikbaar is

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van de inrichtingsservice die moet worden gecontroleerd.

Antwoorden

Name	Type	Description
200 OK	NameAvailabilityInfo	Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerd antwoord dat aangeeft of de naam van de inrichtingsservice beschikbaar is. Als de naam niet beschikbaar is, bevat de hoofdtekst de reden.
Other Status Codes	ErrorDetails	Standaardfoutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

DPSCheckName

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

{
  "name": "test213123"
}

Voorbeeldrespons

Statuscode:: 200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": "name is valid"
}

Definities

Name	Description
ErrorDetails	Foutdetails.
NameAvailabilityInfo	Beschrijving van de beschikbaarheid van namen.
NameUnavailabilityReason	geeft aan waarom een naam niet beschikbaar is
OperationInputs	Invoerwaarden voor aanroep van bewerkingsresultaten.

ErrorDetails

Foutdetails.

Name	Type	Description
code	integer	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

NameAvailabilityInfo

Beschrijving van de beschikbaarheid van namen.

Name	Type	Description
message	string	bericht met een gedetailleerde reden waarom de naam niet beschikbaar is
nameAvailable	boolean	geeft aan of een naam beschikbaar is of niet
reason	NameUnavailabilityReason	geeft aan waarom een naam niet beschikbaar is

NameUnavailabilityReason

geeft aan waarom een naam niet beschikbaar is

Name	Type	Description
AlreadyExists	string
Invalid	string

OperationInputs

Invoerwaarden voor aanroep van bewerkingsresultaten.

Name	Type	Description
name	string	De naam van de inrichtingsservice die moet worden gecontroleerd.

Delen via