Iot Dps Resource - List Keys For Key Name

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

Rufen Sie eine Richtlinie für den freigegebenen Zugriff anhand des Namens eines Bereitstellungsdiensts ab.
Auflisten primärer und sekundärer Schlüssel 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=2018-01-22

URI-Parameter

Name	In	Required	Type	Description
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	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

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

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Scopes

Name	Description
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=2018-01-22

Sample Response

Status code:: 200

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

Definitionen

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

AccessRightsDescription

Rechte, die dieser Schlüssel hat.

Name	Type	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Fehlerdetails.

Name	Type	Description
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

Name	Type	Description
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.