Iot Hub Resource - Export Devices

IoT hub kimlik kayıt defterindeki tüm cihaz kimliklerini bir Azure Depolama blob kapsayıcısına aktarır. Daha fazla bilgi için, bkz. 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

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
path True

string

IoT hub'ını içeren kaynak grubunun adı.

resourceName
path True

string

IoT hub'ının adı.

subscriptionId
path True

string

Abonelik tanımlayıcısı.

api-version
query True

string

API'nin sürümü.

İstek Gövdesi

Name Gerekli Tür Description
excludeKeys True

boolean

Anahtarların dışarı aktarma sırasında dışlanıp dışlanmayacağını gösteren değer.

exportBlobContainerUri True

string

Dışarı aktarma blob kapsayıcısı URI'si.

authenticationType

AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

configurationsBlobName

string

Sağlanan çıktı blob kapsayıcısında oluşturulacak blobun adı. Bu blob, IoT Hub için dışarı aktarılan yapılandırmaları içerir.

exportBlobName

string

Sağlanan çıktı blob kapsayıcısında oluşturulacak blobun adı. Bu blob, IoT Hub için dışarı aktarılan cihaz kayıt defteri bilgilerini içerir.

identity

ManagedIdentity

Dışarı aktarma cihazları için depolama uç noktasının yönetilen kimlik özellikleri.

includeConfigurations

boolean

Yapılandırmaların dışarı aktarılıp aktarılmayacağını gösteren değer.

Yanıtlar

Name Tür Description
200 OK

JobResponse

Tamam

Other Status Codes

ErrorDetails

DefaultErrorResponse

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

IotHubResource_ExportDevices

Örnek isteği

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
}

Örnek yanıt

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

Tanımlar

Name Description
AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

ErrorDetails

Hata ayrıntıları.

ExportDevicesRequest

IoT hub'ında tüm cihazların dışarı aktarılmasını istediğinizde parametre sağlamak için kullanın.

JobResponse

İş Yanıtı nesnesinin özellikleri.

JobStatus

İşin durumu.

JobType

İşin türü.

ManagedIdentity

Yönetilen kimliğin özellikleri.

AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

Name Tür Description
identityBased

string

keyBased

string

ErrorDetails

Hata ayrıntıları.

Name Tür Description
code

string

Hata kodu.

details

string

Hata ayrıntıları.

httpStatusCode

string

HTTP durum kodu.

message

string

Hata iletisi.

ExportDevicesRequest

IoT hub'ında tüm cihazların dışarı aktarılmasını istediğinizde parametre sağlamak için kullanın.

Name Tür Description
authenticationType

AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

configurationsBlobName

string

Sağlanan çıktı blob kapsayıcısında oluşturulacak blobun adı. Bu blob, IoT Hub için dışarı aktarılan yapılandırmaları içerir.

excludeKeys

boolean

Anahtarların dışarı aktarma sırasında dışlanıp dışlanmayacağını gösteren değer.

exportBlobContainerUri

string

Dışarı aktarma blob kapsayıcısı URI'si.

exportBlobName

string

Sağlanan çıktı blob kapsayıcısında oluşturulacak blobun adı. Bu blob, IoT Hub için dışarı aktarılan cihaz kayıt defteri bilgilerini içerir.

identity

ManagedIdentity

Dışarı aktarma cihazları için depolama uç noktasının yönetilen kimlik özellikleri.

includeConfigurations

boolean

Yapılandırmaların dışarı aktarılıp aktarılmayacağını gösteren değer.

JobResponse

İş Yanıtı nesnesinin özellikleri.

Name Tür Description
endTimeUtc

string

İşin işlemeyi durdurduğu zaman.

failureReason

string

Durum == başarısız olursa, hatanın nedenini içeren bu dize.

jobId

string

İş tanımlayıcısı.

parentJobId

string

Varsa üst işin iş tanımlayıcısı.

startTimeUtc

string

İşin başlangıç saati.

status

JobStatus

İşin durumu.

statusMessage

string

İşin durum iletisi.

type

JobType

İşin türü.

JobStatus

İşin durumu.

Name Tür Description
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

İşin türü.

Name Tür Description
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string

ManagedIdentity

Yönetilen kimliğin özellikleri.

Name Tür Description
userAssignedIdentity

string

Kullanıcı tarafından atanan kimlik.