Iot Dps Resource - List Keys

サービス:: IoT Hub Device Provisioning Service

API バージョン:: 2026-08-31

プロビジョニングサービスのプライマリキーとセカンダリキーを一覧表示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?api-version=2026-08-31

URI パラメーター

名前	/	必須	型	説明
provisioningServiceName	path	True	string	取得すべきプロビジョニングサービスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字を区別しません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Azureの運用は無事に完了しました。
Other Status Codes	ErrorDetails	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	あなたのユーザーアカウントになりすます

例

DPSListKeys

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "rights": "ServiceConfig",
      "secondaryKey": "###################################"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "rights": "ServiceConfig",
      "secondaryKey": "####################################="
    }
  ]
}

定義

名前	説明
AccessRightsDescription	このキーが持つ権限。
ErrorDetails	エラーの詳細。
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	共有アクセスキーの説明。
SharedAccessSignatureAuthorizationRuleListResult	共有アクセスキーのリスト。

AccessRightsDescription

列挙

このキーが持つ権限。

値	説明
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Object

エラーの詳細。

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

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Object

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

名前	型	説明
keyName	string	キーの名前。
primaryKey	string	プライマリ SAS キーの値。
rights	AccessRightsDescription	このキーが持つ権限。
secondaryKey	string	セカンダリ SAS キー値。

SharedAccessSignatureAuthorizationRuleListResult

Object

共有アクセスキーのリスト。

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]	このページの共有アクセス署名権限規則アクセス権利説明項目