다음을 통해 공유


Iot Hub Resource - Check Name Availability

IoT Hub 이름을 사용할 수 있는지 확인합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
subscriptionId
path True

string

구독 식별자입니다.

api-version
query True

string

API 버전입니다.

요청 본문

Name 필수 형식 Description
name True

string

검사 IoT Hub의 이름입니다.

응답

Name 형식 Description
200 OK

IotHubNameAvailabilityInfo

동기 작업입니다. 본문에는 IoT Hub 이름을 사용할 수 있는지 여부를 지정하는 JSON 직렬화된 응답이 포함되어 있습니다. 이름을 사용할 수 없는 경우 본문에 이유가 포함됩니다.

Other Status Codes

ErrorDetails

DefaultErrorResponse

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

IotHubResource_CheckNameAvailability

샘플 요청

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

{
  "name": "test-request"
}

샘플 응답

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

정의

Name Description
ErrorDetails

오류 세부 정보입니다.

IotHubNameAvailabilityInfo

지정된 IoT Hub 이름을 사용할 수 있는지 여부를 나타내는 속성입니다.

IotHubNameUnavailabilityReason

사용할 수 없는 이유입니다.

OperationInputs

입력 값입니다.

ErrorDetails

오류 세부 정보입니다.

Name 형식 Description
code

string

오류 코드입니다.

details

string

오류 세부 정보입니다.

httpStatusCode

string

HTTP 상태 코드입니다.

message

string

오류 메시지입니다.

IotHubNameAvailabilityInfo

지정된 IoT Hub 이름을 사용할 수 있는지 여부를 나타내는 속성입니다.

Name 형식 Description
message

string

자세한 이유 메시지입니다.

nameAvailable

boolean

제공된 이름을 사용할 수 있는지 여부를 나타내는 값입니다.

reason

IotHubNameUnavailabilityReason

사용할 수 없는 이유입니다.

IotHubNameUnavailabilityReason

사용할 수 없는 이유입니다.

Name 형식 Description
AlreadyExists

string

Invalid

string

OperationInputs

입력 값입니다.

Name 형식 Description
name

string

검사 IoT Hub의 이름입니다.