Iot Dps Resource - Check Provisioning Service Name Availability

Ссылка

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Проверьте, доступно ли имя службы подготовки. Будет проверено, является ли имя синтаксически допустимым и можно ли использовать имя.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя службы подготовки для проверка.

Ответы

Имя	Тип	Описание
200 OK	NameAvailabilityInfo	Это синхронная операция. Текст содержит сериализованный в формате JSON ответ, указывающий, доступно ли имя службы подготовки. Если имя недоступно, текст содержит причину.
Other Status Codes	ErrorDetails	Ответ об ошибке по умолчанию.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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"
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
NameAvailabilityInfo	Описание доступности имени.
NameUnavailabilityReason	указывает причину недоступности имени.
OperationInputs	Входные значения для вызова результатов операции.

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	integer	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

NameAvailabilityInfo

Описание доступности имени.

Имя	Тип	Описание
message	string	сообщение, содержащее подробное имя причины недоступно
nameAvailable	boolean	указывает, доступно ли имя
reason	NameUnavailabilityReason	указывает причину недоступности имени.

NameUnavailabilityReason

указывает причину недоступности имени.

Имя	Тип	Описание
AlreadyExists	string
Invalid	string

OperationInputs

Входные значения для вызова результатов операции.

Имя	Тип	Описание
name	string	Имя службы подготовки для проверка.

Share via