Partilhar via


Iot Hub Resource - Export Devices

Exporta todas as identidades do dispositivo no registo de identidades do hub IoT para um contentor de blobs do Armazenamento do Azure. Para obter mais informações, 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=2023-06-30

Parâmetros do URI

Name Em Necessá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 subscrição.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Necessá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 contentor de blobs de exportação.

authenticationType

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.

configurationsBlobName

string

O nome do blob que será criado no contentor de blobs de saída fornecido. Este blob irá conter as configurações exportadas para o Hub IoT.

exportBlobName

string

O nome do blob que será criado no contentor de blobs de saída fornecido. Este blob irá conter as informações de registo de dispositivos exportadas para o Hub IoT.

identity

ManagedIdentity

Propriedades de identidade gerida do ponto final de armazenamento para exportar dispositivos.

includeConfigurations

boolean

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

Respostas

Name Tipo Description
200 OK

JobResponse

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IotHubResource_ExportDevices

Pedido de amostra

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 da amostra

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

Name Description
AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.

ErrorDetails

Detalhes do erro.

ExportDevicesRequest

Utilize para fornecer parâmetros ao pedir uma exportação de todos os dispositivos no hub IoT.

JobResponse

As propriedades do objeto Job Response.

JobStatus

O estado da tarefa.

JobType

O tipo de tarefa.

ManagedIdentity

As propriedades da Identidade gerida.

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.

Name Tipo Description
identityBased

string

keyBased

string

ErrorDetails

Detalhes do erro.

Name Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de estado HTTP.

message

string

A mensagem de erro.

ExportDevicesRequest

Utilize para fornecer parâmetros ao pedir uma exportação de todos os dispositivos no hub IoT.

Name Tipo Description
authenticationType

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.

configurationsBlobName

string

O nome do blob que será criado no contentor de blobs de saída fornecido. Este blob irá 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 contentor de blobs de exportação.

exportBlobName

string

O nome do blob que será criado no contentor de blobs de saída fornecido. Este blob irá conter as informações de registo de dispositivos exportadas para o Hub IoT.

identity

ManagedIdentity

Propriedades de identidade gerida do ponto final 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.

Name Tipo Description
endTimeUtc

string

A hora em que a tarefa deixou de ser processada.

failureReason

string

Se o estado == tiver falhado, esta cadeia de carateres contém o motivo da falha.

jobId

string

O identificador da tarefa.

parentJobId

string

O identificador da tarefa principal, se existir.

startTimeUtc

string

A hora de início da tarefa.

status

JobStatus

O estado da tarefa.

statusMessage

string

A mensagem de estado da tarefa.

type

JobType

O tipo de tarefa.

JobStatus

O estado da tarefa.

Name Tipo Description
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

O tipo de tarefa.

Name 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 gerida.

Name Tipo Description
userAssignedIdentity

string

A identidade atribuída pelo utilizador.