Iot Hub Resource - List Keys

Obtenha os metadados de segurança para um Hub IoT. Para saber mais, confira 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 de URI

Nome Em Obrigató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 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 do Hub IoT.

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

Exemplos

IotHubResource_ListKeys

Solicitação de exemplo

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

{
  "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

Nome 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

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

Nome Tipo Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

string

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

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

Nome Tipo Description
keyName

string

O nome da política de acesso compartilhado.

primaryKey

string

A chave principal.

rights

AccessRights

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

secondaryKey

string

A chave secundária.

SharedAccessSignatureAuthorizationRuleListResult

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

Nome Tipo Description
nextLink

string

O próximo link.

value

SharedAccessSignatureAuthorizationRule[]

A lista de políticas de acesso compartilhado.