你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.DataBox 作业 2019-09-01

Bicep 资源定义

可以使用面向以下操作部署作业资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataBox/jobs 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DataBox/jobs@2019-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    displayName: 'string'
    family: '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'
      }
      destinationAccountDetails: [
        {
          accountId: 'string'
          sharePassword: 'string'
          dataDestinationType: 'string'
          // For remaining properties, see DestinationAccountDetails objects
        }
      ]
      expectedDataSizeInTeraBytes: int
      preferences: {
        preferredDataCenterRegion: [
          'string'
        ]
        transportPreferences: {
          preferredShipmentType: '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
    }
  }
}

JobDetails 对象

设置 jobDetailsType 属性以指定对象的类型。

对于 DataBox,请使用:

  jobDetailsType: 'DataBox'
  devicePassword: 'string'

对于 DataBoxDisk,请使用:

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

对于 DataBoxHeavy,请使用:

  jobDetailsType: 'DataBoxHeavy'
  devicePassword: 'string'

DestinationAccountDetails 对象

设置 dataDestinationType 属性以指定对象的类型。

对于 ManagedDisk,请使用:

  dataDestinationType: 'ManagedDisk'
  resourceGroupId: 'string'
  stagingStorageAccountId: 'string'

对于 StorageAccount,请使用:

  dataDestinationType: 'StorageAccount'
  storageAccountId: 'string'

属性值

jobs

名称 说明
name 资源名称 字符串 (必需)

字符限制:3-24

有效字符:
字母数字、连字符、下划线字符和句点。
location 资源的位置。 这是受支持和注册的 Azure 区域之一, (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改,但如果在更新时指定了相同的区域,则请求将成功。 字符串 (必需)
标记 描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 标记名称和值的字典。 请参阅 模板中的标记
sku SKU 类型。 需要 sku ()
properties 作业的属性。 JobProperties (必需)

JobProperties

名称 说明
deliveryInfo 作业的传递信息。 JobDeliveryInfo
deliveryType 作业的传递类型。 “NonScheduled”
'Scheduled'
详细信息 作业运行的详细信息。 此字段将仅针对展开详细信息筛选器发送。 JobDetails

JobDeliveryInfo

名称 说明
scheduledDateTime 计划的日期时间。 字符串

JobDetails

名称 说明
contactDetails 有关通知和发货的联系人详细信息。 ContactDetails (必需)
destinationAccountDetails 目标帐户详细信息。 DestinationAccountDetails[] (必需)
expectedDataSizeInTeraBytes 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 int
preferences 订单的首选项。 首选项
shippingAddress 客户的送货地址。 ShippingAddress (必需)
jobDetailsType 设置对象类型 DataBox
DataBoxDisk
需要 DataBoxHeavy ()

ContactDetails

名称 说明
contactName 此人的联系人姓名。 字符串 (必需)
emailList 要通知作业进度的Email ID 列表。 string[] (必需的)
mobile 联系人的移动电话号码。 字符串
notificationPreference 作业阶段的通知首选项。 NotificationPreference[]
phone 联系人的电话号码。 字符串 (必需)
phoneExtension 联系人的电话分机号。 字符串

NotificationPreference

名称 说明
sendNotification 是否需要通知。 bool (必需)
stageName 阶段的名称。 “AtAzureDC”
“DataCopy”
“已交付”
“DevicePrepared”
“Dispatched”
“PickedUp” (必需)

DestinationAccountDetails

名称 说明
accountId 必须移动数据的目标的 Arm ID。 字符串
sharePassword 共享要由 SA 中的所有共享共享的密码。 字符串
dataDestinationType 设置对象类型 ManagedDisk
所需的 StorageAccount ()

DestinationManagedDiskDetails

名称 说明
dataDestinationType 数据目标类型。 “ManagedDisk” (必需)
resourceGroupId 应在其中创建计算磁盘的目标资源组 ID。 字符串 (必需)
stagingStorageAccountId 可用于复制 vhd 进行暂存的存储帐户的 Arm ID。 字符串 (必需)

DestinationStorageAccountDetails

名称 说明
dataDestinationType 数据目标类型。 “StorageAccount” (必需)
storageAccountId 目标存储帐户 Arm ID。 字符串 (必需)

首选项

名称 说明
preferredDataCenterRegion 首选数据中心区域。 string[]
transportPreferences 与 SKU 的发货物流相关的首选项。 传输首选项

传输首选项

名称 说明
preferredShipmentType 指示客户首选的“发货物流”类型。 “CustomerManaged”
需要“MicrosoftManaged” ()

ShippingAddress

名称 说明
addressType 地址类型。 “商业”
“None”
“住宅”
city 城市的名称。 字符串
companyName 公司名称。 string
country 国家/地区的名称。 字符串 (必需)
postalCode 邮政编码。 字符串 (必需)
stateOrProvince 省/自治区/直辖市或省的名称。 字符串
streetAddress1 街道地址行 1。 字符串 (必需)
streetAddress2 街道地址行 2。 字符串
streetAddress3 街道地址行 3。 字符串
zipExtendedCode 扩展邮政编码。 字符串

DataBoxJobDetails

名称 说明
jobDetailsType 指示作业详细信息的类型。 “DataBox” (必需)
devicePassword 设置用于解锁 Databox 的设备密码 字符串

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 的设备密码 字符串

SKU

名称 说明
displayName SKU 的显示名称。 字符串
family SKU 系列。 字符串
name SKU 名称。 “DataBox”
“DataBoxDisk”
“DataBoxHeavy” (必需)

ARM 模板资源定义

可以使用针对以下操作部署作业资源类型:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataBox/jobs 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DataBox/jobs",
  "apiVersion": "2019-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "displayName": "string",
    "family": "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"
      },
      "destinationAccountDetails": [
        {
          "accountId": "string",
          "sharePassword": "string",
          "dataDestinationType": "string"
          // For remaining properties, see DestinationAccountDetails objects
        }
      ],
      "expectedDataSizeInTeraBytes": "int",
      "preferences": {
        "preferredDataCenterRegion": [ "string" ],
        "transportPreferences": {
          "preferredShipmentType": "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
    }
  }
}

