Iot Hub Resource - Get Keys For Key Name

Dienst:: IoT Hub

API-Version:: 2026-11-01

Rufen Sie eine SAS-Richtlinie nach Namen aus einem 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}/IotHubKeys/{keyName}/listkeys?api-version=2026-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
keyName	path	True	string	Der Name der Richtlinie für den freigegebenen Zugriff.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name des IoT-Hubs.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SharedAccessSignatureAuthorizationRule	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorDetails	Unerwartete Fehlerantwort.

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	Sich als Ihr Benutzerkonto ausgeben

Beispiele

IotHubResource_GetKeysForKeyName

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/IotHubKeys/iothubowner/listkeys?api-version=2026-11-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect",
  "secondaryKey": "<secondaryKey>"
}

Definitionen

Name	Beschreibung
AccessRights	Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.
ErrorDetails	Fehlerdetails.
SharedAccessSignatureAuthorizationRule	Die Eigenschaften einer IoT Hub-SAS-Richtlinie.

AccessRights

Enumeration

Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.

Wert	Beschreibung
RegistryRead	RegistryRead
RegistryWrite	RegistryWrite
ServiceConnect	ServiceConnect
DeviceConnect	DeviceConnect
RegistryRead, RegistryWrite	RegistryRead, RegistryWrite
RegistryRead, ServiceConnect	RegistryRead, ServiceConnect
RegistryRead, DeviceConnect	RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect	RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect	RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect	ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect	RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect	RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect	RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect	RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect	RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ErrorDetails

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

SharedAccessSignatureAuthorizationRule

Objekt

Die Eigenschaften einer IoT Hub-SAS-Richtlinie.

Name	Typ	Beschreibung
keyName	string	Der Name der Richtlinie für den freigegebenen Zugriff.
primaryKey	string	Der Primärschlüssel.
rights	AccessRights	Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.
secondaryKey	string	Der sekundäre Schlüssel.