Microsoft.DataBox 作業 2022-10-01

Bicep 資源定義

工作資源類型可以使用目標作業來部署:

有關每個 API 版本中已更改屬性的清單,請參閱 更改紀錄。

資源格式

若要建立 Microsoft.DataBox/jobs 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DataBox/jobs@2022-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    deliveryInfo: {
      scheduledDateTime: 'string'
    }
    deliveryType: 'string'
    details: {
      contactDetails: {
        contactName: 'string'
        emailList: [
          'string'
        ]
        mobile: 'string'
        notificationPreference: [
          {
            sendNotification: bool
            stageName: 'string'
          }
        ]
        phone: 'string'
        phoneExtension: 'string'
      }
      dataExportDetails: [
        {
          accountDetails: {
            sharePassword: 'string'
            dataAccountType: 'string'
            // For remaining properties, see DataAccountDetails objects
          }
          logCollectionLevel: 'string'
          transferConfiguration: {
            transferAllDetails: {
              include: {
                dataAccountType: 'string'
                transferAllBlobs: bool
                transferAllFiles: bool
              }
            }
            transferConfigurationType: 'string'
            transferFilterDetails: {
              include: {
                azureFileFilterDetails: {
                  filePathList: [
                    'string'
                  ]
                  filePrefixList: [
                    'string'
                  ]
                  fileShareList: [
                    'string'
                  ]
                }
                blobFilterDetails: {
                  blobPathList: [
                    'string'
                  ]
                  blobPrefixList: [
                    'string'
                  ]
                  containerList: [
                    'string'
                  ]
                }
                dataAccountType: 'string'
                filterFileDetails: [
                  {
                    filterFilePath: 'string'
                    filterFileType: 'string'
                  }
                ]
              }
            }
          }
        }
      ]
      dataImportDetails: [
        {
          accountDetails: {
            sharePassword: 'string'
            dataAccountType: 'string'
            // For remaining properties, see DataAccountDetails objects
          }
          logCollectionLevel: 'string'
        }
      ]
      expectedDataSizeInTeraBytes: int
      keyEncryptionKey: {
        identityProperties: {
          type: 'string'
          userAssigned: {
            resourceId: 'string'
          }
        }
        kekType: 'string'
        kekUrl: 'string'
        kekVaultResourceID: 'string'
      }
      preferences: {
        encryptionPreferences: {
          doubleEncryption: 'string'
        }
        preferredDataCenterRegion: [
          'string'
        ]
        reverseTransportPreferences: {
          preferredShipmentType: 'string'
        }
        storageAccountAccessTierPreferences: [
          'Archive'
        ]
        transportPreferences: {
          preferredShipmentType: 'string'
        }
      }
      reverseShippingDetails: {
        contactDetails: {
          contactName: 'string'
          mobile: 'string'
          phone: 'string'
          phoneExtension: 'string'
        }
        shippingAddress: {
          addressType: 'string'
          city: 'string'
          companyName: 'string'
          country: 'string'
          postalCode: 'string'
          stateOrProvince: 'string'
          streetAddress1: 'string'
          streetAddress2: 'string'
          streetAddress3: 'string'
          zipExtendedCode: 'string'
        }
      }
      shippingAddress: {
        addressType: 'string'
        city: 'string'
        companyName: 'string'
        country: 'string'
        postalCode: 'string'
        stateOrProvince: 'string'
        streetAddress1: 'string'
        streetAddress2: 'string'
        streetAddress3: 'string'
        zipExtendedCode: 'string'
      }
      jobDetailsType: 'string'
      // For remaining properties, see JobDetails objects
    }
    transferType: 'string'
  }
  sku: {
    displayName: 'string'
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

DataAccountDetails 物件

設定 dataAccountType 屬性 ,以指定物件的類型。

針對 ManagedDisk,請使用:

{
  dataAccountType: 'ManagedDisk'
  resourceGroupId: 'string'
  stagingStorageAccountId: 'string'
}

針對 StorageAccount,請使用:

{
  dataAccountType: 'StorageAccount'
  storageAccountId: 'string'
}

JobDetails 物件

設定 jobDetailsType 屬性,以指定對象的類型。

針對 DataBox,請使用:

{
  devicePassword: 'string'
  jobDetailsType: 'DataBox'
}

針對 DataBoxCustomerDisk,請使用:

{
  enableManifestBackup: bool
  importDiskDetailsCollection: {
    {customized property}: {
      bitLockerKey: 'string'
      manifestFile: 'string'
      manifestHash: 'string'
    }
  }
  jobDetailsType: 'DataBoxCustomerDisk'
  returnToCustomerPackageDetails: {
    carrierAccountNumber: 'string'
    carrierName: 'string'
    trackingId: 'string'
  }
}

針對 DataBoxDisk,請使用:

{
  jobDetailsType: 'DataBoxDisk'
  passkey: 'string'
  preferredDisks: {
    {customized property}: int
  }
}

針對 DataBoxHeavy,請使用:

{
  devicePassword: 'string'
  jobDetailsType: 'DataBoxHeavy'
}

屬性值

Microsoft.DataBox/jobs

Name Description Value
身分識別 資源的 Msi 身分識別 ResourceIdentity
位置 資源的位置。 這將是支援且註冊的 Azure 區域之一(例如美國西部、美國東部、東南亞等)。 建立資源之後,就無法變更資源的區域,但如果在更新要求時指定了相同的區域,要求將會成功。 字串 (必要)
name 資源名稱 string

Constraints:
最小長度 = 3
最大長度 = 24
模式 = ^[-\w\.]+$ (必要)
properties 作業的屬性。 JobProperties (必要)
sku SKU 類型。 Sku (必要)
tags 資源標籤 標記名稱和值的字典。 請參考模板中的標籤

AzureFileFilterDetails

Name Description Value
filePathList 要傳輸之檔案的完整路徑清單。 string[]
filePrefixList 要轉移的 Azure files 前綴列表。 string[]
fileShareList 要傳輸的檔案共享清單。 string[]

BlobFilterDetails

Name Description Value
blobPathList 要傳輸之 Blob 的完整路徑清單。 string[]
blobPrefixList 要轉移的 Azure blobs 前綴列表。 string[]
containerList 要傳送的 Blob 容器清單。 string[]

ContactDetails

Name Description Value
contactName 聯繫人的聯繫人名稱。 字串 (必要)
emailList 要通知作業進度的電子郵件標識碼清單。 string[] (必要)
行動 聯繫人的行動電話號碼。 字串
notificationPreference 作業階段的通知喜好設定。 NotificationPreference[]
phone 聯繫人的電話號碼。 字串 (必要)
phoneExtension 聯繫人的電話號碼。 字串

ContactInfo

Name Description Value
contactName 聯繫人的聯繫人名稱。 string

Constraints:
最小長度 = 1 (必要)
行動 聯繫人的行動電話號碼。 字串
phone 聯繫人的電話號碼。 string

Constraints:
最小長度 = 1 (必要)
phoneExtension 聯繫人的電話號碼。 字串

DataAccountDetails

Name Description Value
dataAccountType 針對 managedDiskDetails 類型設定為 'ManagedDisk',。 針對 storageAccountDetails類型 設定為 『StorageAccount』。 'ManagedDisk'
'StorageAccount' (必要)
sharePassword 在裝置上建立之所有共享的密碼。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ string

Constraints:
敏感值。 以安全參數的形式傳入。

DataBoxCustomerDiskJobDetails

Name Description Value
enableManifestBackup 標記以指示磁碟清單是否應該備份在 Storage 帳戶中。 bool
importDiskDetailsCollection 包含磁碟序號對應至匯入作業的磁碟詳細數據。 DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection
jobDetailsType 指出作業詳細數據的類型。 “DataBoxCustomerDisk”(必需)
returnToCustomerPackageDetails 傳回包裹寄送詳細數據。 PackageCarrierDetails (必填)

DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection

Name Description Value

DataBoxDiskJobDetails

Name Description Value
jobDetailsType 指出作業詳細數據的類型。 'DataBoxDisk' (必要)
密鑰 使用者輸入 DataBox 磁碟作業的通行金鑰。 字串
preferredDisks 用戶喜好設定作業所需的磁碟大小。 對應是從 TB 到計數的磁碟大小。 Eg. {2,5} 表示 5 個 2 TB 大小的磁碟。 索引鍵是字串,但會針對 int 檢查。 DataBoxDiskJobDetailsPreferredDisks

DataBoxDiskJobDetailsPreferredDisks

Name Description Value

DataBoxHeavyJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox Heavy。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBoxHeavy' (必要)

DataBoxJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBox' (必要)

DataExportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'
transferConfiguration 數據傳輸的設定。 TransferConfiguration (必要)

DataImportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'

EncryptionPreferences

Name Description Value
doubleEncryption 定義軟體型加密啟用的第二層。 'Disabled'
'Enabled'

FilterFileDetails

Name Description Value
filterFilePath 檔案的路徑,其中包含要傳輸之所有專案的詳細數據。 字串 (必要)
filterFileType 篩選檔案的類型。 'AzureBlob'
'AzureFile' (必要)

IdentityProperties

Name Description Value
型別 受控服務識別類型。 字串
userAssigned 使用者指派的身分識別屬性。 UserAssignedProperties

ImportDiskDetails

Name Description Value
bitLockerKey 用來加密磁碟的 BitLocker 金鑰。 string

Constraints:
敏感值。 以安全參數的形式傳入。 (required)
manifestFile 磁碟上指令清單檔的相對路徑。 字串 (必要)
manifestHash 磁碟上指令清單檔案的Base16編碼 MD5 哈希。 字串 (必要)

JobDeliveryInfo

Name Description Value
scheduledDateTime 排程的日期時間。 字串

JobDetails

Name Description Value
contactDetails 通知和寄送的連絡詳細數據。 ContactDetails (必要)
dataExportDetails 從 azure 匯出資料的詳細資訊。 DataExportDetails[]
dataImportDetails 要匯入到 azure 的資料細節。 DataImportDetails[]
expectedDataSizeInTeraBytes 此作業中需要以 TB 為單位傳輸的數據預期大小。 int
jobDetailsType 針對 dataBoxJobDetails 類型設定為 'DataBox',。 設定為 'DataBoxCustomerDisk' 類型 DataBoxCustomerDiskJobDetails。 針對 dataBoxDiskJobDetails 類型設定為 'DataBoxDisk',。 針對 dataBoxHeavy DataBoxHeavyJobDetails類型,設定為 'DataBoxHeavy'。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)
keyEncryptionKey 使用哪個金鑰加密類型的詳細資料。 KeyEncryptionKey
preferences 訂單的喜好設定。 Preferences
reverseShippingDetails 訂單的選擇性反向出貨詳細數據。 ReverseShippingDetails
shippingAddress 客戶的寄送位址。 ShippingAddress

