Iot Dps Resource - List Keys

Serviço:

IoT Hub Device Provisioning Service

Versão da API:

2022-12-12

Obtenha os metadados de segurança para um serviço de provisionamento.
Liste as chaves primária e secundária de um serviço de provisionamento.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
provisioningServiceName	path	True	string	O nome do serviço de provisionamento para obter as chaves de acesso compartilhadas.
resourceGroupName	path	True	string	Nome do grupo de recursos
subscriptionId	path	True	string	O identificador de assinatura.
api-version	query	True	string	A versão da API.

Respostas

Name	Tipo	Description
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Esta é uma operação síncrona. O corpo contém uma matriz serializada por JSON de políticas de acesso compartilhado, incluindo chaves, que você pode usar para acessar os pontos de extremidade do serviço de provisionamento.
Other Status Codes	ErrorDetails	Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

DPSListKeys

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
AccessRightsDescription	Direitos que esta chave tem.
ErrorDetails	Detalhes do erro.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Descrição da chave de acesso partilhada.
SharedAccessSignatureAuthorizationRuleListResult	Lista de chaves de acesso compartilhadas.

AccessRightsDescription

Enumeração

Direitos que esta chave tem.

Valor	Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Object

Detalhes do erro.

Name	Tipo	Description
code	integer (int32)	O código de erro.
details	string	Os detalhes do erro.
httpStatusCode	string	O código de status HTTP.
message	string	A mensagem de erro.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

Descrição da chave de acesso partilhada.

Name	Tipo	Description
keyName	string	Nome da chave.
primaryKey	string	Valor da chave SAS primária.
rights	AccessRightsDescription	Direitos que esta chave tem.
secondaryKey	string	Valor da chave SAS secundária.

SharedAccessSignatureAuthorizationRuleListResult

Object

Lista de chaves de acesso compartilhadas.

Name	Tipo	Description
nextLink	string	O próximo link.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	A lista de políticas de acesso compartilhado.