Iot Dps Resource - List Keys

Referensi

Layanan:: IoT Hub Device Provisioning Service

Versi API:: 2022-12-12

Dapatkan metadata keamanan untuk layanan provisi.
Mencantumkan kunci primer dan sekunder untuk layanan provisi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
provisioningServiceName	path	True	string	Nama layanan provisi untuk mendapatkan kunci akses bersama.
resourceGroupName	path	True	string	nama grup sumber daya
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Respons

Nama	Jenis	Deskripsi
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Ini adalah operasi sinkron. Isi berisi array kebijakan akses bersama yang diserialisasikan JSON, termasuk kunci, yang dapat Anda gunakan untuk mengakses titik akhir layanan provisi.
Other Status Codes	ErrorDetails	Respons kesalahan default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

DPSListKeys

Permintaan sampel

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
AccessRightsDescription	Hak yang dimiliki kunci ini.
ErrorDetails	Detail kesalahan.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Deskripsi kunci akses bersama.
SharedAccessSignatureAuthorizationRuleListResult	Daftar 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.

SharedAccessSignatureAuthorizationRuleListResult

Daftar kunci akses bersama.

Nama	Jenis	Deskripsi
nextLink	string	Tautan berikutnya.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Daftar kebijakan akses bersama.

Bagikan melalui