Iot Hub Resource - Get Keys For Key Name

Service:: IoT Hub

Version d'API:: 2023-06-30

Obtenez une stratégie d’accès partagé par nom à partir 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}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
keyName	path	True	string	Nom de la stratégie d’accès partagé.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le hub IoT.
resourceName	path	True	string	Nom du hub IoT.
subscriptionId	path	True	string	Identificateur d’abonnement.
api-version	query	True	string	Version de l’API.

Réponses

Nom	Type	Description
200 OK	SharedAccessSignatureAuthorizationRule	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 IoT Hub.
Other Status Codes	ErrorDetails	DefaultErrorResponse

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

IotHubResource_GetKeysForKeyName

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/IotHubKeys/iothubowner/listkeys?api-version=2023-06-30

Exemple de réponse

Code d’état:: 200

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

Définitions

Nom	Description
AccessRights	Autorisations affectées à la stratégie d’accès partagé.
ErrorDetails	Détails de l’erreur.
SharedAccessSignatureAuthorizationRule	Propriétés d’une stratégie d’accès partagé IoT Hub.

AccessRights

Énumération

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

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

ErrorDetails

Object

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