次の方法で共有


Iot Dps Resource - List Keys

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

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 フロー。

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

スコープ

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

DPSListKeys

要求のサンプル

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

応答のサンプル

{
  "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][]

共有アクセス ポリシーの一覧。