Iot Dps Resource - List Keys

Servizio:

IoT Hub Device Provisioning Service

Versione API:

2022-12-12

Ottenere i metadati di sicurezza per un servizio di provisioning.
Elencare le chiavi primarie e secondarie per un servizio di provisioning.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
provisioningServiceName	path	True	string	Nome del servizio di provisioning per cui ottenere le chiavi di accesso condiviso.
resourceGroupName	path	True	string	nome del gruppo di risorse
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Si tratta di un'operazione sincrona. Il corpo contiene una matrice serializzata JSON di criteri di accesso condiviso, incluse le chiavi, che è possibile usare per accedere agli endpoint del servizio di provisioning.
Other Status Codes	ErrorDetails	Risposta di errore predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSListKeys

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
AccessRightsDescription	Diritti di cui dispone la chiave.
ErrorDetails	Dettagli errore.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Descrizione della chiave di accesso condiviso.
SharedAccessSignatureAuthorizationRuleListResult	Elenco delle chiavi di accesso condiviso.

AccessRightsDescription

Enumerazione

Diritti di cui dispone la chiave.

Valore	Descrizione
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Object

Dettagli errore.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

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 la chiave.
secondaryKey	string	Valore della chiave di firma di accesso condiviso secondario.

SharedAccessSignatureAuthorizationRuleListResult

Object

Elenco delle chiavi di accesso condiviso.

Nome	Tipo	Descrizione
nextLink	string	Collegamento successivo.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Elenco dei criteri di accesso condiviso.