Iot Dps Resource - List Keys For Key Name

Referenz

Dienst:: IoT Hub Device Provisioning Service

API-Version:: 2022-12-12

Rufen Sie eine freigegebene Zugriffsrichtlinie anhand des Namens von einem Bereitstellungsdienst ab.
Auflisten von Primär- und Sekundärschlüsseln für einen bestimmten Schlüsselnamen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
keyName	path	True	string	Logischer Schlüsselname zum Abrufen von Schlüsselwerten
provisioningServiceName	path	True	string	Name des Bereitstellungsdiensts.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte Richtlinie für den freigegebenen Zugriff, einschließlich Schlüsseln, die Sie für den Zugriff auf einen oder mehrere Bereitstellungsdienstendpunkte verwenden können.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

DPSGetKey

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

Definitionen

Name	Beschreibung
AccessRightsDescription	Rechte, die dieser Schlüssel hat.
ErrorDetails	Fehlerdetails.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschreibung des freigegebenen Zugriffsschlüssels.

AccessRightsDescription

Enumeration

Rechte, die dieser Schlüssel hat.

Wert	Beschreibung
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Objekt

Fehlerdetails.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]