Partager via


Iot Hub Resource - List Keys

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=2023-06-30

Paramètres URI

Nom Dans Obligatoire Type Description
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 de l’abonnement.

api-version
query True

string

Version de l’API.

Réponses

Nom Type Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Il s’agit d’une opération synchrone. Le corps contient un tableau sérialisé JSON de stratégies d’accès partagé, y compris des clés, que vous pouvez utiliser pour accéder aux 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_ListKeys

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
AccessRights

Autorisations attribué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.

SharedAccessSignatureAuthorizationRuleListResult

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

AccessRights

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

Nom Type Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ErrorDetails

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

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 attribuées à la stratégie d’accès partagé.

secondaryKey

string

Clé secondaire.

SharedAccessSignatureAuthorizationRuleListResult

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

Nom Type Description
nextLink

string

Lien suivant.

value

SharedAccessSignatureAuthorizationRule[]

Liste des stratégies d’accès partagé.