Freigeben über


Iot Hub Resource - List Keys

Rufen Sie die Sicherheitsmetadaten für einen IoT Hub ab. Weitere Informationen finden Sie unter 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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.

resourceName
path True

string

Der Name des IoT-Hubs.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array von SAS-Richtlinien, einschließlich Schlüsseln, die Sie für den Zugriff auf die IoT Hub-Endpunkte verwenden können.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_ListKeys

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AccessRights

Die berechtigungen, die der SAS-Richtlinie zugewiesen sind.

ErrorDetails

Fehlerdetails.

SharedAccessSignatureAuthorizationRule

Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff.

SharedAccessSignatureAuthorizationRuleListResult

Die Liste der SAS-Richtlinien mit einem nächsten Link.

AccessRights

Die berechtigungen, die der SAS-Richtlinie zugewiesen sind.

Name Typ Beschreibung
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

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

SharedAccessSignatureAuthorizationRule

Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff.

Name Typ Beschreibung
keyName

string

Der Name der SAS-Richtlinie.

primaryKey

string

Der primäre Schlüssel.

rights

AccessRights

Die berechtigungen, die der SAS-Richtlinie zugewiesen sind.

secondaryKey

string

Der sekundäre Schlüssel.

SharedAccessSignatureAuthorizationRuleListResult

Die Liste der SAS-Richtlinien mit einem nächsten Link.

Name Typ Beschreibung
nextLink

string

Der nächste Link.

value

SharedAccessSignatureAuthorizationRule[]

Die Liste der SAS-Richtlinien.