Iot Dps Resource - List Keys For Key Name

Service:: IoT Hub Device Provisioning Service

Version d’API:: 2026-08-31

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=2026-08-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
keyName	path	True	string	Nom de clé logique pour obtenir des valeurs clés.
provisioningServiceName	path	True	string	Nom du service de provisionnement à récupérer.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Opération Azure terminée avec succès.
Other Status Codes	ErrorDetails	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

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

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte 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=2026-08-31

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AccessRightsDescription	Droits que cette clé a.
ErrorDetails	Détails de l’erreur.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	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

Objet

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.

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Objet

Description de la clé d’accès partagé.

Nom	Type	Description
keyName	string	Nom de la clé.
primaryKey	string	Valeur de clé SAS primaire.
rights	AccessRightsDescription	Droits que cette clé a.
secondaryKey	string	Valeur de clé SAP secondaire.