你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DataBox 作业
Bicep 资源定义
可以使用针对以下操作部署作业资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataBox/jobs 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DataBox/jobs@2024-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
displayName: 'string'
family: 'string'
model: 'string'
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
hardwareEncryption: 'string'
}
preferredDataCenterRegion: [
'string'
]
reverseTransportPreferences: {
preferredShipmentType: 'string'
}
storageAccountAccessTierPreferences: 'string'
transportPreferences: {
preferredShipmentType: 'string'
}
}
reverseShippingDetails: {
contactDetails: {
contactName: 'string'
mobile: 'string'
phone: 'string'
phoneExtension: 'string'
}
shippingAddress: {
addressType: 'string'
city: 'string'
companyName: 'string'
country: 'string'
postalCode: 'string'
skipAddressValidation: bool
stateOrProvince: 'string'
streetAddress1: 'string'
streetAddress2: 'string'
streetAddress3: 'string'
taxIdentificationNumber: 'string'
zipExtendedCode: 'string'
}
}
shippingAddress: {
addressType: 'string'
city: 'string'
companyName: 'string'
country: 'string'
postalCode: 'string'
skipAddressValidation: bool
stateOrProvince: 'string'
streetAddress1: 'string'
streetAddress2: 'string'
streetAddress3: 'string'
taxIdentificationNumber: 'string'
zipExtendedCode: 'string'
}
jobDetailsType: 'string'
// For remaining properties, see JobDetails objects
}
transferType: 'string'
}
}
JobDetails 对象
设置 jobDetailsType 属性以指定对象的类型。
对于 DataBox，请使用：
jobDetailsType: 'DataBox'
devicePassword: 'string'
对于 DataBoxCustomerDisk，请使用：
jobDetailsType: 'DataBoxCustomerDisk'
enableManifestBackup: bool
importDiskDetailsCollection: {
{customized property}: {
bitLockerKey: 'string'
manifestFile: 'string'
manifestHash: 'string'
}
}
returnToCustomerPackageDetails: {
carrierAccountNumber: 'string'
carrierName: 'string'
trackingId: 'string'
}
对于 DataBoxDisk，请使用：
jobDetailsType: 'DataBoxDisk'
passkey: 'string'
preferredDisks: {
{customized property}: int
}
对于 DataBoxHeavy，请使用：
jobDetailsType: 'DataBoxHeavy'
devicePassword: 'string'
DataAccountDetails 对象
设置 dataAccountType 属性以指定对象的类型。
对于 ManagedDisk，请使用：
dataAccountType: 'ManagedDisk'
resourceGroupId: 'string'
stagingStorageAccountId: 'string'
对于 StorageAccount，请使用：
dataAccountType: 'StorageAccount'
storageAccountId: 'string'
属性值
jobs
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 | 字符串 (必需) 字符限制：3-24 有效字符： 字母数字、连字符、下划线字符和句点。 |
| location | 资源的位置。 这是受支持和注册的 Azure 区域之一， (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改，但如果在更新时指定了相同的区域，则请求将成功。 | 字符串 (必需) |
| 标记 | 描述资源的键值对列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | SKU 类型。 | 需要 sku () |
| 标识 | 资源的 Msi 标识 | ResourceIdentity |
| properties | 作业的属性。 | JobProperties (必需) |
ResourceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | 字符串 |
| userAssignedIdentities | 用户分配的标识 | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
JobProperties
| 名称 | 说明 | 值 |
|---|---|---|
| deliveryInfo | 作业的传递信息。 | JobDeliveryInfo |
| deliveryType | 作业的传递类型。 | “NonScheduled” “Scheduled” |
| 详细信息 | 作业运行的详细信息。 此字段仅发送用于展开详细信息筛选器。 | JobDetails |
| transferType | 数据传输的类型。 | “ExportFromAzure” “ImportToAzure” (必需) |
JobDeliveryInfo
| 名称 | 说明 | 值 |
|---|---|---|
| scheduledDateTime | 计划的日期时间。 | 字符串 |
JobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 通知和发货的联系人详细信息。 | ContactDetails (必需) |
| dataExportDetails | 要从 Azure 导出的数据的详细信息。 | DataExportDetails[] |
| dataImportDetails | 要导入 Azure 的数据的详细信息。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小（以 TB 为单位）。 | int |
| keyEncryptionKey | 有关正在使用哪种密钥加密类型的详细信息。 | KeyEncryptionKey |
| preferences | 订单的首选项。 | 首选项 |
| reverseShippingDetails | 订单的可选反向发货详细信息。 | ReverseShippingDetails |
| shippingAddress | 客户的送货地址。 | ShippingAddress |
| jobDetailsType | 设置对象类型 | DataBox DataBoxCustomerDisk DataBoxDisk 需要 DataBoxHeavy () |
ContactDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 此人的联系人姓名。 | 字符串 (必需) |
| emailList | 要通知作业进度的Email ID 列表。 | string[] (必需的) |
| mobile | 联系人的移动电话号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | 字符串 (必需) |
| phoneExtension | 联系人的电话分机号。 | 字符串 |
NotificationPreference
| 名称 | 说明 | 值 |
|---|---|---|
| sendNotification | 是否需要通知。 | bool (必需) |
| stageName | 阶段的名称。 | “AtAzureDC” “已创建” “DataCopy” “已交付” “DevicePrepared” “Dispatched” “PickedUp” 需要“ShippedToCustomer” () |
DataExportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | “错误” “Verbose” |
| transferConfiguration | 数据传输的配置。 | TransferConfiguration (必需) |
DataAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| sharePassword | 在设备上创建的所有共享的密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符：IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 约束： 敏感值。 作为安全参数传入。 |
| dataAccountType | 设置对象类型 | ManagedDisk 需要 storageAccount () |
ManagedDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk” (必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | 字符串 (必需) |
| stagingStorageAccountId | 可用于复制 vhd 进行暂存的存储帐户的资源 ID。 | 字符串 (必需) |
StorageAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “StorageAccount” (必需) |
| storageAccountId | 存储帐户资源 ID。 | 字符串 (必需) |
TransferConfiguration
| 名称 | 说明 | 值 |
|---|---|---|
| transferAllDetails | 要传输所有数据的筛选器类型和详细信息的映射。 仅当 TransferConfigurationType 指定为 TransferAll 时，此字段才是必需的 | TransferConfigurationTransferAllDetails |
| transferConfigurationType | 传输配置的类型。 | “TransferAll” “TransferUsingFilter” (必需) |
| transferFilterDetails | 筛选器类型和要筛选的详细信息的映射。 仅当 TransferConfigurationType 被指定为 TransferUsingFilter 时，此字段才是必需的。 | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 传输所有数据的详细信息。 | TransferAllDetails |
TransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 数据帐户的类型 | “ManagedDisk” “StorageAccount” (必需) |
| transferAllBlobs | 指示是否必须传输所有 Azure Blob | bool |
| transferAllFiles | 指示是否必须转移所有Azure 文件存储 | bool |
TransferConfigurationTransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 筛选数据传输的详细信息。 | TransferFilterDetails |
TransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| azureFileFilterDetails | 筛选详细信息以传输 Azure 文件。 | AzureFileFilterDetails |
| blobFilterDetails | 筛选详细信息以传输 Blob。 | BlobFilterDetails |
| dataAccountType | 数据帐户的类型。 | “ManagedDisk” “StorageAccount” (必需) |
| filterFileDetails | 要用于数据传输的筛选器文件的详细信息。 | FilterFileDetails[] |
AzureFileFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filePathList | 要传输的文件的完整路径列表。 | string[] |
| filePrefixList | 要传输的 Azure 文件的前缀列表。 | string[] |
| fileShareList | 要传输的文件共享列表。 | string[] |
BlobFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| blobPathList | 要传输的 Blob 的完整路径列表。 | string[] |
| blobPrefixList | 要传输的 Azure Blob 的前缀列表。 | string[] |
| containerList | 要传输的 Blob 容器的列表。 | string[] |
FilterFileDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filterFilePath | 包含要传输的所有项的详细信息的文件的路径。 | 字符串 (必需) |
| filterFileType | 筛选器文件的类型。 | “AzureBlob” “AzureFile” (必需) |
DataImportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | 'Error' “Verbose” |
KeyEncryptionKey
| 名称 | 说明 | 值 |
|---|---|---|
| identityProperties | 用于密钥加密的托管标识属性。 | IdentityProperties |
| kekType | 用于密钥加密的加密密钥类型。 | 'CustomerManaged' 需要“MicrosoftManaged” () |
| kekUrl | 密钥加密密钥。 对于客户托管的 KekType，需要用到它。 | 字符串 |
| kekVaultResourceID | Kek 保管库资源 ID。对于客户托管的 KekType，需要用到它。 | 字符串 |
IdentityProperties
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
UserAssignedProperties
| 名称 | 说明 | 值 |
|---|---|---|
| ResourceId | 要用于提取 MSI 令牌的用户分配标识的 Arm 资源 ID。 | 字符串 |
首选项
| 名称 | 说明 | 值 |
|---|---|---|
| encryptionPreferences | 与加密相关的首选项。 | 加密首选项 |
| preferredDataCenterRegion | 首选数据中心区域。 | string[] |
| reverseTransportPreferences | 与 SKU 的反向发货物流相关的可选首选项。 | TransportPreferences |
| storageAccountAccessTierPreferences | 与存储帐户访问层相关的首选项。 | 包含任意项的字符串数组： “存档” |
| transportPreferences | 与 SKU 的发货物流相关的首选项。 | 传输首选项 |
加密首选项
| 名称 | 说明 | 值 |
|---|---|---|
| doubleEncryption | 定义基于软件的加密启用的次要层。 | “Disabled” “已启用” |
| hardwareEncryption | 仅定义磁盘) 的硬件级别加密 ( | “Disabled” “已启用” |
传输首选项
| 名称 | 说明 | 值 |
|---|---|---|
| preferredShipmentType | 指示客户首选的“发货物流”类型。 | “CustomerManaged” 需要“MicrosoftManaged” () |
ReverseShippingDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 联系人信息。 | ContactInfo |
| shippingAddress | 客户希望接收设备的送货地址。 | ShippingAddress |
ContactInfo
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 此人的联系人姓名。 | 字符串 (必需) 约束： 最小长度 = 1 |
| mobile | 联系人的移动电话号码。 | 字符串 |
| phone | 联系人的电话号码。 | 字符串 (必需) 约束： 最小长度 = 1 |
| phoneExtension | 联系人的电话分机号。 | 字符串 |
ShippingAddress
| 名称 | 说明 | 值 |
|---|---|---|
| addressType | 地址类型。 | “商业” “None” “住宅” |
| city | 城市的名称。 | 字符串 |
| companyName | 公司名称。 | string |
| country | 国家/地区的名称。 | 字符串 (必需) |
| postalCode | 邮政编码。 | 字符串 |
| skipAddressValidation | 指示客户是否已选择跳过默认地址验证的标志 | bool |
| stateOrProvince | 省/自治区/直辖市或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | 字符串 (必需) |
| streetAddress2 | 街道地址行 2。 | 字符串 |
| streetAddress3 | 街道地址行 3。 | 字符串 |
| taxIdentificationNumber | 税务标识号 | 字符串 |
| zipExtendedCode | 扩展邮政编码。 | 字符串 |
DataBoxJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBox” (必需) |
| devicePassword | 设置用于解锁 Databox 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少具有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符： IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
DataBoxCustomerDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | 需要“DataBoxCustomerDisk” () |
| enableManifestBackup | 指示是否应在存储帐户中备份磁盘清单的标志。 | bool |
| importDiskDetailsCollection | 包含磁盘序列号到导入作业的磁盘详细信息的映射。 | DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec... |
| returnToCustomerPackageDetails | 退回包裹寄送详细信息。 | PackageCarrierDetails (必需) |
DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec...
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | ImportDiskDetails |
ImportDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | 字符串 (必需) 约束： 敏感值。 作为安全参数传入。 |
| manifestFile | 磁盘上清单文件的相对路径。 | 字符串 (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | 字符串 (必需) |
PackageCarrierDetails
| 名称 | 说明 | 值 |
|---|---|---|
| carrierAccountNumber | 客户磁盘的运营商帐户数。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 发货的跟踪 ID。 | 字符串 |
DataBoxDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxDisk” (必需) |
| passkey | 用户为 DataBox Disk 作业输入了密钥。 | 字符串 |
| preferredDisks | 用户优先选择作业所需的磁盘大小。 映射从磁盘大小（以 TB 为单位）到计数。 例如 {2,5} 表示 5 个大小为 2 TB 的磁盘。 密钥为字符串，但将根据 int 进行检查。 | DataBoxDiskJobDetailsPreferredDisks |
DataBoxDiskJobDetailsPreferredDisks
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxHeavy” (必需) |
| devicePassword | 设置用于解锁 Databox Heavy 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符：IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | SKU 的显示名称。 | 字符串 |
| family | SKU 系列。 | 字符串 |
| 模型 | SKU 的显示名称。 | “DataBox” “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” “DataBoxV2x100” “DataBoxV2x500” |
| name | SKU 名称。 | “DataBox” “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” () |
ARM 模板资源定义
可以使用面向以下操作部署作业资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataBox/jobs 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DataBox/jobs",
"apiVersion": "2024-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"displayName": "string",
"family": "string",
"model": "string",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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",
"hardwareEncryption": "string"
},
"preferredDataCenterRegion": [ "string" ],
"reverseTransportPreferences": {
"preferredShipmentType": "string"
},
"storageAccountAccessTierPreferences": "string",
"transportPreferences": {
"preferredShipmentType": "string"
}
},
"reverseShippingDetails": {
"contactDetails": {
"contactName": "string",
"mobile": "string",
"phone": "string",
"phoneExtension": "string"
},
"shippingAddress": {
"addressType": "string",
"city": "string",
"companyName": "string",
"country": "string",
"postalCode": "string",
"skipAddressValidation": "bool",
"stateOrProvince": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"streetAddress3": "string",
"taxIdentificationNumber": "string",
"zipExtendedCode": "string"
}
},
"shippingAddress": {
"addressType": "string",
"city": "string",
"companyName": "string",
"country": "string",
"postalCode": "string",
"skipAddressValidation": "bool",
"stateOrProvince": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"streetAddress3": "string",
"taxIdentificationNumber": "string",
"zipExtendedCode": "string"
},
"jobDetailsType": "string"
// For remaining properties, see JobDetails objects
},
"transferType": "string"
}
}
JobDetails 对象
设置 jobDetailsType 属性以指定对象的类型。
对于 DataBox，请使用：
"jobDetailsType": "DataBox",
"devicePassword": "string"
对于 DataBoxCustomerDisk，请使用：
"jobDetailsType": "DataBoxCustomerDisk",
"enableManifestBackup": "bool",
"importDiskDetailsCollection": {
"{customized property}": {
"bitLockerKey": "string",
"manifestFile": "string",
"manifestHash": "string"
}
},
"returnToCustomerPackageDetails": {
"carrierAccountNumber": "string",
"carrierName": "string",
"trackingId": "string"
}
对于 DataBoxDisk，请使用：
"jobDetailsType": "DataBoxDisk",
"passkey": "string",
"preferredDisks": {
"{customized property}": "int"
}
对于 DataBoxHeavy，请使用：
"jobDetailsType": "DataBoxHeavy",
"devicePassword": "string"
DataAccountDetails 对象
设置 dataAccountType 属性以指定对象的类型。
对于 ManagedDisk，请使用：
"dataAccountType": "ManagedDisk",
"resourceGroupId": "string",
"stagingStorageAccountId": "string"
对于 StorageAccount，请使用：
"dataAccountType": "StorageAccount",
"storageAccountId": "string"
属性值
jobs
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DataBox/jobs” |
| apiVersion | 资源 API 版本 | “2024-03-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：3-24 有效字符： 字母数字、连字符、下划线字符和句点。 |
| location | 资源的位置。 这是受支持和注册的 Azure 区域之一， (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改，但如果在更新时指定了相同的区域，则请求将成功。 | 字符串 (必需) |
| 标记 | 描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | SKU 类型。 | 需要 sku () |
| 标识 | 资源的 Msi 标识 | ResourceIdentity |
| properties | 作业的属性。 | JobProperties (必需) |
ResourceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | 字符串 |
| userAssignedIdentities | 用户分配的标识 | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
JobProperties
| 名称 | 说明 | 值 |
|---|---|---|
| deliveryInfo | 作业的传递信息。 | JobDeliveryInfo |
| deliveryType | 作业的传递类型。 | “NonScheduled” 'Scheduled' |
| 详细信息 | 作业运行的详细信息。 此字段将仅针对展开详细信息筛选器发送。 | JobDetails |
| transferType | 数据传输的类型。 | “ExportFromAzure” 需要“ImportToAzure” () |
JobDeliveryInfo
| 名称 | 说明 | 值 |
|---|---|---|
| scheduledDateTime | 计划的日期时间。 | 字符串 |
JobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 有关通知和发货的联系人详细信息。 | ContactDetails (必需) |
| dataExportDetails | 要从 Azure 导出的数据的详细信息。 | DataExportDetails[] |
| dataImportDetails | 要导入 Azure 的数据的详细信息。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小（以 TB 为单位）。 | int |
| keyEncryptionKey | 有关正在使用哪种密钥加密类型的详细信息。 | KeyEncryptionKey |
| preferences | 订单的首选项。 | 首选项 |
| reverseShippingDetails | 订单的可选反向发货详细信息。 | ReverseShippingDetails |
| shippingAddress | 客户的送货地址。 | ShippingAddress |
| jobDetailsType | 设置对象类型 | DataBox DataBoxCustomerDisk DataBoxDisk 需要 DataBoxHeavy () |
ContactDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 人员的联系人姓名。 | 字符串 (必需) |
| emailList | 要接收作业进度通知的Email ID 列表。 | string[] (必需) |
| mobile | 联系人的手机号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | 字符串 (必需) |
| phoneExtension | 联系人的电话号码分机号。 | 字符串 |
NotificationPreference
| 名称 | 说明 | 值 |
|---|---|---|
| sendNotification | 是否需要通知。 | 需要 bool () |
| stageName | 阶段的名称。 | 'AtAzureDC' “Created” “DataCopy” “Delivered” “DevicePrepared” “Dispatched” “PickedUp” 需要“ShippedToCustomer” () |
DataExportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | 'Error' “Verbose” |
| transferConfiguration | 数据传输的配置。 | 需要 transferConfiguration () |
DataAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| sharePassword | 在设备上创建的所有共享的密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符：IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 约束： 敏感值。 作为安全参数传入。 |
| dataAccountType | 设置对象类型 | ManagedDisk 需要 storageAccount () |
ManagedDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk” (必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | 字符串 (必需) |
| stagingStorageAccountId | 可用于复制 vhd 进行暂存的存储帐户的资源 ID。 | 字符串 (必需) |
StorageAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “StorageAccount” (必需) |
| storageAccountId | 存储帐户资源 ID。 | 字符串 (必需) |
TransferConfiguration
| 名称 | 说明 | 值 |
|---|---|---|
| transferAllDetails | 要传输所有数据的筛选器类型和详细信息的映射。 仅当 TransferConfigurationType 指定为 TransferAll 时，此字段才是必需的 | TransferConfigurationTransferAllDetails |
| transferConfigurationType | 传输配置的类型。 | “TransferAll” “TransferUsingFilter” (必需) |
| transferFilterDetails | 筛选器类型和要筛选的详细信息的映射。 仅当 TransferConfigurationType 被指定为 TransferUsingFilter 时，此字段才是必需的。 | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 传输所有数据的详细信息。 | TransferAllDetails |
TransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 数据帐户的类型 | “ManagedDisk” “StorageAccount” (必需) |
| transferAllBlobs | 指示是否必须传输所有 Azure Blob | bool |
| transferAllFiles | 指示是否必须转移所有Azure 文件存储 | bool |
TransferConfigurationTransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 筛选数据传输的详细信息。 | TransferFilterDetails |
TransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| azureFileFilterDetails | 筛选用于传输 Azure 文件的详细信息。 | AzureFileFilterDetails |
| blobFilterDetails | 筛选用于传输 Blob 的详细信息。 | BlobFilterDetails |
| dataAccountType | 数据帐户的类型。 | “ManagedDisk” “StorageAccount” (必需) |
| filterFileDetails | 要用于数据传输的筛选器文件的详细信息。 | FilterFileDetails[] |
AzureFileFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filePathList | 要传输的文件的完整路径列表。 | string[] |
| filePrefixList | 要传输的 Azure 文件的前缀列表。 | string[] |
| fileShareList | 要传输的文件共享列表。 | string[] |
BlobFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| blobPathList | 要传输的 Blob 的完整路径列表。 | string[] |
| blobPrefixList | 要传输的 Azure Blob 的前缀列表。 | string[] |
| containerList | 要传输的 Blob 容器的列表。 | string[] |
FilterFileDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filterFilePath | 文件的路径，其中包含要传输的所有项的详细信息。 | 字符串 (必需) |
| filterFileType | 筛选器文件的类型。 | “AzureBlob” “AzureFile” (必需) |
DataImportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | “错误” “Verbose” |
KeyEncryptionKey
| 名称 | 说明 | 值 |
|---|---|---|
| identityProperties | 用于密钥加密的托管标识属性。 | IdentityProperties |
| kekType | 用于密钥加密的加密密钥类型。 | “CustomerManaged” 需要“MicrosoftManaged” () |
| kekUrl | 密钥加密密钥。 对于客户托管的 KekType，则需要它。 | 字符串 |
| kekVaultResourceID | Kek 保管库资源 ID。对于客户托管的 KekType，则需要它。 | 字符串 |
IdentityProperties
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
UserAssignedProperties
| 名称 | 说明 | 值 |
|---|---|---|
| ResourceId | 要用于提取 MSI 令牌的用户分配标识的 Arm 资源 ID。 | 字符串 |
首选项
| 名称 | 说明 | 值 |
|---|---|---|
| encryptionPreferences | 与加密相关的首选项。 | 加密首选项 |
| preferredDataCenterRegion | 首选数据中心区域。 | string[] |
| reverseTransportPreferences | 与 SKU 的反向发货物流相关的可选首选项。 | TransportPreferences |
| storageAccountAccessTierPreferences | 与存储帐户访问层相关的首选项。 | 包含任何一项的字符串数组： 'Archive' |
| transportPreferences | 与 SKU 的发货物流相关的首选项。 | TransportPreferences |
加密首选项
| 名称 | 说明 | 值 |
|---|---|---|
| doubleEncryption | 定义基于软件的加密启用的第二层。 | 'Disabled' 'Enabled' |
| hardwareEncryption | 仅定义磁盘) 的硬件级别加密 ( | 'Disabled' 'Enabled' |
TransportPreferences
| 名称 | 说明 | 值 |
|---|---|---|
| preferredShipmentType | 指示客户首选的发货物流类型。 | 'CustomerManaged' 需要“MicrosoftManaged” () |
ReverseShippingDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 联系人信息。 | ContactInfo |
| shippingAddress | 客户希望接收设备的寄送地址。 | ShippingAddress |
ContactInfo
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 人员的联系人姓名。 | 字符串 (必需) 约束： 最小长度 = 1 |
| mobile | 联系人的手机号码。 | 字符串 |
| phone | 联系人的电话号码。 | 字符串 (必需) 约束： 最小长度 = 1 |
| phoneExtension | 联系人的电话号码分机号。 | 字符串 |
ShippingAddress
| 名称 | 说明 | 值 |
|---|---|---|
| addressType | 地址类型。 | 'Commercial' “None” “住宅” |
| city | 城市的名称。 | 字符串 |
| companyName | 公司的名称。 | string |
| country | 国家/地区的名称。 | 字符串 (必需) |
| postalCode | 邮政编码。 | 字符串 |
| skipAddressValidation | 指示客户是否已选择跳过默认地址验证的标志 | bool |
| stateOrProvince | 州或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | 字符串 (必需) |
| streetAddress2 | 街道地址行 2。 | 字符串 |
| streetAddress3 | 街道地址行 3。 | 字符串 |
| taxIdentificationNumber | 税务标识号 | 字符串 |
| zipExtendedCode | 扩展邮政编码。 | 字符串 |
DataBoxJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | 需要“DataBox” () |
| devicePassword | 设置用于解锁 Databox 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符：IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
DataBoxCustomerDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | 需要“DataBoxCustomerDisk” () |
| enableManifestBackup | 指示是否应在存储帐户中备份磁盘清单的标志。 | bool |
| importDiskDetailsCollection | 包含磁盘序列号到导入作业的磁盘详细信息的映射。 | DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec... |
| returnToCustomerPackageDetails | 退回包裹寄送详细信息。 | PackageCarrierDetails (必需) |
DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec...
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | ImportDiskDetails |
ImportDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | 字符串 (必需) 约束： 敏感值。 作为安全参数传入。 |
| manifestFile | 磁盘上清单文件的相对路径。 | 字符串 (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | 字符串 (必需) |
PackageCarrierDetails
| 名称 | 说明 | 值 |
|---|---|---|
| carrierAccountNumber | 运营商帐户 客户磁盘的客户数。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 发货的跟踪 ID。 | 字符串 |
DataBoxDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxDisk” (必需) |
| passkey | 用户为 DataBox 磁盘作业输入了密钥。 | 字符串 |
| preferredDisks | 用户优先选择作业所需的磁盘大小。 映射从磁盘大小（以 TB 为单位）到计数。 例如 {2,5} 表示 5 个大小为 2 TB 的磁盘。 密钥为字符串，但将根据 int 进行检查。 | DataBoxDiskJobDetailsPreferredDisks |
DataBoxDiskJobDetailsPreferredDisks
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxHeavy” (必需) |
| devicePassword | 设置用于解锁 Databox Heavy 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少具有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符： IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | SKU 的显示名称。 | 字符串 |
| family | SKU 系列。 | 字符串 |
| 模型 | SKU 的显示名称。 | “DataBox” “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” “DataBoxV2x100” “DataBoxV2x500” |
| name | SKU 名称。 | “DataBox” “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” (必需) |
Terraform (AzAPI 提供程序) 资源定义
可以使用针对以下操作部署作业资源类型：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataBox/jobs 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataBox/jobs@2024-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
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"
hardwareEncryption = "string"
}
preferredDataCenterRegion = [
"string"
]
reverseTransportPreferences = {
preferredShipmentType = "string"
}
storageAccountAccessTierPreferences = "string"
transportPreferences = {
preferredShipmentType = "string"
}
}
reverseShippingDetails = {
contactDetails = {
contactName = "string"
mobile = "string"
phone = "string"
phoneExtension = "string"
}
shippingAddress = {
addressType = "string"
city = "string"
companyName = "string"
country = "string"
postalCode = "string"
skipAddressValidation = bool
stateOrProvince = "string"
streetAddress1 = "string"
streetAddress2 = "string"
streetAddress3 = "string"
taxIdentificationNumber = "string"
zipExtendedCode = "string"
}
}
shippingAddress = {
addressType = "string"
city = "string"
companyName = "string"
country = "string"
postalCode = "string"
skipAddressValidation = bool
stateOrProvince = "string"
streetAddress1 = "string"
streetAddress2 = "string"
streetAddress3 = "string"
taxIdentificationNumber = "string"
zipExtendedCode = "string"
}
jobDetailsType = "string"
// For remaining properties, see JobDetails objects
}
transferType = "string"
}
sku = {
displayName = "string"
family = "string"
model = "string"
name = "string"
}
})
}
JobDetails 对象
设置 jobDetailsType 属性以指定对象的类型。
对于 DataBox，请使用：
jobDetailsType = "DataBox"
devicePassword = "string"
对于 DataBoxCustomerDisk，请使用：
jobDetailsType = "DataBoxCustomerDisk"
enableManifestBackup = bool
importDiskDetailsCollection = {
{customized property} = {
bitLockerKey = "string"
manifestFile = "string"
manifestHash = "string"
}
}
returnToCustomerPackageDetails = {
carrierAccountNumber = "string"
carrierName = "string"
trackingId = "string"
}
对于 DataBoxDisk，请使用：
jobDetailsType = "DataBoxDisk"
passkey = "string"
preferredDisks = {
{customized property} = int
}
对于 DataBoxHeavy，请使用：
jobDetailsType = "DataBoxHeavy"
devicePassword = "string"
DataAccountDetails 对象
设置 dataAccountType 属性以指定对象的类型。
对于 ManagedDisk，请使用：
dataAccountType = "ManagedDisk"
resourceGroupId = "string"
stagingStorageAccountId = "string"
对于 StorageAccount，请使用：
dataAccountType = "StorageAccount"
storageAccountId = "string"
属性值
jobs
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DataBox/jobs@2024-03-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：3-24 有效字符： 字母数字、连字符、下划线字符和句点。 |
| location | 资源的位置。 这是受支持和注册的 Azure 区域之一， (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改，但如果在更新时指定了相同的区域，则请求将成功。 | 字符串 (必需) |
| parent_id | 若要部署到资源组，请使用该资源组的 ID。 | 字符串 (必需) |
| 标记 | 描述资源的键值对列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 | 标记名称和值的字典。 |
| sku | SKU 类型。 | 需要 sku () |
| 标识 | 资源的 Msi 标识 | ResourceIdentity |
| properties | 作业的属性。 | JobProperties (必需) |
ResourceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | 字符串 |
| identity_ids | 用户分配的标识 | 用户标识 ID 的数组。 |
ResourceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
JobProperties
| 名称 | 说明 | 值 |
|---|---|---|
| deliveryInfo | 作业的传递信息。 | JobDeliveryInfo |
| deliveryType | 作业的传递类型。 | “NonScheduled” “Scheduled” |
| 详细信息 | 作业运行的详细信息。 此字段将仅针对展开详细信息筛选器发送。 | JobDetails |
| transferType | 数据传输的类型。 | “ExportFromAzure” “ImportToAzure” (必需) |
JobDeliveryInfo
| 名称 | 说明 | 值 |
|---|---|---|
| scheduledDateTime | 计划的日期时间。 | 字符串 |
JobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 有关通知和发货的联系人详细信息。 | ContactDetails (必需) |
| dataExportDetails | 要从 Azure 导出的数据的详细信息。 | DataExportDetails[] |
| dataImportDetails | 要导入 Azure 的数据的详细信息。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小（以 TB 为单位）。 | int |
| keyEncryptionKey | 有关正在使用哪种密钥加密类型的详细信息。 | KeyEncryptionKey |
| preferences | 订单的首选项。 | 首选项 |
| reverseShippingDetails | 订单的可选反向发货详细信息。 | ReverseShippingDetails |
| shippingAddress | 客户的送货地址。 | ShippingAddress |
| jobDetailsType | 设置对象类型 | DataBox DataBoxCustomerDisk DataBoxDisk 需要 DataBoxHeavy () |
ContactDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 人员的联系人姓名。 | 字符串 (必需) |
| emailList | 要接收作业进度通知的Email ID 列表。 | string[] (必需) |
| mobile | 联系人的手机号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | 字符串 (必需) |
| phoneExtension | 联系人的电话号码分机号。 | 字符串 |
NotificationPreference
| 名称 | 说明 | 值 |
|---|---|---|
| sendNotification | 是否需要通知。 | bool (必需) |
| stageName | 阶段的名称。 | “AtAzureDC” “已创建” “DataCopy” “已交付” “DevicePrepared” “Dispatched” “PickedUp” “ShippedToCustomer” (必需) |
DataExportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | “错误” “详细” |
| transferConfiguration | 数据传输的配置。 | TransferConfiguration (必需) |
DataAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| sharePassword | 设备上要创建的所有共享的密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少具有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符： IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 约束： 敏感值。 作为安全参数传入。 |
| dataAccountType | 设置对象类型 | ManagedDisk 所需的 StorageAccount () |
ManagedDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk” (必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | 字符串 (必需) |
| stagingStorageAccountId | 可用于复制 vhd 进行暂存的存储帐户的资源 ID。 | 字符串 (必需) |
StorageAccountDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “StorageAccount” (必需) |
| storageAccountId | 存储帐户资源 ID。 | 字符串 (必需) |
TransferConfiguration
| 名称 | 说明 | 值 |
|---|---|---|
| transferAllDetails | 要传输所有数据的筛选器类型和详细信息的映射。 仅当 TransferConfigurationType 作为 TransferAll 提供时才需要此字段 | TransferConfigurationTransferAllDetails |
| transferConfigurationType | 传输配置的类型。 | “TransferAll” “TransferUsingFilter” (必需) |
| transferFilterDetails | 筛选器类型和要筛选的详细信息的映射。 仅当 TransferConfigurationType 作为 TransferUsingFilter 提供时才需要此字段。 | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 用于传输所有数据的详细信息。 | TransferAllDetails |
TransferAllDetails
| 名称 | 说明 | 值 |
|---|---|---|
| dataAccountType | 数据帐户的类型 | “ManagedDisk” “StorageAccount” (必需) |
| transferAllBlobs | 指示是否必须传输所有 Azure Blob | bool |
| transferAllFiles | 指示是否必须传输所有Azure 文件存储 | bool |
TransferConfigurationTransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| include | 筛选数据传输的详细信息。 | TransferFilterDetails |
TransferFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| azureFileFilterDetails | 筛选用于传输 Azure 文件的详细信息。 | AzureFileFilterDetails |
| blobFilterDetails | 筛选用于传输 Blob 的详细信息。 | BlobFilterDetails |
| dataAccountType | 数据帐户的类型。 | “ManagedDisk” “StorageAccount” (必需) |
| filterFileDetails | 要用于数据传输的筛选器文件的详细信息。 | FilterFileDetails[] |
AzureFileFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filePathList | 要传输的文件的完整路径列表。 | string[] |
| filePrefixList | 要传输的 Azure 文件的前缀列表。 | string[] |
| fileShareList | 要传输的文件共享列表。 | string[] |
BlobFilterDetails
| 名称 | 说明 | 值 |
|---|---|---|
| blobPathList | 要传输的 Blob 的完整路径列表。 | string[] |
| blobPrefixList | 要传输的 Azure Blob 的前缀列表。 | string[] |
| containerList | 要传输的 Blob 容器的列表。 | string[] |
FilterFileDetails
| 名称 | 说明 | 值 |
|---|---|---|
| filterFilePath | 文件的路径，其中包含要传输的所有项的详细信息。 | 字符串 (必需) |
| filterFileType | 筛选器文件的类型。 | “AzureBlob” “AzureFile” (必需的) |
DataImportDetails
| 名称 | 说明 | 值 |
|---|---|---|
| accountDetails | 要传输的数据的帐户详细信息 | DataAccountDetails (必需) |
| logCollectionLevel | 要收集的日志的级别。 | “错误” “详细” |
KeyEncryptionKey
| 名称 | 说明 | 值 |
|---|---|---|
| identityProperties | 用于密钥加密的托管标识属性。 | IdentityProperties |
| kekType | 用于密钥加密的加密密钥类型。 | “CustomerManaged” 需要“MicrosoftManaged” () |
| kekUrl | 密钥加密密钥。 对于客户托管的 KekType，则需要它。 | 字符串 |
| kekVaultResourceID | Kek 保管库资源 ID。对于客户托管的 KekType，则需要它。 | 字符串 |
IdentityProperties
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
UserAssignedProperties
| 名称 | 说明 | 值 |
|---|---|---|
| ResourceId | 要用于提取 MSI 令牌的用户分配标识的 Arm 资源 ID。 | 字符串 |
首选项
| 名称 | 说明 | 值 |
|---|---|---|
| encryptionPreferences | 与加密相关的首选项。 | 加密首选项 |
| preferredDataCenterRegion | 首选数据中心区域。 | string[] |
| reverseTransportPreferences | 与 SKU 的反向发货物流相关的可选首选项。 | 传输首选项 |
| storageAccountAccessTierPreferences | 与存储帐户访问层相关的首选项。 | 包含任意项的字符串数组： “存档” |
| transportPreferences | 与 SKU 的发货物流相关的首选项。 | 传输首选项 |
加密首选项
| 名称 | 说明 | 值 |
|---|---|---|
| doubleEncryption | 定义基于软件的加密启用的次要层。 | “Disabled” “已启用” |
| hardwareEncryption | 仅定义磁盘) 的硬件级别加密 ( | “Disabled” “已启用” |
传输首选项
| 名称 | 说明 | 值 |
|---|---|---|
| preferredShipmentType | 指示客户首选的“发货物流”类型。 | “CustomerManaged” 需要“MicrosoftManaged” () |
ReverseShippingDetails
| 名称 | 说明 | 值 |
|---|---|---|
| contactDetails | 联系人信息。 | ContactInfo |
| shippingAddress | 客户希望接收设备的送货地址。 | ShippingAddress |
ContactInfo
| 名称 | 说明 | 值 |
|---|---|---|
| contactName | 此人的联系人姓名。 | 字符串 (必需) 约束： 最小长度 = 1 |
| mobile | 联系人的移动电话号码。 | 字符串 |
| phone | 联系人的电话号码。 | 字符串 (必需) 约束： 最小长度 = 1 |
| phoneExtension | 联系人的电话分机号。 | 字符串 |
ShippingAddress
| 名称 | 说明 | 值 |
|---|---|---|
| addressType | 地址类型。 | “商业” "None" “住宅” |
| city | 城市的名称。 | 字符串 |
| companyName | 公司名称。 | string |
| country | 国家/地区的名称。 | 字符串 (必需) |
| postalCode | 邮政编码。 | 字符串 |
| skipAddressValidation | 指示客户是否已选择跳过默认地址验证的标志 | bool |
| stateOrProvince | 省/自治区/直辖市或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | 字符串 (必需) |
| streetAddress2 | 街道地址行 2。 | 字符串 |
| streetAddress3 | 街道地址行 3。 | 字符串 |
| taxIdentificationNumber | 税务标识号 | 字符串 |
| zipExtendedCode | 扩展邮政编码。 | 字符串 |
DataBoxJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBox” (必需) |
| devicePassword | 设置用于解锁 Databox 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少具有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符： IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
DataBoxCustomerDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxCustomerDisk” (必需) |
| enableManifestBackup | 指示是否应在存储帐户中备份磁盘清单的标志。 | bool |
| importDiskDetailsCollection | 包含磁盘序列号到导入作业的磁盘详细信息的映射。 | DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec... |
| returnToCustomerPackageDetails | 退回包裹寄送详细信息。 | PackageCarrierDetails (必需) |
DataBoxCustomerDiskJobDetailsImportDiskDetailsCollec...
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | ImportDiskDetails |
ImportDiskDetails
| 名称 | 说明 | 值 |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | 字符串 (必需) 约束： 敏感值。 作为安全参数传入。 |
| manifestFile | 磁盘上清单文件的相对路径。 | 字符串 (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | 字符串 (必需) |
PackageCarrierDetails
| 名称 | 说明 | 值 |
|---|---|---|
| carrierAccountNumber | 客户磁盘的运营商帐户数。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 发货的跟踪 ID。 | 字符串 |
DataBoxDiskJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxDisk” (必需) |
| passkey | 用户为 DataBox 磁盘作业输入了密钥。 | 字符串 |
| preferredDisks | 用户优先选择作业所需的磁盘大小。 映射从磁盘大小（以 TB 为单位）到计数。 例如 {2,5} 表示 5 个大小为 2 TB 的磁盘。 密钥为字符串，但将根据 int 进行检查。 | DataBoxDiskJobDetailsPreferredDisks |
DataBoxDiskJobDetailsPreferredDisks
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| 名称 | 说明 | 值 |
|---|---|---|
| jobDetailsType | 指示作业详细信息的类型。 | “DataBoxHeavy” (必需) |
| devicePassword | 设置用于解锁 Databox Heavy 的设备密码。 不应为 TransferType：ExportFromAzure 作业传递。 如果未传递此密码，则服务将自行生成密码。 这不会在“获取呼叫”中返回。 密码要求：密码必须至少为 12 个字符，最多 64 个字符。 密码必须至少有一个大写字母、一个数字和一个特殊字符。 密码不能包含以下字符：IilLoO0 密码只能包含字母、数字和以下字符： @#-$%^！+=;：_ () ]+ | 字符串 |
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | SKU 的显示名称。 | 字符串 |
| family | SKU 系列。 | 字符串 |
| 模型 | SKU 的显示名称。 | "DataBox" “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” “DataBoxV2x100” “DataBoxV2x500” |
| name | SKU 名称。 | "DataBox" “DataBoxCustomerDisk” “DataBoxDisk” “DataBoxHeavy” (必需) |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