Iot Dps Resource - List Keys

Référence

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Obtenez les métadonnées de sécurité d’un service d’approvisionnement.
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=2022-12-12

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
provisioningServiceName	path	True	string	Nom du service d’approvisionnement pour lequel obtenir les clés d’accès partagé.
resourceGroupName	path	True	string	nom du groupe de ressources
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 json-sérialisé de stratégies d’accès partagé, y compris des clés, que vous pouvez utiliser pour accéder aux points de terminaison de service d’approvisionnement.
Other Status Codes	ErrorDetails	Réponse d’erreur par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

DPSListKeys

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

Définitions

Nom	Description
AccessRightsDescription	Droits dont dispose cette clé.
ErrorDetails	Détails de l’erreur.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Description de la clé d’accès partagé.
SharedAccessSignatureAuthorizationRuleListResult	Liste des clés d’accès partagé.

AccessRightsDescription

Droits dont dispose cette clé.

Nom	Type	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Détails de l’erreur.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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 dont dispose cette clé.
secondaryKey	string	Valeur de clé SAS secondaire.

SharedAccessSignatureAuthorizationRuleListResult

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

Nom	Type	Description
nextLink	string	Lien suivant.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Liste des stratégies d’accès partagé.