Iot Hub Resource - Check Name Availability

Referencia

Service:: IoT Hub

API Version:: 2018-04-01

Compruebe si hay disponible un nombre de centro de IoT.

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

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 centro de IoT que se va a comprobar.

Respuestas

Nombre	Tipo	Description
200 OK	IotHubNameAvailabilityInfo	Se trata de una operación sincrónica. El cuerpo contiene una respuesta serializada por JSON que especifica si el nombre del centro de IoT está disponible. Si el nombre no está disponible, el cuerpo contiene el motivo.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

IotHubResource_CheckNameAvailability

Sample Request

HTTP

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

{
  "name": "test-request"
}

Sample Response

Status code:: 200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": ""
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
IotHubNameAvailabilityInfo	Propiedades que indican si hay disponible un nombre de centro de IoT determinado.
IotHubNameUnavailabilityReason	Motivo de falta de disponibilidad.
OperationInputs	Valores de entrada.

ErrorDetails

Detalles del error.

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

IotHubNameAvailabilityInfo

Propiedades que indican si hay disponible un nombre de centro de IoT determinado.

Nombre	Tipo	Description
message	string	Mensaje de motivo detallado.
nameAvailable	boolean	Valor que indica si el nombre proporcionado está disponible.
reason	IotHubNameUnavailabilityReason	Motivo de falta de disponibilidad.

IotHubNameUnavailabilityReason

Motivo de falta de disponibilidad.

Nombre	Tipo	Description
AlreadyExists	string
Invalid	string

OperationInputs

Valores de entrada.

Nombre	Tipo	Description
name	string	Nombre del centro de IoT que se va a comprobar.