JobDetails 对象

设置 jobDetailsType 属性以指定对象的类型。

对于 DataBox,请使用:

  "jobDetailsType": "DataBox",
  "devicePassword": "string"

对于 DataBoxDisk,请使用:

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

对于 DataBoxHeavy,请使用:

  "jobDetailsType": "DataBoxHeavy",
  "devicePassword": "string"

DestinationAccountDetails 对象

设置 dataDestinationType 属性以指定对象的类型。

对于 ManagedDisk,请使用:

  "dataDestinationType": "ManagedDisk",
  "resourceGroupId": "string",
  "stagingStorageAccountId": "string"

对于 StorageAccount,请使用:

  "dataDestinationType": "StorageAccount",
  "storageAccountId": "string"

属性值

jobs

名称 说明 Value
type 资源类型 “Microsoft.DataBox/jobs”
apiVersion 资源 API 版本 '2019-09-01'
name 资源名称 字符串 (必需)

字符限制:3-24

有效字符:
字母数字、连字符、下划线字符和句点。
location 资源的位置。 这是受支持和注册的 Azure 区域之一, (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改,但如果在更新时指定了相同的区域,则请求将成功。 字符串 (必需)
标记 描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 标记名称和值的字典。 请参阅 模板中的标记
sku SKU 类型。 需要 sku ()
properties 作业的属性。 JobProperties (必需)

JobProperties

名称 说明
deliveryInfo 作业的传递信息。 JobDeliveryInfo
deliveryType 作业的传递类型。 “NonScheduled”
'Scheduled'
详细信息 作业运行的详细信息。 此字段将仅针对展开详细信息筛选器发送。 JobDetails

JobDeliveryInfo

名称 说明
scheduledDateTime 计划的日期时间。 字符串

JobDetails

名称 说明
contactDetails 有关通知和发货的联系人详细信息。 ContactDetails (必需)
destinationAccountDetails 目标帐户详细信息。 DestinationAccountDetails[] (必需)
expectedDataSizeInTeraBytes 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 int
preferences 订单的首选项。 首选项
shippingAddress 客户的送货地址。 ShippingAddress (必需)
jobDetailsType 设置对象类型 DataBox
DataBoxDisk
需要 DataBoxHeavy ()

ContactDetails

名称 说明
contactName 人员的联系人姓名。 字符串 (必需)
emailList 要接收作业进度通知的Email ID 列表。 string[] (必需)
mobile 联系人的移动电话号码。 字符串
notificationPreference 作业阶段的通知首选项。 NotificationPreference[]
phone 联系人的电话号码。 字符串 (必需)
phoneExtension 联系人的电话分机号。 字符串

NotificationPreference

名称 说明
sendNotification 是否需要通知。 bool (必需)
stageName 阶段的名称。 “AtAzureDC”
“DataCopy”
“已交付”
“DevicePrepared”
“Dispatched”
“PickedUp” (必需)

DestinationAccountDetails

名称 说明
accountId 必须移动数据的目标的 Arm ID。 字符串
sharePassword 共享要由 SA 中的所有共享共享的密码。 字符串
dataDestinationType 设置对象类型 ManagedDisk
所需的 StorageAccount ()

DestinationManagedDiskDetails

名称 说明
dataDestinationType 数据目标类型。 “ManagedDisk” (必需)
resourceGroupId 应在其中创建计算磁盘的目标资源组 ID。 字符串 (必需)
stagingStorageAccountId 可用于复制 vhd 进行暂存的存储帐户的 Arm ID。 字符串 (必需)

DestinationStorageAccountDetails

名称 说明
dataDestinationType 数据目标类型。 “StorageAccount” (必需)
storageAccountId 目标存储帐户 Arm ID。 字符串 (必需)

首选项

名称 说明
preferredDataCenterRegion 首选数据中心区域。 string[]
transportPreferences 与 SKU 的发货物流相关的首选项。 传输首选项

传输首选项

名称 说明
preferredShipmentType 指示客户首选的“发货物流”类型。 “CustomerManaged”
需要“MicrosoftManaged” ()

ShippingAddress

名称 说明
addressType 地址类型。 “商业”
“None”
“住宅”
city 城市的名称。 字符串
companyName 公司名称。 string
country 国家/地区的名称。 字符串 (必需)
postalCode 邮政编码。 字符串 (必需)
stateOrProvince 省/自治区/直辖市或省的名称。 字符串
streetAddress1 街道地址行 1。 字符串 (必需)
streetAddress2 街道地址行 2。 字符串
streetAddress3 街道地址行 3。 字符串
zipExtendedCode 扩展邮政编码。 字符串

DataBoxJobDetails

名称 说明
jobDetailsType 指示作业详细信息的类型。 “DataBox” (必需)
devicePassword 设置用于解锁 Databox 的设备密码 字符串

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 的设备密码 字符串

SKU

名称 说明
displayName SKU 的显示名称。 字符串
family SKU 系列。 字符串
name SKU 名称。 “DataBox”
“DataBoxDisk”
“DataBoxHeavy” (必需)

Terraform (AzAPI 提供程序) 资源定义

可以使用针对以下操作部署作业资源类型:

  • 资源组

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataBox/jobs 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBox/jobs@2019-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
        }
        destinationAccountDetails = [
          {
            accountId = "string"
            sharePassword = "string"
            dataDestinationType = "string"
            // For remaining properties, see DestinationAccountDetails objects
          }
        ]
        expectedDataSizeInTeraBytes = int
        preferences = {
          preferredDataCenterRegion = [
            "string"
          ]
          transportPreferences = {
            preferredShipmentType = "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
      }
    }
    sku = {
      displayName = "string"
      family = "string"
      name = "string"
    }
  })
}

