Iot Dps Resource - Check Provisioning Service Name Availability

Service:

IoT Hub Device Provisioning Service

API Version:

2018-01-22

Kontrollera om det finns ett tillgängligt namn på etableringstjänsten. Detta verifierar om namnet är syntaktiskt giltigt och om namnet kan användas

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	Namnet på etableringstjänsten som ska kontrolleras.

Svar

Name	Typ	Description
200 OK	NameAvailabilityInfo	Det här är en synkron åtgärd. Brödtexten innehåller ett JSON-serialiserat svar som anger om etableringstjänstens namn är tillgängligt. Om namnet inte är tillgängligt innehåller brödtexten orsaken.
Other Status Codes	ErrorDetails	Standardfelsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

DPSCheckName

Sample Request

HTTP

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

{
  "name": "test213123"
}

Sample Response

Status code:

200

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

Definitioner

Name	Description
ErrorDetails	Felinformation.
NameAvailabilityInfo	Beskrivning av namntillgänglighet.
NameUnavailabilityReason	anger orsaken till att ett namn inte är tillgängligt
OperationInputs	Indatavärden för åtgärdsresultatanrop.

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

NameAvailabilityInfo

Beskrivning av namntillgänglighet.

Name	Typ	Description
message	string	meddelande som innehåller ett detaljerat orsaksnamn är inte tillgängligt
nameAvailable	boolean	anger om ett namn är tillgängligt eller inte
reason	NameUnavailabilityReason	anger orsaken till att ett namn inte är tillgängligt

NameUnavailabilityReason

anger orsaken till att ett namn inte är tillgängligt

Name	Typ	Description
AlreadyExists	string
Invalid	string

OperationInputs

Indatavärden för åtgärdsresultatanrop.

Name	Typ	Description
name	string	Namnet på etableringstjänsten som ska kontrolleras.