Iot Dps Resource - List Keys For Key Name

Service:: IoT Hub Device Provisioning Service

Version d'API:: 2022-12-12

Obtenez une stratégie d’accès partagé par nom à partir d’un service d’approvisionnement.
Répertorier les clés primaires et secondaires pour un nom de clé spécifique

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
keyName	path	True	string	Nom de clé logique pour lequel obtenir les valeurs de clé.
provisioningServiceName	path	True	string	Nom du service d’approvisionnement.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le service d’approvisionnement.
subscriptionId	path	True	string	Identificateur d’abonnement.
api-version	query	True	string	Version de l’API.

Réponses

Nom	Type	Description
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Il s’agit d’une opération synchrone. Le corps contient une stratégie d’accès partagé sérialisée JSON, y compris des clés, que vous pouvez utiliser pour accéder à un ou plusieurs points de terminaison de service d’approvisionnement.
Other Status Codes	ErrorDetails	Réponse d’erreur par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

DPSGetKey

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AccessRightsDescription	Droits que cette clé a.
ErrorDetails	Détails de l’erreur.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Description de la clé d’accès partagé.

AccessRightsDescription

Énumération

Droits que cette clé a.

Valeur	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Object

Détails de l’erreur.

Nom	Type	Description
code	integer (int32)	Code d’erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]