你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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区域之一(例如美国西部、美国东部、东南亚等)。 创建资源后,无法更改资源的区域,但如果在更新请求时指定了相同的区域,则请求将成功。 | string (必需) |
| 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 | 联系人的联系人姓名。 | string (必需) |
| emailList | 要通知有关作业进度的电子邮件 ID 的列表。 | string[] (必需) |
| 移动 | 联系人的手机号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | string (必需) |
| 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} 表示大小为 2 TB 的 5 个磁盘。 键是字符串,但会针对 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 | 包含要传输的所有项的详细信息的文件的路径。 | string (必需) |
| filterFileType | 筛选器文件的类型。 | 'AzureBlob' “AzureFile”(必需) |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 类型 | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
ImportDiskDetails
| Name | Description | Value |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | string Constraints: 敏感值。 以安全参数的形式传入。 (required) |
| manifestFile | 磁盘上清单文件的相对路径。 | string (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | string (必需) |
JobDeliveryInfo
| Name | Description | Value |
|---|---|---|
| scheduledDateTime | 计划日期时间。 | 字符串 |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | 通知和发货的联系人详细信息。 | ContactDetails (必填) |
| dataExportDetails | 将从azure导出的数据详情。 | DataExportDetails[] |
| dataImportDetails | 要导入到 azure 的数据细节。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 | int |
| jobDetailsType | 对于类型 DataBoxJobDetails,设置为“DataBox”。 对于类型 DataBoxCustomerDiskJobDetails,设置为“DataBoxCustomerDisk”。 对于类型 DataBoxDiskJobDetails,设置为“DataBoxDisk”。 对于类型 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 保管库资源 ID。如果客户管理的 KekType,则需要它。 | 字符串 |
ManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk”(必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | string (必需) |
| stagingStorageAccountId | 可以用来复制VHD进行预备的storage账户的资源ID。 | string (必需) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | 需要通知。 | bool (必需) |
| stageName | 阶段的名称。 | 'AtAzureDC' 'Created' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' “ShippedToCustomer”(必填) |
PackageCarrierDetails
| Name | Description | Value |
|---|---|---|
| carrierAccountNumber | 客户磁盘的运营商帐户号。 | string Constraints: 敏感值。 以安全参数的形式传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 跟踪发货 ID。 | 字符串 |
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 | 国家/地区的名称。 | string (必需) |
| postalCode | 邮政编码。 | 字符串 |
| stateOrProvince | 州或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | string (必需) |
| 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 资源编号。 | string (必需) |
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 资源 ID。 | 字符串 |
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区域之一(例如美国西部、美国东部、东南亚等)。 创建资源后,无法更改资源的区域,但如果在更新请求时指定了相同的区域,则请求将成功。 | string (必需) |
| 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 | 联系人的联系人姓名。 | string (必需) |
| emailList | 要通知有关作业进度的电子邮件 ID 的列表。 | string[] (必需) |
| 移动 | 联系人的手机号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | string (必需) |
| 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} 表示大小为 2 TB 的 5 个磁盘。 键是字符串,但会针对 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 | 包含要传输的所有项的详细信息的文件的路径。 | string (必需) |
| filterFileType | 筛选器文件的类型。 | 'AzureBlob' “AzureFile”(必需) |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 类型 | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
ImportDiskDetails
| Name | Description | Value |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | string Constraints: 敏感值。 以安全参数的形式传入。 (required) |
| manifestFile | 磁盘上清单文件的相对路径。 | string (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | string (必需) |
JobDeliveryInfo
| Name | Description | Value |
|---|---|---|
| scheduledDateTime | 计划日期时间。 | 字符串 |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | 通知和发货的联系人详细信息。 | ContactDetails (必填) |
| dataExportDetails | 将从azure导出的数据详情。 | DataExportDetails[] |
| dataImportDetails | 要导入到 azure 的数据细节。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 | int |
| jobDetailsType | 对于类型 DataBoxJobDetails,设置为“DataBox”。 对于类型 DataBoxCustomerDiskJobDetails,设置为“DataBoxCustomerDisk”。 对于类型 DataBoxDiskJobDetails,设置为“DataBoxDisk”。 对于类型 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 保管库资源 ID。如果客户管理的 KekType,则需要它。 | 字符串 |
ManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk”(必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | string (必需) |
| stagingStorageAccountId | 可以用来复制VHD进行预备的storage账户的资源ID。 | string (必需) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | 需要通知。 | bool (必需) |
| stageName | 阶段的名称。 | 'AtAzureDC' 'Created' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' “ShippedToCustomer”(必填) |
PackageCarrierDetails
| Name | Description | Value |
|---|---|---|
| carrierAccountNumber | 客户磁盘的运营商帐户号。 | string Constraints: 敏感值。 以安全参数的形式传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 跟踪发货 ID。 | 字符串 |
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 | 国家/地区的名称。 | string (必需) |
| postalCode | 邮政编码。 | 字符串 |
| stateOrProvince | 州或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | string (必需) |
| 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 资源编号。 | string (必需) |
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 资源 ID。 | 字符串 |
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区域之一(例如美国西部、美国东部、东南亚等)。 创建资源后,无法更改资源的区域,但如果在更新请求时指定了相同的区域,则请求将成功。 | string (必需) |
| 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 | 联系人的联系人姓名。 | string (必需) |
| emailList | 要通知有关作业进度的电子邮件 ID 的列表。 | string[] (必需) |
| 移动 | 联系人的手机号码。 | 字符串 |
| notificationPreference | 作业阶段的通知首选项。 | NotificationPreference[] |
| phone | 联系人的电话号码。 | string (必需) |
| 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} 表示大小为 2 TB 的 5 个磁盘。 键是字符串,但会针对 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 | 包含要传输的所有项的详细信息的文件的路径。 | string (必需) |
| filterFileType | 筛选器文件的类型。 | 'AzureBlob' “AzureFile”(必需) |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 类型 | 托管服务标识类型。 | 字符串 |
| userAssigned | 用户分配的标识属性。 | UserAssignedProperties |
ImportDiskDetails
| Name | Description | Value |
|---|---|---|
| bitLockerKey | 用于加密磁盘的 BitLocker 密钥。 | string Constraints: 敏感值。 以安全参数的形式传入。 (required) |
| manifestFile | 磁盘上清单文件的相对路径。 | string (必需) |
| manifestHash | 磁盘上清单文件的 Base16 编码 MD5 哈希。 | string (必需) |
JobDeliveryInfo
| Name | Description | Value |
|---|---|---|
| scheduledDateTime | 计划日期时间。 | 字符串 |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | 通知和发货的联系人详细信息。 | ContactDetails (必填) |
| dataExportDetails | 将从azure导出的数据详情。 | DataExportDetails[] |
| dataImportDetails | 要导入到 azure 的数据细节。 | DataImportDetails[] |
| expectedDataSizeInTeraBytes | 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 | int |
| jobDetailsType | 对于类型 DataBoxJobDetails,设置为“DataBox”。 对于类型 DataBoxCustomerDiskJobDetails,设置为“DataBoxCustomerDisk”。 对于类型 DataBoxDiskJobDetails,设置为“DataBoxDisk”。 对于类型 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 保管库资源 ID。如果客户管理的 KekType,则需要它。 | 字符串 |
ManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | 要传输的数据的帐户类型。 | “ManagedDisk”(必需) |
| resourceGroupId | 计算磁盘的资源组 ID。 | string (必需) |
| stagingStorageAccountId | 可以用来复制VHD进行预备的storage账户的资源ID。 | string (必需) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | 需要通知。 | bool (必需) |
| stageName | 阶段的名称。 | 'AtAzureDC' 'Created' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' “ShippedToCustomer”(必填) |
PackageCarrierDetails
| Name | Description | Value |
|---|---|---|
| carrierAccountNumber | 客户磁盘的运营商帐户号。 | string Constraints: 敏感值。 以安全参数的形式传入。 |
| carrierName | 运营商的名称。 | 字符串 |
| trackingId | 跟踪发货 ID。 | 字符串 |
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 | 国家/地区的名称。 | string (必需) |
| postalCode | 邮政编码。 | 字符串 |
| stateOrProvince | 州或省的名称。 | 字符串 |
| streetAddress1 | 街道地址行 1。 | string (必需) |
| 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 资源编号。 | string (必需) |
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 资源 ID。 | 字符串 |