JobProperties

Name Description Value
deliveryInfo 作業的傳遞資訊。 JobDeliveryInfo
deliveryType 作業的傳遞類型。 'NonScheduled'
'Scheduled'
details 作業執行的詳細數據。 此欄位只會傳送以用於展開詳細數據篩選。 JobDetails
transferType 數據傳輸的類型。 'ExportFromAzure'
'ImportToAzure' (必要)

KeyEncryptionKey

Name Description Value
identityProperties 用於金鑰加密的受控識別屬性。 IdentityProperties
kekType 用於金鑰加密的加密金鑰類型。 'CustomerManaged'
'MicrosoftManaged' (必要)
kekUrl 金鑰加密金鑰。 如果是客戶管理的 KekType,則為必要專案。 字串
kekVaultResourceID Kek 保存庫資源標識碼。如果是客戶管理的 KekType,則為必要專案。 字串

ManagedDiskDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'ManagedDisk' (必要)
resourceGroupId 計算磁碟的資源群組標識碼。 字串 (必要)
stagingStorageAccountId 可以用來複製 VHD 進行暫存的 storage 帳號的 Resource ID。 字串 (必要)

NotificationPreference

Name Description Value
sendNotification 需要通知或不需要。 布林 (必要)
stageName 階段的名稱。 'AtAzureDC'
'Created'
'DataCopy'
'Delivered'
'DevicePrepared'
'Dispatched'
'PickedUp'
“ShippedToCustomer”(必填)

PackageCarrierDetails

Name Description Value
carrierAccountNumber 客戶磁碟的電信業者帳戶號碼。 string

