Iot Dps Resource - List Keys

Referência

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 2022-12-12

Obtenha os metadados de segurança de um serviço de aprovisionamento.
Liste as chaves primárias e secundárias de um serviço de aprovisionamento.

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 aprovisionamento para o qual obter as chaves de acesso partilhado.
resourceGroupName	path	True	string	nome do grupo de recursos
subscriptionId	path	True	string	O identificador da subscrição.
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 JSON de políticas de acesso partilhado, incluindo chaves, que pode utilizar para aceder aos pontos finais de serviço de aprovisionamento.
Other Status Codes	ErrorDetails	Resposta de erro predefinida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar 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 partilhado.
SharedAccessSignatureAuthorizationRuleListResult	Lista de chaves de acesso partilhado.

AccessRightsDescription

Direitos que esta chave tem.

Name	Tipo	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Detalhes do erro.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso partilhado.

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

Lista de chaves de acesso partilhado.

Name	Tipo	Description
nextLink	string	A ligação seguinte.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	A lista de políticas de acesso partilhado.

Partilhar via