Iot Dps Resource - List Keys
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 |
---|---|---|---|---|
provisioning
|
path | True |
string |
Nom du service d’approvisionnement pour lequel obtenir les clés d’accès partagé. |
resource
|
path | True |
string |
nom du groupe de ressources |
subscription
|
path | True |
string |
Identificateur de l’abonnement. |
api-version
|
query | True |
string |
Version de l’API. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
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 |
Réponse d’erreur par défaut. |
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
DPSListKeys
Exemple de requête
POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/listkeys?api-version=2022-12-12
Exemple de réponse
{
"value": [
{
"keyName": "key1",
"primaryKey": "#####################################",
"secondaryKey": "###################################",
"rights": "ServiceConfig"
},
{
"keyName": "key2",
"primaryKey": "#######################################",
"secondaryKey": "####################################=",
"rights": "ServiceConfig"
}
]
}
Définitions
Nom | Description |
---|---|
Access |
Droits dont dispose cette clé. |
Error |
Détails de l’erreur. |
Shared |
Description de la clé d’accès partagé. |
Shared |
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 |
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 |
Shared |
Liste des stratégies d’accès partagé. |