Iot Dps Resource - List Keys For Key Name

Referensi

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Dapatkan kebijakan akses bersama berdasarkan nama dari layanan provisi.
Mencantumkan kunci primer dan sekunder untuk nama kunci tertentu

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
keyName	path	True	string	Nama kunci logis untuk mendapatkan nilai kunci.
provisioningServiceName	path	True	string	Nama layanan provisi.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi layanan provisi.
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Respons

Nama	Jenis	Deskripsi
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Ini adalah operasi sinkron. Isi berisi kebijakan akses bersama berseri JSON, termasuk kunci, yang dapat Anda gunakan untuk mengakses satu atau beberapa titik akhir layanan provisi.
Other Status Codes	ErrorDetails	Respons kesalahan default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

DPSGetKey

Sample Request

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

Sample Response

Status code:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

Definisi

Nama	Deskripsi
AccessRightsDescription	Hak yang dimiliki kunci ini.
ErrorDetails	Detail kesalahan.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Deskripsi kunci akses bersama.

AccessRightsDescription

Hak yang dimiliki kunci ini.

Nama	Jenis	Deskripsi
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	integer	Kode kesalahan.
details	string	Detail kesalahan.
httpStatusCode	string	Kode status HTTP.
message	string	Pesan kesalahan.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Deskripsi kunci akses bersama.

Nama	Jenis	Deskripsi
keyName	string	Nama kunci.
primaryKey	string	Nilai kunci SAS utama.
rights	AccessRightsDescription	Hak yang dimiliki kunci ini.
secondaryKey	string	Nilai kunci SAS sekunder.

Share via