Constraints:
敏感值。 以安全參數的形式傳入。
carrierName 電信業者的名稱。 字串
trackingId 追蹤出貨的標識碼。 字串

Preferences

Name Description Value
encryptionPreferences 與加密相關的喜好設定。 EncryptionPreferences
preferredDataCenterRegion 慣用的數據中心區域。 string[]
reverseTransportPreferences 與 SKU 反向出貨物流相關的選擇性喜好設定。 TransportPreferences
storageAccountAccessTierPreferences 與 storage 帳號 Access 層級相關的偏好設定。 'Archive'[]
transportPreferences 與 SKU 的出貨物流相關的喜好設定。 TransportPreferences

ResourceIdentity

Name Description Value
型別 身分類型 字串
userAssignedIdentities 使用者指派的身分識別 ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

ResourceTags

Name Description Value

ReverseShippingDetails

Name Description Value
contactDetails 連絡資訊。 ContactInfo
shippingAddress 客戶想要接收裝置的寄送位址。 ShippingAddress

ShippingAddress

Name Description Value
addressType 位址的類型。 'Commercial'
'None'
'Residential'
city City 的名稱。 字串
companyName 公司名稱。 字串
country 國家/地區名稱。 字串 (必要)
postalCode 郵遞區號。 字串
stateOrProvince 州或省的名稱。 字串
streetAddress1 街道地址行 1。 字串 (必要)
streetAddress2 街道地址行 2。 字串
streetAddress3 街道地址行 3。 字串
zipExtendedCode 延伸郵遞區號。 字串

Sku

Name Description Value
displayName SKU 的顯示名稱。 字串
family SKU 系列。 字串
name SKU 名稱。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)

StorageAccountDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'StorageAccount' (必要)
storageAccountId Storage Account 資源 ID。 字串 (必要)

TransferAllDetails

Name Description Value
dataAccountType 數據的帳戶類型 'ManagedDisk'
'StorageAccount' (必要)
transferAllBlobs 用來表示所有 Azure 的 blobs 是否都必須轉移 bool
transferAllFiles 用來表示是否所有 Azure 檔案儲存體 都必須轉移 bool

TransferConfiguration

Name Description Value
transferAllDetails 篩選類型和詳細數據的對應,以傳輸所有數據。 只有在 TransferConfigurationType 指定為 TransferAll 時,才需要此字段 TransferConfigurationTransferAllDetails
transferConfigurationType 要傳輸的組態類型。 'TransferAll'
'TransferUsingFilter' (必要)
transferFilterDetails 篩選類型和要篩選的詳細數據對應。 只有在 TransferConfigurationType 指定為 TransferUsingFilter 時,才需要此字段。 TransferConfigurationTransferFilterDetails

TransferConfigurationTransferAllDetails

Name Description Value
include 傳輸所有數據的詳細數據。 TransferAllDetails

TransferConfigurationTransferFilterDetails

Name Description Value
include 篩選數據傳輸的詳細數據。 TransferFilterDetails

TransferFilterDetails

Name Description Value
azureFileFilterDetails 篩選細節以傳輸 Azure 檔案。 AzureFileFilterDetails
blobFilterDetails 篩選詳細數據以傳輸 Blob。 BlobFilterDetails
dataAccountType 數據的帳戶類型。 'ManagedDisk'
'StorageAccount' (必要)
filterFileDetails 要用於數據傳輸之篩選檔案的詳細數據。 FilterFileDetails[]

TransportPreferences

Name Description Value
preferredShipmentType 指出客戶慣用的出貨物流類型。 'CustomerManaged'
'MicrosoftManaged' (必要)

UserAssignedIdentity

Name Description Value

UserAssignedProperties

Name Description Value
resourceId 要用來擷取 MSI 令牌之使用者指派身分識別的 Arm 資源識別碼。 字串

ARM 樣本資源定義

工作資源類型可以使用目標作業來部署:

使用範例

資源格式

