Iot Dps Resource - List Keys For Key Name

Riferimento

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Ottenere un criterio di accesso condiviso per nome da un servizio di provisioning.
Elencare le chiavi primarie e secondarie per un nome di chiave specifico

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys?api-version=2022-12-12

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
keyName	path	True	string	Nome chiave logica per cui ottenere i valori chiave.
provisioningServiceName	path	True	string	Nome del servizio di provisioning.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene il servizio di provisioning.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Si tratta di un'operazione sincrona. Il corpo contiene criteri di accesso condiviso serializzati JSON, incluse le chiavi, che è possibile usare per accedere a uno o più endpoint di servizio di provisioning.
Other Status Codes	ErrorDetails	Risposta di errore predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSGetKey

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

Definizioni

Nome	Descrizione
AccessRightsDescription	Diritti di cui dispone questa chiave.
ErrorDetails	Dettagli errore.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Descrizione della chiave di accesso condiviso.

AccessRightsDescription

Diritti di cui dispone questa chiave.

Nome	Tipo	Descrizione
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Dettagli errore.

Nome	Tipo	Descrizione
code	integer	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrizione della chiave di accesso condiviso.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave.
primaryKey	string	Valore della chiave di firma di accesso condiviso primario.
rights	AccessRightsDescription	Diritti di cui dispone questa chiave.
secondaryKey	string	Valore della chiave di firma di accesso condiviso secondario.