Iot Dps Resource - List Keys

リファレンス

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

プロビジョニングサービスのセキュリティメタデータを取得します。
プロビジョニングサービスのプライマリキーとセカンダリキーを一覧表示します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	SharedAccessSignatureAuthorizationRuleListResult	これは同期操作です。本文には、プロビジョニングサービスエンドポイントへのアクセスに使用できる、キーを含む、共有アクセスポリシーの JSON でシリアル化された配列が含まれています。
Other Status Codes	ErrorDetails	既定のエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

DPSListKeys

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定義

名前	説明
AccessRightsDescription	このキーに与える権限。
ErrorDetails	エラーの詳細。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共有アクセスキーの説明。
SharedAccessSignatureAuthorizationRuleListResult	共有アクセスキーの一覧。

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 キー値。

SharedAccessSignatureAuthorizationRuleListResult

共有アクセスキーの一覧。

名前	型	説明
nextLink	string	次のリンク。
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	共有アクセスポリシーの一覧。