Bagikan melalui


Iot Hub Resource - List Keys

Dapatkan metadata keamanan untuk hub IoT. Untuk mengetahui informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys?api-version=2023-06-30

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

Nama grup sumber daya yang berisi hub IoT.

resourceName
path True

string

Nama hub IoT.

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 hub IoT.

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

IotHubResource_ListKeys

Permintaan sampel

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/listkeys?api-version=2023-06-30

Respon sampel

{
  "value": [
    {
      "keyName": "iothubowner",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
    },
    {
      "keyName": "service",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "ServiceConnect"
    },
    {
      "keyName": "device",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "DeviceConnect"
    },
    {
      "keyName": "registryRead",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryRead"
    },
    {
      "keyName": "registryReadWrite",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite"
    }
  ]
}

Definisi

Nama Deskripsi
AccessRights

Izin yang ditetapkan ke kebijakan akses bersama.

ErrorDetails

Detail kesalahan.

SharedAccessSignatureAuthorizationRule

Properti kebijakan akses bersama hub IoT.

SharedAccessSignatureAuthorizationRuleListResult

Daftar kebijakan akses bersama dengan tautan berikutnya.

AccessRights

Izin yang ditetapkan ke kebijakan akses bersama.

Nama Jenis Deskripsi
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ErrorDetails

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

details

string

Detail kesalahan.

httpStatusCode

string

Kode status HTTP.

message

string

Pesan kesalahan.

SharedAccessSignatureAuthorizationRule

Properti kebijakan akses bersama hub IoT.

Nama Jenis Deskripsi
keyName

string

Nama kebijakan akses bersama.

primaryKey

string

Kunci primer.

rights

AccessRights

Izin yang ditetapkan ke kebijakan akses bersama.

secondaryKey

string

Kunci sekunder.

SharedAccessSignatureAuthorizationRuleListResult

Daftar kebijakan akses bersama dengan tautan berikutnya.

Nama Jenis Deskripsi
nextLink

string

Tautan berikutnya.

value

SharedAccessSignatureAuthorizationRule[]

Daftar kebijakan akses bersama.