JobDetails 对象

设置 jobDetailsType 属性以指定对象的类型。

对于 DataBox,请使用:

  jobDetailsType = "DataBox"
  devicePassword = "string"

对于 DataBoxDisk,请使用:

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

对于 DataBoxHeavy,请使用:

  jobDetailsType = "DataBoxHeavy"
  devicePassword = "string"

DestinationAccountDetails 对象

设置 dataDestinationType 属性以指定对象的类型。

对于 ManagedDisk,请使用:

  dataDestinationType = "ManagedDisk"
  resourceGroupId = "string"
  stagingStorageAccountId = "string"

对于 StorageAccount,请使用:

  dataDestinationType = "StorageAccount"
  storageAccountId = "string"

属性值

jobs

名称 说明 Value
type 资源类型 “Microsoft.DataBox/jobs@2019-09-01”
name 资源名称 字符串 (必需)

字符限制:3-24

有效字符:
字母数字、连字符、下划线字符和句点。
location 资源的位置。 这是受支持和注册的 Azure 区域之一, (例如美国西部、美国东部、东南亚等 ) 。 资源的区域在创建后无法更改,但如果在更新时指定了相同的区域,则请求将成功。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 标记名称和值的字典。
sku SKU 类型。 需要 sku ()
properties 作业的属性。 JobProperties (必需)

