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 de URI

Nome	Em	Obrigatório	Tipo	Description
keyName	path	True	string	Nome lógico da chave para obter valores-chave.
provisioningServiceName	path	True	string	Nome do serviço de aprovisionamento a ser recuperado.
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 ser usada para esta operação.

Respostas

Nome	Tipo	Description
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 do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	se passar pela sua conta de usuário

Exemplos

DPSGetKey

Solicitação de exemplo

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 de exemplo

Código de status:: 200

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

Definições

Nome	Description
AccessRightsDescription	Direitos que essa chave tem.
ErrorDetails	Detalhes do erro.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Descrição da chave de acesso compartilhado.

AccessRightsDescription

Enumeração

Direitos que essa chave tem.

Valor	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Objeto

Detalhes do erro.

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

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Objeto

Descrição da chave de acesso compartilhado.

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