Iot Hub Resource - Get Keys For Key Name

Serviço:: IoT Hub

Versão da API:: 2023-06-30

Obtenha uma política de acesso compartilhado por nome de 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}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
keyName	path	True	string	O nome da política de acesso compartilhado.
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	SharedAccessSignatureAuthorizationRule	Esta é uma operação síncrona. O corpo contém uma política de acesso compartilhado serializada por JSON, incluindo chaves, que você pode usar para acessar um ou mais 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_GetKeysForKeyName

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

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.

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