若要建立 Microsoft.DataBox/jobs 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DataBox/jobs",
  "apiVersion": "2022-10-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "deliveryInfo": {
      "scheduledDateTime": "string"
    },
    "deliveryType": "string",
    "details": {
      "contactDetails": {
        "contactName": "string",
        "emailList": [ "string" ],
        "mobile": "string",
        "notificationPreference": [
          {
            "sendNotification": "bool",
            "stageName": "string"
          }
        ],
        "phone": "string",
        "phoneExtension": "string"
      },
      "dataExportDetails": [
        {
          "accountDetails": {
            "sharePassword": "string",
            "dataAccountType": "string"
            // For remaining properties, see DataAccountDetails objects
          },
          "logCollectionLevel": "string",
          "transferConfiguration": {
            "transferAllDetails": {
              "include": {
                "dataAccountType": "string",
                "transferAllBlobs": "bool",
                "transferAllFiles": "bool"
              }
            },
            "transferConfigurationType": "string",
            "transferFilterDetails": {
              "include": {
                "azureFileFilterDetails": {
                  "filePathList": [ "string" ],
                  "filePrefixList": [ "string" ],
                  "fileShareList": [ "string" ]
                },
                "blobFilterDetails": {
                  "blobPathList": [ "string" ],
                  "blobPrefixList": [ "string" ],
                  "containerList": [ "string" ]
                },
                "dataAccountType": "string",
                "filterFileDetails": [
                  {
                    "filterFilePath": "string",
                    "filterFileType": "string"
                  }
                ]
              }
            }
          }
        }
      ],
      "dataImportDetails": [
        {
          "accountDetails": {
            "sharePassword": "string",
            "dataAccountType": "string"
            // For remaining properties, see DataAccountDetails objects
          },
          "logCollectionLevel": "string"
        }
      ],
      "expectedDataSizeInTeraBytes": "int",
      "keyEncryptionKey": {
        "identityProperties": {
          "type": "string",
          "userAssigned": {
            "resourceId": "string"
          }
        },
        "kekType": "string",
        "kekUrl": "string",
        "kekVaultResourceID": "string"
      },
      "preferences": {
        "encryptionPreferences": {
          "doubleEncryption": "string"
        },
        "preferredDataCenterRegion": [ "string" ],
        "reverseTransportPreferences": {
          "preferredShipmentType": "string"
        },
        "storageAccountAccessTierPreferences": [ "Archive" ],
        "transportPreferences": {
          "preferredShipmentType": "string"
        }
      },
      "reverseShippingDetails": {
        "contactDetails": {
          "contactName": "string",
          "mobile": "string",
          "phone": "string",
          "phoneExtension": "string"
        },
        "shippingAddress": {
          "addressType": "string",
          "city": "string",
          "companyName": "string",
          "country": "string",
          "postalCode": "string",
          "stateOrProvince": "string",
          "streetAddress1": "string",
          "streetAddress2": "string",
          "streetAddress3": "string",
          "zipExtendedCode": "string"
        }
      },
      "shippingAddress": {
        "addressType": "string",
        "city": "string",
        "companyName": "string",
        "country": "string",
        "postalCode": "string",
        "stateOrProvince": "string",
        "streetAddress1": "string",
        "streetAddress2": "string",
        "streetAddress3": "string",
        "zipExtendedCode": "string"
      },
      "jobDetailsType": "string"
      // For remaining properties, see JobDetails objects
    },
    "transferType": "string"
  },
  "sku": {
    "displayName": "string",
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

DataAccountDetails 物件

設定 dataAccountType 屬性 ,以指定物件的類型。

針對 ManagedDisk,請使用:

{
  "dataAccountType": "ManagedDisk",
  "resourceGroupId": "string",
  "stagingStorageAccountId": "string"
}

針對 StorageAccount,請使用:

{
  "dataAccountType": "StorageAccount",
  "storageAccountId": "string"
}

JobDetails 物件

設定 jobDetailsType 屬性,以指定對象的類型。

針對 DataBox,請使用:

{
  "devicePassword": "string",
  "jobDetailsType": "DataBox"
}

針對 DataBoxCustomerDisk,請使用:

{
  "enableManifestBackup": "bool",
  "importDiskDetailsCollection": {
    "{customized property}": {
      "bitLockerKey": "string",
      "manifestFile": "string",
      "manifestHash": "string"
    }
  },
  "jobDetailsType": "DataBoxCustomerDisk",
  "returnToCustomerPackageDetails": {
    "carrierAccountNumber": "string",
    "carrierName": "string",
    "trackingId": "string"
  }
}

針對 DataBoxDisk,請使用:

{
  "jobDetailsType": "DataBoxDisk",
  "passkey": "string",
  "preferredDisks": {
    "{customized property}": "int"
  }
}

針對 DataBoxHeavy,請使用:

{
  "devicePassword": "string",
  "jobDetailsType": "DataBoxHeavy"
}

屬性值

Microsoft.DataBox/jobs

Name Description Value
apiVersion API 版本 '2022-10-01'
身分識別 資源的 Msi 身分識別 ResourceIdentity
位置 資源的位置。 這將是支援且註冊的 Azure 區域之一(例如美國西部、美國東部、東南亞等)。 建立資源之後,就無法變更資源的區域,但如果在更新要求時指定了相同的區域,要求將會成功。 字串 (必要)
name 資源名稱 string

Constraints:
最小長度 = 3
最大長度 = 24
模式 = ^[-\w\.]+$ (必要)
properties 作業的屬性。 JobProperties (必要)
sku SKU 類型。 Sku (必要)
tags 資源標籤 標記名稱和值的字典。 請參考模板中的標籤
型別 資源類型 'Microsoft.DataBox/jobs'

AzureFileFilterDetails

Name Description Value
filePathList 要傳輸之檔案的完整路徑清單。 string[]
filePrefixList 要轉移的 Azure files 前綴列表。 string[]
fileShareList 要傳輸的檔案共享清單。 string[]

BlobFilterDetails

Name Description Value
blobPathList 要傳輸之 Blob 的完整路徑清單。 string[]
blobPrefixList 要轉移的 Azure blobs 前綴列表。 string[]
containerList 要傳送的 Blob 容器清單。 string[]

ContactDetails

Name Description Value
contactName 聯繫人的聯繫人名稱。 字串 (必要)
emailList 要通知作業進度的電子郵件標識碼清單。 string[] (必要)
行動 聯繫人的行動電話號碼。 字串
notificationPreference 作業階段的通知喜好設定。 NotificationPreference[]
phone 聯繫人的電話號碼。 字串 (必要)
phoneExtension 聯繫人的電話號碼。 字串

ContactInfo

Name Description Value
contactName 聯繫人的聯繫人名稱。 string

Constraints:
最小長度 = 1 (必要)
行動 聯繫人的行動電話號碼。 字串
phone 聯繫人的電話號碼。 string

Constraints:
最小長度 = 1 (必要)
phoneExtension 聯繫人的電話號碼。 字串

DataAccountDetails

Name Description Value
dataAccountType 針對 managedDiskDetails 類型設定為 'ManagedDisk',。 針對 storageAccountDetails類型 設定為 『StorageAccount』。 'ManagedDisk'
'StorageAccount' (必要)
sharePassword 在裝置上建立之所有共享的密碼。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ string

Constraints:
敏感值。 以安全參數的形式傳入。

DataBoxCustomerDiskJobDetails

Name Description Value
enableManifestBackup 標記以指示磁碟清單是否應該備份在 Storage 帳戶中。 bool
importDiskDetailsCollection 包含磁碟序號對應至匯入作業的磁碟詳細數據。 DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection
jobDetailsType 指出作業詳細數據的類型。 “DataBoxCustomerDisk”(必需)
returnToCustomerPackageDetails 傳回包裹寄送詳細數據。 PackageCarrierDetails (必填)

DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection

Name Description Value

DataBoxDiskJobDetails

Name Description Value
jobDetailsType 指出作業詳細數據的類型。 'DataBoxDisk' (必要)
密鑰 使用者輸入 DataBox 磁碟作業的通行金鑰。 字串
preferredDisks 用戶喜好設定作業所需的磁碟大小。 對應是從 TB 到計數的磁碟大小。 Eg. {2,5} 表示 5 個 2 TB 大小的磁碟。 索引鍵是字串,但會針對 int 檢查。 DataBoxDiskJobDetailsPreferredDisks

DataBoxDiskJobDetailsPreferredDisks

Name Description Value

DataBoxHeavyJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox Heavy。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBoxHeavy' (必要)

DataBoxJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBox' (必要)

DataExportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'
transferConfiguration 數據傳輸的設定。 TransferConfiguration (必要)

DataImportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'

EncryptionPreferences

Name Description Value
doubleEncryption 定義軟體型加密啟用的第二層。 'Disabled'
'Enabled'

FilterFileDetails

Name Description Value
filterFilePath 檔案的路徑,其中包含要傳輸之所有專案的詳細數據。 字串 (必要)
filterFileType 篩選檔案的類型。 'AzureBlob'
'AzureFile' (必要)

IdentityProperties

Name Description Value
型別 受控服務識別類型。 字串
userAssigned 使用者指派的身分識別屬性。 UserAssignedProperties

ImportDiskDetails

Name Description Value
bitLockerKey 用來加密磁碟的 BitLocker 金鑰。 string

Constraints:
敏感值。 以安全參數的形式傳入。 (required)
manifestFile 磁碟上指令清單檔的相對路徑。 字串 (必要)
manifestHash 磁碟上指令清單檔案的Base16編碼 MD5 哈希。 字串 (必要)

JobDeliveryInfo

Name Description Value
scheduledDateTime 排程的日期時間。 字串

JobDetails

Name Description Value
contactDetails 通知和寄送的連絡詳細數據。 ContactDetails (必要)
dataExportDetails 從 azure 匯出資料的詳細資訊。 DataExportDetails[]
dataImportDetails 要匯入到 azure 的資料細節。 DataImportDetails[]
expectedDataSizeInTeraBytes 此作業中需要以 TB 為單位傳輸的數據預期大小。 int
jobDetailsType 針對 dataBoxJobDetails 類型設定為 'DataBox',。 設定為 'DataBoxCustomerDisk' 類型 DataBoxCustomerDiskJobDetails。 針對 dataBoxDiskJobDetails 類型設定為 'DataBoxDisk',。 針對 dataBoxHeavy DataBoxHeavyJobDetails類型,設定為 'DataBoxHeavy'。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)
keyEncryptionKey 使用哪個金鑰加密類型的詳細資料。 KeyEncryptionKey
preferences 訂單的喜好設定。 Preferences
reverseShippingDetails 訂單的選擇性反向出貨詳細數據。 ReverseShippingDetails
shippingAddress 客戶的寄送位址。 ShippingAddress

