Iot Hub Resource - Export Devices

Referencia

Service:: IoT Hub

API Version:: 2018-04-01

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices?api-version=2018-04-01

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	La versión de la API.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
excludeKeys	True	boolean	Valor que indica si las claves se deben excluir durante la exportación.
exportBlobContainerUri	True	string	Identificador URI del contenedor de blobs de exportación.

Respuestas

Nombre	Tipo	Description
200 OK	JobResponse	Aceptar
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

IotHubResource_ExportDevices

Sample Request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/exportDevices?api-version=2018-04-01

{
  "exportBlobContainerUri": "testBlob",
  "excludeKeys": true
}

Sample Response

Status code:: 200

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ExportDevicesRequest	Use para proporcionar parámetros al solicitar una exportación de todos los dispositivos del centro de IoT.
JobResponse	Propiedades del objeto Job Response.
JobStatus	El estado del trabajo.
JobType	Tipo del trabajo.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	string	Los detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.

ExportDevicesRequest

Use para proporcionar parámetros al solicitar una exportación de todos los dispositivos del centro de IoT.

Nombre	Tipo	Description
excludeKeys	boolean	Valor que indica si las claves se deben excluir durante la exportación.
exportBlobContainerUri	string	Identificador URI del contenedor de blobs de exportación.

JobResponse

Propiedades del objeto Job Response.

Nombre	Tipo	Description
endTimeUtc	string	Hora en que el trabajo detuvo el procesamiento.
failureReason	string	Si el estado == no se pudo realizar, esta cadena contiene el motivo del error.
jobId	string	Identificador de trabajo.
parentJobId	string	Identificador de trabajo del trabajo primario, si existe.
startTimeUtc	string	Hora de inicio del trabajo.
status	JobStatus	El estado del trabajo.
statusMessage	string	Mensaje de estado del trabajo.
type	JobType	Tipo del trabajo.

JobStatus

El estado del trabajo.

Nombre	Tipo	Description
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Tipo del trabajo.

Nombre	Tipo	Description
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

Share via