Iot Dps Resource - List Keys

Service:: IoT Hub Device Provisioning Service

Version d’API:: 2026-08-31

Répertorier les clés primaires et secondaires d’un service d’approvisionnement.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?api-version=2026-08-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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	SharedAccessSignatureAuthorizationRuleListResult	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

DPSListKeys

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "rights": "ServiceConfig",
      "secondaryKey": "###################################"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "rights": "ServiceConfig",
      "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é.
SharedAccessSignatureAuthorizationRuleListResult	Liste des clés d’accès partagées.

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.

SharedAccessSignatureAuthorizationRuleListResult

Objet

Liste des clés d’accès partagées.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]	Les éléments SharedAccessSignatureAuthorizationRuleAccessRightsDescription sur cette page