JobProperties

Name Description Value
deliveryInfo 作業的傳遞資訊。 JobDeliveryInfo
deliveryType 作業的傳遞類型。 'NonScheduled'
'Scheduled'
details 作業執行的詳細數據。 此欄位只會傳送以用於展開詳細數據篩選。 JobDetails
transferType 數據傳輸的類型。 'ExportFromAzure'
'ImportToAzure' (必要)

KeyEncryptionKey

Name Description Value
identityProperties 用於金鑰加密的受控識別屬性。 IdentityProperties
kekType 用於金鑰加密的加密金鑰類型。 'CustomerManaged'
'MicrosoftManaged' (必要)
kekUrl 金鑰加密金鑰。 如果是客戶管理的 KekType,則為必要專案。 字串
kekVaultResourceID Kek 保存庫資源標識碼。如果是客戶管理的 KekType,則為必要專案。 字串

ManagedDiskDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'ManagedDisk' (必要)
resourceGroupId 計算磁碟的資源群組標識碼。 字串 (必要)
stagingStorageAccountId 可以用來複製 VHD 進行暫存的 storage 帳號的 Resource ID。 字串 (必要)

NotificationPreference

Name Description Value
sendNotification 需要通知或不需要。 布林 (必要)
stageName 階段的名稱。 'AtAzureDC'
'Created'
'DataCopy'
'Delivered'
'DevicePrepared'
'Dispatched'
'PickedUp'
“ShippedToCustomer”(必填)

PackageCarrierDetails

Name Description Value
carrierAccountNumber 客戶磁碟的電信業者帳戶號碼。 string

Constraints:
敏感值。 以安全參數的形式傳入。
carrierName 電信業者的名稱。 字串
trackingId 追蹤出貨的標識碼。 字串

Preferences

Name Description Value
encryptionPreferences 與加密相關的喜好設定。 EncryptionPreferences
preferredDataCenterRegion 慣用的數據中心區域。 string[]
reverseTransportPreferences 與 SKU 反向出貨物流相關的選擇性喜好設定。 TransportPreferences
storageAccountAccessTierPreferences 與 storage 帳號 Access 層級相關的偏好設定。 'Archive'[]
transportPreferences 與 SKU 的出貨物流相關的喜好設定。 TransportPreferences

ResourceIdentity

Name Description Value
型別 身分類型 字串
userAssignedIdentities 使用者指派的身分識別 ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

ResourceTags

Name Description Value

ReverseShippingDetails

Name Description Value
contactDetails 連絡資訊。 ContactInfo
shippingAddress 客戶想要接收裝置的寄送位址。 ShippingAddress

ShippingAddress

Name Description Value
addressType 位址的類型。 'Commercial'
'None'
'Residential'
city City 的名稱。 字串
companyName 公司名稱。 字串
country 國家/地區名稱。 字串 (必要)
postalCode 郵遞區號。 字串
stateOrProvince 州或省的名稱。 字串
streetAddress1 街道地址行 1。 字串 (必要)
streetAddress2 街道地址行 2。 字串
streetAddress3 街道地址行 3。 字串
zipExtendedCode 延伸郵遞區號。 字串

Sku

Name Description Value
displayName SKU 的顯示名稱。 字串
family SKU 系列。 字串
name SKU 名稱。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)

StorageAccountDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'StorageAccount' (必要)
storageAccountId Storage Account 資源 ID。 字串 (必要)

TransferAllDetails

Name Description Value
dataAccountType 數據的帳戶類型 'ManagedDisk'
'StorageAccount' (必要)
transferAllBlobs 用來表示所有 Azure 的 blobs 是否都必須轉移 bool
transferAllFiles 用來表示是否所有 Azure 檔案儲存體 都必須轉移 bool

TransferConfiguration

