Iot Dps Resource - List Keys

Obtenha os metadados de segurança para um serviço de fornecimento.
Listar as chaves primárias e secundárias para um serviço de fornecimento.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?api-version=2018-01-22

Parâmetros do URI

Name In Required Type Description
provisioningServiceName
path True
  • string

O nome do serviço de fornecimento para obter as chaves de acesso partilhadas para.

resourceGroupName
path True
  • string

nome de grupo de recursos

subscriptionId
path True
  • string

O identificador de assinatura.

api-version
query True
  • string

A versão da API.

Respostas

Name Type Description
200 OK

Esta é uma operação sincronizada. O corpo contém uma série de políticas de acesso partilhado JSON, incluindo chaves, que pode usar para aceder aos pontos finais do serviço de fornecimento.

Other Status Codes

Resposta de erro por defeito.

Segurança

azure_auth

Azure Ative Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

DPSListKeys

Sample Request

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

Sample Response

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

Definições

AccessRightsDescription

Direitos que esta chave tem.

ErrorDetails

Detalhes de erro.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso partilhada.

SharedAccessSignatureAuthorizationRuleListResult

Lista de chaves de acesso partilhadas.

AccessRightsDescription

Direitos que esta chave tem.

Name Type Description
DeviceConnect
  • string
EnrollmentRead
  • string
EnrollmentWrite
  • string
RegistrationStatusRead
  • string
RegistrationStatusWrite
  • string
ServiceConfig
  • string

ErrorDetails

Detalhes de erro.

Name Type Description
code
  • string

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 partilhada.

Name Type Description
keyName
  • string

O nome da chave.

primaryKey
  • string

Valor chave SS Primário.

rights

Direitos que esta chave tem.

secondaryKey
  • string

Valor de chave SAS secundário.

SharedAccessSignatureAuthorizationRuleListResult

Lista de chaves de acesso partilhadas.

Name Type Description
nextLink
  • string

O próximo elo.

value

A lista de políticas de acesso partilhado.