JobProperties

名称 说明
deliveryInfo 作业的传递信息。 JobDeliveryInfo
deliveryType 作业的传递类型。 “NonScheduled”
“Scheduled”
详细信息 作业运行的详细信息。 此字段将仅针对展开详细信息筛选器发送。 JobDetails

JobDeliveryInfo

名称 说明
scheduledDateTime 计划的日期时间。 字符串

JobDetails

名称 说明
contactDetails 有关通知和发货的联系人详细信息。 ContactDetails (必需)
destinationAccountDetails 目标帐户详细信息。 DestinationAccountDetails[] (必需)
expectedDataSizeInTeraBytes 需要在此作业中传输的数据的预期大小(以 TB 为单位)。 int
preferences 订单的首选项。 首选项
shippingAddress 客户的送货地址。 ShippingAddress (必需)
jobDetailsType 设置对象类型 DataBox
DataBoxDisk
需要 DataBoxHeavy ()

ContactDetails

名称 说明
contactName 人员的联系人姓名。 字符串 (必需)
emailList 要接收作业进度通知的Email ID 列表。 string[] (必需)
mobile 联系人的手机号码。 字符串
notificationPreference 作业阶段的通知首选项。 NotificationPreference[]
phone 联系人的电话号码。 字符串 (必需)
phoneExtension 联系人的电话号码分机号。 字符串

NotificationPreference

名称 说明
sendNotification 是否需要通知。 需要 bool ()
stageName 阶段的名称。 “AtAzureDC”
“DataCopy”
“已交付”
“DevicePrepared”
“Dispatched”
“PickedUp” (必需)

DestinationAccountDetails

名称 说明
accountId 必须移动数据的目标的 Arm ID。 字符串
sharePassword 共享要由 SA 中的所有共享共享的密码。 字符串
dataDestinationType 设置对象类型 ManagedDisk
所需的 StorageAccount ()

DestinationManagedDiskDetails

名称 说明
dataDestinationType 数据目标类型。 “ManagedDisk” (必需)
resourceGroupId 应在其中创建计算磁盘的目标资源组 ID。 字符串 (必需)
stagingStorageAccountId 可用于复制 vhd 进行暂存的存储帐户的 Arm ID。 字符串 (必需)

DestinationStorageAccountDetails

名称 说明
dataDestinationType 数据目标类型。 “StorageAccount” (必需)
storageAccountId 目标存储帐户 Arm ID。 字符串 (必需)

首选项

名称 说明
preferredDataCenterRegion 首选数据中心区域。 string[]
transportPreferences 与 SKU 的发货物流相关的首选项。 传输首选项

传输首选项

名称 说明
preferredShipmentType 指示客户首选的“发货物流”类型。 “CustomerManaged”
需要“MicrosoftManaged” ()

ShippingAddress

名称 说明
addressType 地址类型。 “商业”
"None"
“住宅”
city 城市的名称。 字符串
companyName 公司名称。 string
country 国家/地区的名称。 字符串 (必需)
postalCode 邮政编码。 字符串 (必需)
stateOrProvince 省/自治区/直辖市或省的名称。 字符串
streetAddress1 街道地址行 1。 字符串 (必需)
streetAddress2 街道地址行 2。 字符串
streetAddress3 街道地址行 3。 字符串
zipExtendedCode 扩展邮政编码。 字符串

DataBoxJobDetails

名称 说明
jobDetailsType 指示作业详细信息的类型。 “DataBox” (必需)
devicePassword 设置用于解锁 Databox 的设备密码 字符串

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 的设备密码 字符串

SKU

名称 说明
displayName SKU 的显示名称。 字符串
family SKU 系列。 字符串
name SKU 名称。 "DataBox"
“DataBoxDisk”
“DataBoxHeavy” (必需)