Partilhar via


Iot Dps Resource - List Keys For Key Name

Obtenha uma política de acesso partilhado por nome a partir de um serviço de aprovisionamento.
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=2022-12-12

Parâmetros do URI

Name Em Necessário Tipo Description
keyName
path True

string

Nome da chave lógica para obter valores chave para.

provisioningServiceName
path True

string

Nome do serviço de aprovisionamento.

resourceGroupName
path True

string

O nome do grupo de recursos que contém o serviço de aprovisionamento.

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Esta é uma operação síncrona. O corpo contém uma política de acesso partilhado serializado JSON, incluindo chaves, que pode utilizar para aceder a um ou mais 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

DPSGetKey

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
AccessRightsDescription

Direitos que esta chave tem.

ErrorDetails

Detalhes do erro.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave 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 principal.

rights

AccessRightsDescription

Direitos que esta chave tem.

secondaryKey

string

Valor da chave SAS secundária.