Iot Hub Resource - Get Keys For Key Name
Obtenha uma política de acesso compartilhado pelo nome de 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}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
key
|
path | True |
string |
O nome da política de acesso compartilhado. |
resource
|
path | True |
string |
O nome do grupo de recursos que contém o hub IoT. |
resource
|
path | True |
string |
O nome do Hub IoT. |
subscription
|
path | True |
string |
O identificador da assinatura. |
api-version
|
query | True |
string |
A versão da API. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Essa é 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 |
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_GetKeysForKeyName
Solicitação de exemplo
Resposta de exemplo
{
"keyName": "iothubowner",
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}
Definições
Nome | Description |
---|---|
Access |
As permissões atribuídas à política de acesso compartilhado. |
Error |
Detalhes do erro. |
Shared |
As propriedades de uma política de acesso compartilhado do Hub IoT. |
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 |
As permissões atribuídas à política de acesso compartilhado. |
|
secondaryKey |
string |
A chave secundária. |