Iot Hub Resource - List Keys

Service:: IoT Hub

Version d’API:: 2026-11-01

Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys?api-version=2026-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom n’est pas sensible à la casse.
resourceName	path	True	string	Nom du hub IoT.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
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

IotHubResource_ListKeys

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/listkeys?api-version=2026-11-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "keyName": "iothubowner",
      "primaryKey": "<primaryKey>",
      "rights": "RegistryWrite, ServiceConnect, DeviceConnect",
      "secondaryKey": "<secondaryKey>"
    },
    {
      "keyName": "service",
      "primaryKey": "<primaryKey>",
      "rights": "ServiceConnect",
      "secondaryKey": "<secondaryKey>"
    },
    {
      "keyName": "device",
      "primaryKey": "<primaryKey>",
      "rights": "DeviceConnect",
      "secondaryKey": "<secondaryKey>"
    },
    {
      "keyName": "registryRead",
      "primaryKey": "<primaryKey>",
      "rights": "RegistryRead",
      "secondaryKey": "<secondaryKey>"
    },
    {
      "keyName": "registryReadWrite",
      "primaryKey": "<primaryKey>",
      "rights": "RegistryWrite",
      "secondaryKey": "<secondaryKey>"
    }
  ]
}

Définitions

Nom	Description
AccessRights	Autorisations affectées à la stratégie d’accès partagé.
ErrorDetails	Détails de l’erreur.
SharedAccessSignatureAuthorizationRule	Les propriétés d’une stratégie d’accès partagé IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	La liste des stratégies d’accès partagé avec un lien suivant.

AccessRights

Énumération

Autorisations affectées à la stratégie d’accès partagé.

Valeur	Description
RegistryRead	RegistryRead
RegistryWrite	RegistryWrite
ServiceConnect	ServiceConnect
DeviceConnect	DeviceConnect
RegistryRead, RegistryWrite	RegistryRead, RegistryWrite
RegistryRead, ServiceConnect	RegistryRead, ServiceConnect
RegistryRead, DeviceConnect	RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect	RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect	RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect	ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect	RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect	RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect	RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect	RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect	RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ErrorDetails

Objet

Détails de l’erreur.

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

SharedAccessSignatureAuthorizationRule

Objet

Les propriétés d’une stratégie d’accès partagé IoT Hub.

Nom	Type	Description
keyName	string	Nom de la stratégie d’accès partagé.
primaryKey	string	Clé primaire.
rights	AccessRights	Autorisations affectées à la stratégie d’accès partagé.
secondaryKey	string	Clé secondaire.

SharedAccessSignatureAuthorizationRuleListResult

Objet

La liste des stratégies d’accès partagé avec un lien suivant.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	SharedAccessSignatureAuthorizationRule[]	Les éléments de la règle SharedAccessSignatureAuthorizationRule sur cette page