Iot Dps Resource - Check Provisioning Service Name Availability

Referencia

Servicio:: IoT Hub Device Provisioning Service

Versión de la API:: 2022-12-12

Compruebe si hay disponible un nombre de servicio de aprovisionamiento. Esto validará si el nombre es sintácticamente válido y si el nombre es utilizable

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del servicio de aprovisionamiento que se va a comprobar.

Respuestas

Nombre	Tipo	Description
200 OK	NameAvailabilityInfo	Se trata de una operación sincrónica. El cuerpo contiene una respuesta serializada por JSON que especifica si el nombre del servicio de aprovisionamiento está disponible. Si el nombre no está disponible, el cuerpo contiene el motivo.
Other Status Codes	ErrorDetails	Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

DPSCheckName

Solicitud de ejemplo

HTTP

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

{
  "name": "test213123"
}

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
NameAvailabilityInfo	Descripción de la disponibilidad del nombre.
NameUnavailabilityReason	especifica el motivo por el que un nombre no está disponible.
OperationInputs	Valores de entrada para la llamada a los resultados de la operación.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	integer	Código de error.
details	string	Los detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.

NameAvailabilityInfo

Descripción de la disponibilidad del nombre.

Nombre	Tipo	Description
message	string	mensaje que contiene un nombre de motivo detallado no está disponible
nameAvailable	boolean	especifica si un nombre está disponible o no
reason	NameUnavailabilityReason	especifica el motivo por el que un nombre no está disponible.

NameUnavailabilityReason

especifica el motivo por el que un nombre no está disponible.

Nombre	Tipo	Description
AlreadyExists	string
Invalid	string

OperationInputs

Valores de entrada para la llamada a los resultados de la operación.

Nombre	Tipo	Description
name	string	Nombre del servicio de aprovisionamiento que se va a comprobar.

Compartir a través de