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 パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	サブスクリプション識別子。
api-version	query	True	string	API のバージョン。

要求本文

名前	必須	型	説明
name	True	string	確認するプロビジョニング サービスの名前。

応答

名前	型	説明
200 OK	NameAvailabilityInfo	これは同期操作です。 本文には、プロビジョニング サービス名を使用できるかどうかを指定する JSON シリアル化された応答が含まれています。 名前が使用できない場合は、本文に理由が含まれます。
Other Status Codes	ErrorDetails	既定のエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

定義

名前	説明
ErrorDetails	エラーの詳細。
NameAvailabilityInfo	使用可能な名前の説明。
NameUnavailabilityReason	は、名前が使用できない理由を指定します
OperationInputs	操作結果呼び出しの入力値。

ErrorDetails

Object

エラーの詳細。

名前	型	説明
code	integer (int32)	エラー コード。
details	string	エラーの詳細。
httpStatusCode	string	HTTP 状態コード。
message	string	エラー メッセージ。

NameAvailabilityInfo

Object

使用可能な名前の説明。

名前	型	説明
message	string	詳細な理由名を含むメッセージは使用できません
nameAvailable	boolean	は、名前が使用可能かどうかを指定します
reason	NameUnavailabilityReason	は、名前が使用できない理由を指定します

NameUnavailabilityReason

列挙

は、名前が使用できない理由を指定します

値	説明
AlreadyExists
Invalid

OperationInputs

Object

操作結果呼び出しの入力値。

名前	型	説明
name	string	確認するプロビジョニング サービスの名前。