Iot Dps Resource - List Keys

Dienst:: IoT Hub Device Provisioning Service

API-Version:: 2026-08-31

Listen Sie den Primär- und Sekundärschlüssel für einen Bereitstellungsdienst auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
provisioningServiceName	path	True	string	Name des zu abrufenden Bereitstellungsdienstes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SharedAccessSignatureAuthorizationRuleListResult	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

DPSListKeys

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/listkeys?api-version=2026-08-31

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
AccessRightsDescription	Rechte, die dieser Schlüssel hat.
ErrorDetails	Fehlerdetails.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Beschreibung des freigegebenen Zugriffsschlüssels.
SharedAccessSignatureAuthorizationRuleListResult	Liste der gemeinsamen Zugriffsschlüssel.

AccessRightsDescription

Enumeration

Rechte, die dieser Schlüssel hat.

Wert	Beschreibung
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Objekt

Fehlerdetails.

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

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Objekt

Beschreibung des freigegebenen Zugriffsschlüssels.

Name	Typ	Beschreibung
keyName	string	Name des Schlüssels.
primaryKey	string	Primärer SAS-Schlüsselwert.
rights	AccessRightsDescription	Rechte, die dieser Schlüssel hat.
secondaryKey	string	Sekundärer SAS-Schlüsselwert.

SharedAccessSignatureAuthorizationRuleListResult

Objekt

Liste der gemeinsamen Zugriffsschlüssel.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]	Die SharedAccessSignatureAuthorizationRuleAccessRightsDescription-Elemente auf dieser Seite