Iot Dps Resource - List Keys For Key Name

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Rufen Sie eine Shared Access-Richtlinie 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	Name des logischen Schlüssels, für den Schlüsselwerte abgerufen werden sollen.
provisioningServiceName	path	True	string	Name des Bereitstellungsdiensts.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
subscriptionId	path	True	string	Die Abonnement-ID.
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 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

DPSGetKey

Sample Request

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

Sample Response

Status code:: 200

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

Definitionen

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

AccessRightsDescription

Rechte, die dieser Schlüssel besitzt.

Name	Typ	Beschreibung
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Fehlerdetails.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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 besitzt.
secondaryKey	string	Sekundärer SAS-Schlüsselwert.

Freigeben über