Partilhar via

Iot Hub Resource - List Keys

Serviço:
IoT Hub
Versão da API:
2023-06-30

Obtenha os metadados de segurança para um hub IoT. Para mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys?api-version=2023-06-30

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o hub IoT.
resourceName
 path True

string

O nome do hub IoT.
subscriptionId
 path True

string

O identificador de assinatura.
api-version
 query True

string

A versão da API.

Respostas

Name Tipo Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Esta é uma operação síncrona. O corpo contém uma matriz serializada por JSON de políticas de acesso compartilhado, incluindo chaves, que você pode usar para acessar os pontos de extremidade do hub IoT.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

IotHubResource_ListKeys

Pedido de amostra

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/listkeys?api-version=2023-06-30

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "keyName": "iothubowner",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
    },
    {
      "keyName": "service",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "ServiceConnect"
    },
    {
      "keyName": "device",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "DeviceConnect"
    },
    {
      "keyName": "registryRead",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryRead"
    },
    {
      "keyName": "registryReadWrite",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite"
    }
  ]
}

Definições

Name Description
AccessRights

As permissões atribuídas à política de acesso compartilhado.
ErrorDetails

Detalhes do erro.
SharedAccessSignatureAuthorizationRule

As propriedades de uma política de acesso compartilhado do hub IoT.
SharedAccessSignatureAuthorizationRuleListResult

A lista de políticas de acesso compartilhado com um próximo link.

AccessRights

Enumeração

As permissões atribuídas à política de acesso compartilhado.

Valor Description
RegistryRead
RegistryWrite
ServiceConnect
DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, ServiceConnect
RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ErrorDetails

Object

Detalhes do erro.

Name Tipo Description
code

string

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.

SharedAccessSignatureAuthorizationRule

Object

As propriedades de uma política de acesso compartilhado do hub IoT.

Name Tipo Description
keyName

string

O nome da política de acesso compartilhado.
primaryKey

string

A chave primária.
rights

AccessRights

As permissões atribuídas à política de acesso compartilhado.
secondaryKey

string

A chave secundária.

SharedAccessSignatureAuthorizationRuleListResult

Object

A lista de políticas de acesso compartilhado com um próximo link.

Name Tipo Description
nextLink

string

O próximo link.
value

SharedAccessSignatureAuthorizationRule[]

A lista de políticas de acesso compartilhado.