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

名稱	位於	必要	類型	Description
keyName	path	True	string	要為其取得索引鍵/值的邏輯金鑰名稱。
provisioningServiceName	path	True	string	布建服務的名稱。
resourceGroupName	path	True	string	包含布建服務的資源群組名稱。
subscriptionId	path	True	string	訂用帳戶標識碼。
api-version	query	True	string	API 版本。

回應

名稱	類型	Description
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	這是同步作業。 本文包含 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	模擬您的用戶帳戶

範例

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"
}

定義

名稱	Description
AccessRightsDescription	此金鑰擁有的許可權。
ErrorDetails	錯誤詳細數據。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共用存取金鑰的描述。

AccessRightsDescription

列舉型別

此金鑰擁有的許可權。

值	Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Object

錯誤詳細數據。

名稱	類型	Description
code	integer (int32)	錯誤碼。
details	string	錯誤詳細數據。
httpStatusCode	string	HTTP 狀態代碼。
message	string	錯誤訊息。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

共用存取金鑰的描述。

名稱	類型	Description
keyName	string	索引鍵的名稱。
primaryKey	string	主要 SAS 金鑰值。
rights	AccessRightsDescription	此金鑰擁有的許可權。
secondaryKey	string	次要 SAS 金鑰值。