Name Description Value
transferAllDetails 篩選類型和詳細數據的對應,以傳輸所有數據。 只有在 TransferConfigurationType 指定為 TransferAll 時,才需要此字段 TransferConfigurationTransferAllDetails
transferConfigurationType 要傳輸的組態類型。 'TransferAll'
'TransferUsingFilter' (必要)
transferFilterDetails 篩選類型和要篩選的詳細數據對應。 只有在 TransferConfigurationType 指定為 TransferUsingFilter 時,才需要此字段。 TransferConfigurationTransferFilterDetails

TransferConfigurationTransferAllDetails

Name Description Value
include 傳輸所有數據的詳細數據。 TransferAllDetails

TransferConfigurationTransferFilterDetails

Name Description Value
include 篩選數據傳輸的詳細數據。 TransferFilterDetails

TransferFilterDetails

Name Description Value
azureFileFilterDetails 篩選細節以傳輸 Azure 檔案。 AzureFileFilterDetails
blobFilterDetails 篩選詳細數據以傳輸 Blob。 BlobFilterDetails
dataAccountType 數據的帳戶類型。 'ManagedDisk'
'StorageAccount' (必要)
filterFileDetails 要用於數據傳輸之篩選檔案的詳細數據。 FilterFileDetails[]

TransportPreferences

Name Description Value
preferredShipmentType 指出客戶慣用的出貨物流類型。 'CustomerManaged'
'MicrosoftManaged' (必要)

UserAssignedIdentity

Name Description Value

UserAssignedProperties

Name Description Value
resourceId 要用來擷取 MSI 令牌之使用者指派身分識別的 Arm 資源識別碼。 字串

Terraform (AzAPI 提供者) 資源定義

工作資源類型可以使用目標作業來部署:

  • 資源團體 關於每個 API 版本變更屬性的清單,請參見 變更日誌。

資源格式

若要建立 Microsoft.DataBox/jobs 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBox/jobs@2022-10-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      deliveryInfo = {
        scheduledDateTime = "string"
      }
      deliveryType = "string"
      details = {
        contactDetails = {
          contactName = "string"
          emailList = [
            "string"
          ]
          mobile = "string"
          notificationPreference = [
            {
              sendNotification = bool
              stageName = "string"
            }
          ]
          phone = "string"
          phoneExtension = "string"
        }
        dataExportDetails = [
          {
            accountDetails = {
              sharePassword = "string"
              dataAccountType = "string"
              // For remaining properties, see DataAccountDetails objects
            }
            logCollectionLevel = "string"
            transferConfiguration = {
              transferAllDetails = {
                include = {
                  dataAccountType = "string"
                  transferAllBlobs = bool
                  transferAllFiles = bool
                }
              }
              transferConfigurationType = "string"
              transferFilterDetails = {
                include = {
                  azureFileFilterDetails = {
                    filePathList = [
                      "string"
                    ]
                    filePrefixList = [
                      "string"
                    ]
                    fileShareList = [
                      "string"
                    ]
                  }
                  blobFilterDetails = {
                    blobPathList = [
                      "string"
                    ]
                    blobPrefixList = [
                      "string"
                    ]
                    containerList = [
                      "string"
                    ]
                  }
                  dataAccountType = "string"
                  filterFileDetails = [
                    {
                      filterFilePath = "string"
                      filterFileType = "string"
                    }
                  ]
                }
              }
            }
          }
        ]
        dataImportDetails = [
          {
            accountDetails = {
              sharePassword = "string"
              dataAccountType = "string"
              // For remaining properties, see DataAccountDetails objects
            }
            logCollectionLevel = "string"
          }
        ]
        expectedDataSizeInTeraBytes = int
        keyEncryptionKey = {
          identityProperties = {
            type = "string"
            userAssigned = {
              resourceId = "string"
            }
          }
          kekType = "string"
          kekUrl = "string"
          kekVaultResourceID = "string"
        }
        preferences = {
          encryptionPreferences = {
            doubleEncryption = "string"
          }
          preferredDataCenterRegion = [
            "string"
          ]
          reverseTransportPreferences = {
            preferredShipmentType = "string"
          }
          storageAccountAccessTierPreferences = [
            "Archive"
          ]
          transportPreferences = {
            preferredShipmentType = "string"
          }
        }
        reverseShippingDetails = {
          contactDetails = {
            contactName = "string"
            mobile = "string"
            phone = "string"
            phoneExtension = "string"
          }
          shippingAddress = {
            addressType = "string"
            city = "string"
            companyName = "string"
            country = "string"
            postalCode = "string"
            stateOrProvince = "string"
            streetAddress1 = "string"
            streetAddress2 = "string"
            streetAddress3 = "string"
            zipExtendedCode = "string"
          }
        }
        shippingAddress = {
          addressType = "string"
          city = "string"
          companyName = "string"
          country = "string"
          postalCode = "string"
          stateOrProvince = "string"
          streetAddress1 = "string"
          streetAddress2 = "string"
          streetAddress3 = "string"
          zipExtendedCode = "string"
        }
        jobDetailsType = "string"
        // For remaining properties, see JobDetails objects
      }
      transferType = "string"
    }
    sku = {
      displayName = "string"
      family = "string"
      name = "string"
    }
  }
}

DataAccountDetails 物件

設定 dataAccountType 屬性 ,以指定物件的類型。

針對 ManagedDisk,請使用:

{
  dataAccountType = "ManagedDisk"
  resourceGroupId = "string"
  stagingStorageAccountId = "string"
}

針對 StorageAccount,請使用:

{
  dataAccountType = "StorageAccount"
  storageAccountId = "string"
}

JobDetails 物件

設定 jobDetailsType 屬性,以指定對象的類型。

針對 DataBox,請使用:

{
  devicePassword = "string"
  jobDetailsType = "DataBox"
}

針對 DataBoxCustomerDisk,請使用:

{
  enableManifestBackup = bool
  importDiskDetailsCollection = {
    {customized property} = {
      bitLockerKey = "string"
      manifestFile = "string"
      manifestHash = "string"
    }
  }
  jobDetailsType = "DataBoxCustomerDisk"
  returnToCustomerPackageDetails = {
    carrierAccountNumber = "string"
    carrierName = "string"
    trackingId = "string"
  }
}

針對 DataBoxDisk,請使用:

{
  jobDetailsType = "DataBoxDisk"
  passkey = "string"
  preferredDisks = {
    {customized property} = int
  }
}

