Iot Dps Resource - List Keys For Key Name

リファレンス

サービス:: IoT Hub Device Provisioning Service

API バージョン:: 2022-12-12

プロビジョニングサービスから名前で共有アクセスポリシーを取得します。
特定のキー名のプライマリキーとセカンダリキーを一覧表示する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys?api-version=2022-12-12

URI パラメーター

名前	/	必須	型	説明
keyName	path	True	string	キー値を取得する論理キー名。
provisioningServiceName	path	True	string	プロビジョニングサービスの名前。
resourceGroupName	path	True	string	プロビジョニングサービスを含むリソースグループの名前。
subscriptionId	path	True	string	サブスクリプションの識別子です。
api-version	query	True	string	API のバージョン。

応答

名前	型	説明
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	これは同期操作です。本文には、1 つ以上のプロビジョニングサービスエンドポイントへのアクセスに使用できるキーを含む、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	ユーザーアカウントの借用

例

DPSGetKey

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/keys/testKey/listkeys?api-version=2022-12-12

応答のサンプル

状態コード:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

定義

名前	説明
AccessRightsDescription	このキーに含まれる権限。
ErrorDetails	エラーの詳細。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共有アクセスキーの説明。

AccessRightsDescription

このキーに含まれる権限。

名前	型	説明
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

エラーの詳細。

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共有アクセスキーの説明。

名前	型	説明
keyName	string	キーの名前。
primaryKey	string	プライマリ SAS キーの値。
rights	AccessRightsDescription	このキーに含まれる権限。
secondaryKey	string	セカンダリ SAS キー値。

次の方法で共有