Iot Dps Resource - Check Provisioning Service Name Availability

참조

서비스:: IoT Hub Device Provisioning Service

API 버전:: 2022-12-12

프로비저닝 서비스 이름을 사용할 수 있는지 확인합니다. 이렇게 하면 이름이 구문적으로 유효한지와 이름을 사용할 수 있는지 확인합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API 버전입니다.

요청 본문

Name	필수	형식	Description
name	True	string	검사 프로비전 서비스의 이름입니다.

응답

Name	형식	Description
200 OK	NameAvailabilityInfo	동기 작업입니다. 본문에는 프로비전 서비스 이름을 사용할 수 있는지 여부를 지정하는 JSON 직렬화된 응답이 포함되어 있습니다. 이름을 사용할 수 없는 경우 본문에 이유가 포함됩니다.
Other Status Codes	ErrorDetails	기본 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

DPSCheckName

샘플 요청

HTTP

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

{
  "name": "test213123"
}

샘플 응답

상태 코드:: 200

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

정의

Name	Description
ErrorDetails	오류 세부 정보입니다.
NameAvailabilityInfo	이름 가용성에 대한 설명입니다.
NameUnavailabilityReason	는 이름을 사용할 수 없는 이유를 지정합니다.
OperationInputs	작업 결과 호출에 대한 입력 값입니다.

ErrorDetails

오류 세부 정보입니다.

Name	형식	Description
code	integer	오류 코드입니다.
details	string	오류 세부 정보입니다.
httpStatusCode	string	HTTP 상태 코드입니다.
message	string	오류 메시지입니다.

NameAvailabilityInfo

이름 가용성에 대한 설명입니다.

Name	형식	Description
message	string	자세한 이유 이름을 포함하는 메시지를 사용할 수 없음
nameAvailable	boolean	는 이름을 사용할 수 있는지 여부를 지정합니다.
reason	NameUnavailabilityReason	는 이름을 사용할 수 없는 이유를 지정합니다.

NameUnavailabilityReason

는 이름을 사용할 수 없는 이유를 지정합니다.

Name	형식	Description
AlreadyExists	string
Invalid	string

OperationInputs

작업 결과 호출에 대한 입력 값입니다.

Name	형식	Description
name	string	검사 프로비전 서비스의 이름입니다.

다음을 통해 공유