共用方式為


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 參數

名稱 位於 必要 類型 Description
provisioningServiceName
path True

string

要取得共用存取金鑰的佈建服務名稱。

resourceGroupName
path True

string

資源組名

subscriptionId
path True

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

回應

名稱 類型 Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

這是同步作業。 本文包含共用存取原則的 JSON 串行化陣列,包括可用來存取佈建服務端點的密鑰。

Other Status Codes

ErrorDetails

默認錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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"
    }
  ]
}

定義

名稱 Description
AccessRightsDescription

此金鑰擁有的許可權。

ErrorDetails

錯誤詳細數據。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共用存取金鑰的描述。

SharedAccessSignatureAuthorizationRuleListResult

共用存取金鑰的清單。

AccessRightsDescription

此金鑰擁有的許可權。

名稱 類型 Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

integer

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共用存取金鑰的描述。

名稱 類型 Description
keyName

string

金鑰的名稱。

primaryKey

string

主要 SAS 金鑰值。

rights

AccessRightsDescription

此金鑰擁有的許可權。

secondaryKey

string

次要 SAS 金鑰值。

SharedAccessSignatureAuthorizationRuleListResult

共用存取金鑰的清單。

名稱 類型 Description
nextLink

string

下一個連結。

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

共用存取原則的清單。