Compartilhar via


Iot Dps Resource - List Keys

Obtenha os metadados de segurança de um serviço de provisionamento.
Liste as chaves primárias e secundárias para 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 de URI

Nome Em Obrigatório Tipo Description
provisioningServiceName
path True

string

O nome do serviço de provisionamento para o qual obter as chaves de acesso compartilhado.

resourceGroupName
path True

string

nome do grupo de recursos

subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Respostas

Nome Tipo Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Essa é uma operação síncrona. O corpo contém uma matriz serializada em JSON de políticas de acesso compartilhado, incluindo chaves, que você pode usar para acessar os pontos de extremidade de serviço de provisionamento.

Other Status Codes

ErrorDetails

Resposta de erro padrão.

Segurança

azure_auth

Fluxo 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 representar sua conta de usuário

Exemplos

DPSListKeys

Solicitação de exemplo

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

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

Definições

Nome Description
AccessRightsDescription

Direitos que essa chave tem.

ErrorDetails

Detalhes do erro.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso compartilhado.

SharedAccessSignatureAuthorizationRuleListResult

Lista de chaves de acesso compartilhado.

AccessRightsDescription

Direitos que essa chave tem.

Nome Tipo Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

integer

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.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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 da chave SAS secundária.

SharedAccessSignatureAuthorizationRuleListResult

Lista de chaves de acesso compartilhado.

Nome Tipo Description
nextLink

string

O próximo link.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

A lista de políticas de acesso compartilhado.