Iot Dps Resource - List Keys For Key Name

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 2026-08-31

Listar chaves primárias e secundárias para um nome de chave específico

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
keyName	path	True	string	Nome lógico de chave para obter valores-chave.
provisioningServiceName	path	True	string	Nome do serviço de aprovisionamento a recuperar.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	O ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorDetails	Uma resposta de erro inesperada.

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	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

DPSGetKey

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Descrição
AccessRightsDescription	Direitos que esta chave tem.
ErrorDetails	Detalhes do erro.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Descrição da chave de acesso partilhada.

AccessRightsDescription

Enumeração

Direitos que esta chave tem.

Valor	Descrição
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Object

Detalhes do erro.

Name	Tipo	Descrição
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.

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Object

Descrição da chave de acesso partilhada.

Name	Tipo	Descrição
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.