Compartilhar via


Iot Hub Resource - Export Devices

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=2023-06-30

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.

authenticationType

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

configurationsBlobName

string

O nome do blob que será criado no contêiner de blob de saída fornecido. Esse blob conterá as configurações exportadas para o Hub Iot.

exportBlobName

string

O nome do blob que será criado no contêiner de blob de saída fornecido. Esse blob conterá as informações exportadas do registro de dispositivo para o Hub IoT.

identity

ManagedIdentity

Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para exportar dispositivos.

includeConfigurations

boolean

O valor que indica se as configurações devem ser exportadas.

Respostas

Nome Tipo Description
200 OK

JobResponse

OK

Other Status Codes

ErrorDetails

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_ExportDevices

Solicitação de exemplo

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

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

Resposta de exemplo

{
  "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
AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

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.

ManagedIdentity

As propriedades da identidade gerenciada.

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

Nome Tipo Description
identityBased

string

keyBased

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.

ExportDevicesRequest

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

Nome Tipo Description
authenticationType

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

configurationsBlobName

string

O nome do blob que será criado no contêiner de blob de saída fornecido. Esse blob conterá as configurações exportadas para o Hub Iot.

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.

exportBlobName

string

O nome do blob que será criado no contêiner de blob de saída fornecido. Esse blob conterá as informações exportadas do registro de dispositivo para o Hub IoT.

identity

ManagedIdentity

Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para exportar dispositivos.

includeConfigurations

boolean

O valor que indica se as configurações devem ser exportadas.

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

ManagedIdentity

As propriedades da identidade gerenciada.

Nome Tipo Description
userAssignedIdentity

string

A identidade atribuída pelo usuário.