針對 DataBoxHeavy,請使用:

{
  devicePassword = "string"
  jobDetailsType = "DataBoxHeavy"
}

屬性值

Microsoft.DataBox/jobs

Name Description Value
身分識別 資源的 Msi 身分識別 ResourceIdentity
位置 資源的位置。 這將是支援且註冊的 Azure 區域之一(例如美國西部、美國東部、東南亞等)。 建立資源之後,就無法變更資源的區域,但如果在更新要求時指定了相同的區域,要求將會成功。 字串 (必要)
name 資源名稱 string

Constraints:
最小長度 = 3
最大長度 = 24
模式 = ^[-\w\.]+$ (必要)
properties 作業的屬性。 JobProperties (必要)
sku SKU 類型。 Sku (必要)
tags 資源標籤 標記名稱和值的字典。
型別 資源類型 "Microsoft.DataBox/jobs@2022-10-01"

AzureFileFilterDetails

Name Description Value
filePathList 要傳輸之檔案的完整路徑清單。 string[]
filePrefixList 要轉移的 Azure files 前綴列表。 string[]
fileShareList 要傳輸的檔案共享清單。 string[]

BlobFilterDetails

Name Description Value
blobPathList 要傳輸之 Blob 的完整路徑清單。 string[]
blobPrefixList 要轉移的 Azure blobs 前綴列表。 string[]
containerList 要傳送的 Blob 容器清單。 string[]

ContactDetails

Name Description Value
contactName 聯繫人的聯繫人名稱。 字串 (必要)
emailList 要通知作業進度的電子郵件標識碼清單。 string[] (必要)
行動 聯繫人的行動電話號碼。 字串
notificationPreference 作業階段的通知喜好設定。 NotificationPreference[]
phone 聯繫人的電話號碼。 字串 (必要)
phoneExtension 聯繫人的電話號碼。 字串

ContactInfo

Name Description Value
contactName 聯繫人的聯繫人名稱。 string

Constraints:
最小長度 = 1 (必要)
行動 聯繫人的行動電話號碼。 字串
phone 聯繫人的電話號碼。 string

Constraints:
最小長度 = 1 (必要)
phoneExtension 聯繫人的電話號碼。 字串

DataAccountDetails

Name Description Value
dataAccountType 針對 managedDiskDetails 類型設定為 'ManagedDisk',。 針對 storageAccountDetails類型 設定為 『StorageAccount』。 'ManagedDisk'
'StorageAccount' (必要)
sharePassword 在裝置上建立之所有共享的密碼。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ string

Constraints:
敏感值。 以安全參數的形式傳入。

DataBoxCustomerDiskJobDetails

Name Description Value
enableManifestBackup 標記以指示磁碟清單是否應該備份在 Storage 帳戶中。 bool
importDiskDetailsCollection 包含磁碟序號對應至匯入作業的磁碟詳細數據。 DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection
jobDetailsType 指出作業詳細數據的類型。 “DataBoxCustomerDisk”(必需)
returnToCustomerPackageDetails 傳回包裹寄送詳細數據。 PackageCarrierDetails (必填)

DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection

Name Description Value

DataBoxDiskJobDetails

Name Description Value
jobDetailsType 指出作業詳細數據的類型。 'DataBoxDisk' (必要)
密鑰 使用者輸入 DataBox 磁碟作業的通行金鑰。 字串
preferredDisks 用戶喜好設定作業所需的磁碟大小。 對應是從 TB 到計數的磁碟大小。 Eg. {2,5} 表示 5 個 2 TB 大小的磁碟。 索引鍵是字串,但會針對 int 檢查。 DataBoxDiskJobDetailsPreferredDisks

DataBoxDiskJobDetailsPreferredDisks

Name Description Value

DataBoxHeavyJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox Heavy。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBoxHeavy' (必要)

DataBoxJobDetails

Name Description Value
devicePassword 設定 [裝置密碼] 以解除鎖定 Databox。 不應該針對 TransferType:ExportFromAzure 作業傳遞。 如果未傳遞此項目,服務將會產生密碼本身。 這不會在取得通話中傳回。 密碼需求:密碼必須至少為12個字元,最多64個字元。 密碼必須至少有一個大寫字母、一個數位和一個特殊字元。 密碼不能有下列字元:IilLoO0 密碼只能有字母、數字和這些字元: @#-$%^!+=;:_()]+ 字串
jobDetailsType 指出作業詳細數據的類型。 'DataBox' (必要)

DataExportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'
transferConfiguration 數據傳輸的設定。 TransferConfiguration (必要)

DataImportDetails

Name Description Value
accountDetails 要傳輸之數據的帳戶詳細數據 DataAccountDetails (必要)
logCollectionLevel 要收集的記錄層級。 'Error'
'Verbose'

EncryptionPreferences

Name Description Value
doubleEncryption 定義軟體型加密啟用的第二層。 'Disabled'
'Enabled'

FilterFileDetails

Name Description Value
filterFilePath 檔案的路徑,其中包含要傳輸之所有專案的詳細數據。 字串 (必要)
filterFileType 篩選檔案的類型。 'AzureBlob'
'AzureFile' (必要)

IdentityProperties

Name Description Value
型別 受控服務識別類型。 字串
userAssigned 使用者指派的身分識別屬性。 UserAssignedProperties

ImportDiskDetails

Name Description Value
bitLockerKey 用來加密磁碟的 BitLocker 金鑰。 string

Constraints:
敏感值。 以安全參數的形式傳入。 (required)
manifestFile 磁碟上指令清單檔的相對路徑。 字串 (必要)
manifestHash 磁碟上指令清單檔案的Base16編碼 MD5 哈希。 字串 (必要)

JobDeliveryInfo

Name Description Value
scheduledDateTime 排程的日期時間。 字串

JobDetails

