Iot Hub Resource - Export Devices

  • Başvuru
Service:
IoT Hub
API Version:
2018-04-01

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=2018-04-01

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.

Yanıtlar

Name Tür Description
200 OK

JobResponse

Tamam
Other Status Codes

ErrorDetails

DefaultErrorResponse

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

Örnekler

IotHubResource_ExportDevices

Sample Request

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

Tanımlar

Name Description
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ü.

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

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