Iot Hub Resource - Check Name Availability

IoT ハブ名が使用可能かどうかを確認します。

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

URI パラメーター

名前 / 必須 説明
subscriptionId
path True

string

サブスクリプションの識別子です。

api-version
query True

string

API のバージョン。

要求本文

名前 必須 説明
name True

string

チェックする IoT ハブの名前。

応答

名前 説明
200 OK

IotHubNameAvailabilityInfo

これは同期操作です。 本文には、IoT ハブ名を使用できるかどうかを指定する JSON シリアル化された応答が含まれています。 名前が使用できない場合、本文には理由が含まれます。

Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
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": ""
}

定義

名前 説明
ErrorDetails

エラーの詳細。

IotHubNameAvailabilityInfo

特定の IoT ハブ名を使用できるかどうかを示すプロパティ。

IotHubNameUnavailabilityReason

使用できない理由。

OperationInputs

入力値。

ErrorDetails

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。

IotHubNameAvailabilityInfo

特定の IoT ハブ名を使用できるかどうかを示すプロパティ。

名前 説明
message

string

詳細な理由メッセージ。

nameAvailable

boolean

指定した名前を使用できるかどうかを示す値。

reason

IotHubNameUnavailabilityReason

使用できない理由。

IotHubNameUnavailabilityReason

使用できない理由。

名前 説明
AlreadyExists

string

Invalid

string

OperationInputs

入力値。

名前 説明
name

string

チェックする IoT ハブの名前。