Name Description Value
contactDetails 通知和寄送的連絡詳細數據。 ContactDetails (必要)
dataExportDetails 從 azure 匯出資料的詳細資訊。 DataExportDetails[]
dataImportDetails 要匯入到 azure 的資料細節。 DataImportDetails[]
expectedDataSizeInTeraBytes 此作業中需要以 TB 為單位傳輸的數據預期大小。 int
jobDetailsType 針對 dataBoxJobDetails 類型設定為 'DataBox',。 設定為 'DataBoxCustomerDisk' 類型 DataBoxCustomerDiskJobDetails。 針對 dataBoxDiskJobDetails 類型設定為 'DataBoxDisk',。 針對 dataBoxHeavy DataBoxHeavyJobDetails類型,設定為 'DataBoxHeavy'。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)
keyEncryptionKey 使用哪個金鑰加密類型的詳細資料。 KeyEncryptionKey
preferences 訂單的喜好設定。 Preferences
reverseShippingDetails 訂單的選擇性反向出貨詳細數據。 ReverseShippingDetails
shippingAddress 客戶的寄送位址。 ShippingAddress

JobProperties

Name Description Value
deliveryInfo 作業的傳遞資訊。 JobDeliveryInfo
deliveryType 作業的傳遞類型。 'NonScheduled'
'Scheduled'
details 作業執行的詳細數據。 此欄位只會傳送以用於展開詳細數據篩選。 JobDetails
transferType 數據傳輸的類型。 'ExportFromAzure'
'ImportToAzure' (必要)

KeyEncryptionKey

Name Description Value
identityProperties 用於金鑰加密的受控識別屬性。 IdentityProperties
kekType 用於金鑰加密的加密金鑰類型。 'CustomerManaged'
'MicrosoftManaged' (必要)
kekUrl 金鑰加密金鑰。 如果是客戶管理的 KekType,則為必要專案。 字串
kekVaultResourceID Kek 保存庫資源標識碼。如果是客戶管理的 KekType,則為必要專案。 字串

ManagedDiskDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'ManagedDisk' (必要)
resourceGroupId 計算磁碟的資源群組標識碼。 字串 (必要)
stagingStorageAccountId 可以用來複製 VHD 進行暫存的 storage 帳號的 Resource ID。 字串 (必要)

NotificationPreference

Name Description Value
sendNotification 需要通知或不需要。 布林 (必要)
stageName 階段的名稱。 'AtAzureDC'
'Created'
'DataCopy'
'Delivered'
'DevicePrepared'
'Dispatched'
'PickedUp'
“ShippedToCustomer”(必填)

PackageCarrierDetails

Name Description Value
carrierAccountNumber 客戶磁碟的電信業者帳戶號碼。 string

Constraints:
敏感值。 以安全參數的形式傳入。
carrierName 電信業者的名稱。 字串
trackingId 追蹤出貨的標識碼。 字串

Preferences

Name Description Value
encryptionPreferences 與加密相關的喜好設定。 EncryptionPreferences
preferredDataCenterRegion 慣用的數據中心區域。 string[]
reverseTransportPreferences 與 SKU 反向出貨物流相關的選擇性喜好設定。 TransportPreferences
storageAccountAccessTierPreferences 與 storage 帳號 Access 層級相關的偏好設定。 'Archive'[]
transportPreferences 與 SKU 的出貨物流相關的喜好設定。 TransportPreferences

ResourceIdentity

Name Description Value
型別 身分類型 字串
userAssignedIdentities 使用者指派的身分識別 ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

ResourceTags

Name Description Value

ReverseShippingDetails

Name Description Value
contactDetails 連絡資訊。 ContactInfo
shippingAddress 客戶想要接收裝置的寄送位址。 ShippingAddress

ShippingAddress

Name Description Value
addressType 位址的類型。 'Commercial'
'None'
'Residential'
city City 的名稱。 字串
companyName 公司名稱。 字串
country 國家/地區名稱。 字串 (必要)
postalCode 郵遞區號。 字串
stateOrProvince 州或省的名稱。 字串
streetAddress1 街道地址行 1。 字串 (必要)
streetAddress2 街道地址行 2。 字串
streetAddress3 街道地址行 3。 字串
zipExtendedCode 延伸郵遞區號。 字串

Sku

Name Description Value
displayName SKU 的顯示名稱。 字串
family SKU 系列。 字串
name SKU 名稱。 'DataBox'
'DataBoxCustomerDisk'
'DataBoxDisk'
'DataBoxHeavy' (必要)

StorageAccountDetails

Name Description Value
dataAccountType 要傳輸之數據的帳戶類型。 'StorageAccount' (必要)
storageAccountId Storage Account 資源 ID。 字串 (必要)

TransferAllDetails

Name Description Value
dataAccountType 數據的帳戶類型 'ManagedDisk'
'StorageAccount' (必要)
transferAllBlobs 用來表示所有 Azure 的 blobs 是否都必須轉移 bool
transferAllFiles 用來表示是否所有 Azure 檔案儲存體 都必須轉移 bool

TransferConfiguration

Name Description Value
transferAllDetails 篩選類型和詳細數據的對應,以傳輸所有數據。 只有在 TransferConfigurationType 指定為 TransferAll 時,才需要此字段 TransferConfigurationTransferAllDetails
transferConfigurationType 要傳輸的組態類型。 'TransferAll'
'TransferUsingFilter' (必要)
transferFilterDetails 篩選類型和要篩選的詳細數據對應。 只有在 TransferConfigurationType 指定為 TransferUsingFilter 時,才需要此字段。 TransferConfigurationTransferFilterDetails

TransferConfigurationTransferAllDetails

Name Description Value
include 傳輸所有數據的詳細數據。 TransferAllDetails

TransferConfigurationTransferFilterDetails

Name Description Value
include 篩選數據傳輸的詳細數據。 TransferFilterDetails

TransferFilterDetails

Name Description Value
azureFileFilterDetails 篩選細節以傳輸 Azure 檔案。 AzureFileFilterDetails
blobFilterDetails 篩選詳細數據以傳輸 Blob。 BlobFilterDetails
dataAccountType 數據的帳戶類型。 'ManagedDisk'
'StorageAccount' (必要)
filterFileDetails 要用於數據傳輸之篩選檔案的詳細數據。 FilterFileDetails[]

TransportPreferences

Name Description Value
preferredShipmentType 指出客戶慣用的出貨物流類型。 'CustomerManaged'
'MicrosoftManaged' (必要)

UserAssignedIdentity

Name Description Value

UserAssignedProperties

Name Description Value
resourceId 要用來擷取 MSI 令牌之使用者指派身分識別的 Arm 資源識別碼。 字串