Iot Hub Resource - Export Devices

Referência

Service:: IoT Hub

API Version:: 2018-04-01

Exporta todas as identidades de dispositivo no registro de identidade do Hub IoT para um contêiner de blob do Armazenamento do Azure. Para saber mais, confira 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 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.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
excludeKeys	True	boolean	O valor que indica se as chaves devem ser excluídas durante a exportação.
exportBlobContainerUri	True	string	O URI do contêiner de blob de exportação.

Respostas

Nome	Tipo	Description
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
ErrorDetails	Detalhes do erro.
ExportDevicesRequest	Use para fornecer parâmetros ao solicitar uma exportação de todos os dispositivos no Hub IoT.
JobResponse	As propriedades do objeto Job Response.
JobStatus	O status do trabalho.
JobType	O tipo do trabalho.

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.

ExportDevicesRequest

Use para fornecer parâmetros ao solicitar uma exportação de todos os dispositivos no Hub IoT.

Nome	Tipo	Description
excludeKeys	boolean	O valor que indica se as chaves devem ser excluídas durante a exportação.
exportBlobContainerUri	string	O URI do contêiner de blob de exportação.

JobResponse

As propriedades do objeto Job Response.

Nome	Tipo	Description
endTimeUtc	string	A hora em que o trabalho parou de ser processado.
failureReason	string	Se status == falhou, essa cadeia de caracteres que contém o motivo da falha.
jobId	string	O identificador do trabalho.
parentJobId	string	O identificador de trabalho do trabalho pai, se houver.
startTimeUtc	string	A hora de início do trabalho.
status	JobStatus	O status do trabalho.
statusMessage	string	A mensagem status para o trabalho.
type	JobType	O tipo do trabalho.

JobStatus

O status do trabalho.

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

JobType

O tipo do trabalho.

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