Iot Dps Resource - Check Provisioning Service Name Availability

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Überprüfen Sie, ob ein Bereitstellungsdienstname verfügbar ist. Dadurch wird überprüft, ob der Name syntaktisch gültig ist und ob der Name verwendbar ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name des zu überprüfenden Bereitstellungsdiensts.

Antworten

Name	Typ	Beschreibung
200 OK	NameAvailabilityInfo	Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte Antwort, die angibt, ob der Name des Bereitstellungsdiensts verfügbar ist. Wenn der Name nicht verfügbar ist, enthält der Text den Grund.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

DPSCheckName

Sample Request

HTTP

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

{
  "name": "test213123"
}

Sample Response

Status code:: 200

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

Definitionen

Name	Beschreibung
ErrorDetails	Fehlerdetails.
NameAvailabilityInfo	Beschreibung der Namensverfügbarkeit.
NameUnavailabilityReason	Gibt den Grund an, warum ein Name nicht verfügbar ist.
OperationInputs	Eingabewerte für den Aufruf von Vorgangsergebnissen.

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	integer	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

NameAvailabilityInfo

Beschreibung der Namensverfügbarkeit.

Name	Typ	Beschreibung
message	string	Meldung, die einen detaillierten Grundnamen enthält, ist nicht verfügbar
nameAvailable	boolean	gibt an, ob ein Name verfügbar ist oder nicht.
reason	NameUnavailabilityReason	Gibt den Grund an, warum ein Name nicht verfügbar ist.

NameUnavailabilityReason

Gibt den Grund an, warum ein Name nicht verfügbar ist.

Name	Typ	Beschreibung
AlreadyExists	string
Invalid	string

OperationInputs

Eingabewerte für den Aufruf von Vorgangsergebnissen.

Name	Typ	Beschreibung
name	string	Der Name des zu überprüfenden Bereitstellungsdiensts.

Freigeben über