Compartir a través de

Iot Hub Resource - List Keys

Servicio:
IoT Hub
Versión de la API:
2023-06-30

Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, vea: 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 identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el centro de IoT.
resourceName
 path True

string

Nombre del centro de IoT.
subscriptionId
 path True

string

Identificador de la suscripción.
api-version
 query True

string

Versión de la API.

Respuestas

Nombre Tipo Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Se trata de una operación sincrónica. El cuerpo contiene una matriz serializada por JSON de directivas de acceso compartido, incluidas las claves, que puede usar para acceder a los puntos de conexión de IoT Hub.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

IotHubResource_ListKeys

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
    }
  ]
}

Definiciones

Nombre Description
AccessRights

Permisos asignados a la directiva de acceso compartido.
ErrorDetails

Detalles del error.
SharedAccessSignatureAuthorizationRule

Las propiedades de una directiva de acceso compartido de IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult

Lista de directivas de acceso compartido con un vínculo siguiente.

AccessRights

Enumeración

Permisos asignados a la directiva de acceso compartido.

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

Detalles del error.

Nombre Tipo Description
code

string

Código de error.
details

string

Detalles del error.
httpStatusCode

string

Código de estado HTTP.
message

string

Mensaje de error.

SharedAccessSignatureAuthorizationRule

Object

Las propiedades de una directiva de acceso compartido de IoT Hub.

Nombre Tipo Description
keyName

string

Nombre de la directiva de acceso compartido.
primaryKey

string

Clave principal.
rights

AccessRights

Permisos asignados a la directiva de acceso compartido.
secondaryKey

string

Clave secundaria.

SharedAccessSignatureAuthorizationRuleListResult

Object

Lista de directivas de acceso compartido con un vínculo siguiente.

Nombre Tipo Description
nextLink

string

Vínculo siguiente.
value

SharedAccessSignatureAuthorizationRule[]

Lista de directivas de acceso compartido.