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

Service - Validate Inputs

服务:: Data Box

API 版本:: 2020-11-01

此方法在订阅下执行所有必要的作业创建验证。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs?api-version=2020-11-01

URI 参数

名称	在	必需	类型	说明
location	path	True	string	资源的位置
subscriptionId	path	True	string	订阅 ID
api-version	query	True	string	API 版本

请求正文

CreateJobValidations

它执行所有作业前创建验证。

名称	必需	类型	说明
individualRequestDetails	True	ValidationInputRequest[]: CreateOrderLimitForSubscriptionValidationRequest[] DataTransferDetailsValidationRequest[] PreferencesValidationRequest[] SkuAvailabilityValidationRequest[] SubscriptionIsAllowedToCreateJobValidationRequest[] ValidateAddress[]	请求详细信息列表分别包含 validationType 及其请求作为键和值。
validationCategory	True	string: JobCreationValidation	确定验证的性质。

响应

名称	类型	说明
200 OK	ValidationResponse	每个验证参数的验证状态和响应。
Other Status Codes	ApiError	描述作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ValidateInputs

示例请求

HTTP

POST https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.DataBox/locations/westus/validateInputs?api-version=2020-11-01

{
  "validationCategory": "JobCreationValidation",
  "individualRequestDetails": [
    {
      "validationType": "ValidateDataTransferDetails",
      "dataImportDetails": [
        {
          "accountDetails": {
            "dataAccountType": "StorageAccount",
            "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName"
          }
        }
      ],
      "deviceType": "DataBox",
      "transferType": "ImportToAzure"
    },
    {
      "validationType": "ValidateAddress",
      "shippingAddress": {
        "streetAddress1": "XXXX XXXX",
        "streetAddress2": "XXXX XXXX",
        "city": "XXXX XXXX",
        "stateOrProvince": "XX",
        "country": "XX",
        "postalCode": "00000",
        "companyName": "XXXX XXXX",
        "addressType": "Commercial"
      },
      "deviceType": "DataBox",
      "transportPreferences": {
        "preferredShipmentType": "MicrosoftManaged"
      }
    },
    {
      "validationType": "ValidateSubscriptionIsAllowedToCreateJob"
    },
    {
      "validationType": "ValidateSkuAvailability",
      "deviceType": "DataBox",
      "transferType": "ImportToAzure",
      "country": "XX",
      "location": "westus"
    },
    {
      "validationType": "ValidateCreateOrderLimit",
      "deviceType": "DataBox"
    },
    {
      "validationType": "ValidatePreferences",
      "preference": {
        "transportPreferences": {
          "preferredShipmentType": "MicrosoftManaged"
        }
      },
      "deviceType": "DataBox"
    }
  ]
}

示例响应

状态代码:: 200

{
  "properties": {
    "status": "AllValidToProceed",
    "individualResponseDetails": [
      {
        "status": "Valid",
        "validationType": "ValidateDataTransferDetails",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      },
      {
        "validationStatus": "Valid",
        "alternateAddresses": [
          {
            "streetAddress1": "XXXX XXXX",
            "streetAddress2": "XXXX XXXX",
            "streetAddress3": "",
            "city": "XXXX XXXX",
            "stateOrProvince": "XX",
            "country": "XX",
            "postalCode": "00000",
            "addressType": "None"
          }
        ],
        "validationType": "ValidateAddress",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      },
      {
        "status": "Valid",
        "validationType": "ValidateSubscriptionIsAllowedToCreateJob",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      },
      {
        "status": "Valid",
        "validationType": "ValidateSkuAvailability",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      },
      {
        "status": "Valid",
        "validationType": "ValidateCreateOrderLimit",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      },
      {
        "status": "Valid",
        "validationType": "ValidatePreferences",
        "error": {
          "code": "Success",
          "target": "KeyEncryptionKey",
          "details": [],
          "additionalInfo": []
        }
      }
    ]
  }
}

定义

名称	说明
AdditionalErrorInfo	其他错误信息。
AddressType	地址类型。
AddressValidationProperties	地址验证输出。
AddressValidationStatus	地址验证状态。
ApiError
AzureFileFilterDetails	筛选详细信息以传输 Azure 文件
BlobFilterDetails	筛选详细信息以传输 Azure Blob
CloudError	云错误。
CreateJobValidations	它执行所有作业前创建验证。
CreateOrderLimitForSubscriptionValidationRequest	请求验证当前订阅的创建订单限制。
CreateOrderLimitForSubscriptionValidationResponseProperties	订阅验证响应的创建订单限制的属性。
DataAccountType	帐户的类型。
DataExportDetails	要用于从 Azure 导出数据的数据的详细信息。
DataImportDetails	要用于将数据导入 Azure 的数据的详细信息。
DataTransferDetailsValidationRequest	请求验证导出和导入数据详细信息。
DataTransferDetailsValidationResponseProperties	数据传输的属性详细信息验证响应。
Details
DoubleEncryption	定义基于软件的加密启用的辅助层。
EncryptionPreferences	与加密相关的首选项。
ErrorDetail
FilterFileDetails	要用于数据传输的筛选器文件的详细信息。
FilterFileType	筛选器文件的类型。
LogCollectionLevel	要收集的日志级别。
ManagedDiskDetails	托管磁盘的详细信息。
OverallValidationStatus	总体验证状态。
Preferences	与订单相关的首选项
PreferencesValidationRequest	请求验证传输和数据中心的首选项。
PreferencesValidationResponseProperties	数据中心的属性和传输首选项验证响应。
ShippingAddress	客户希望接收设备的寄送地址。
SkuAvailabilityValidationRequest	请求验证 SKU 可用性。
SkuAvailabilityValidationResponseProperties	SKU 可用性验证响应的属性。
SkuName	要筛选可用 SKU 的 SKU 名称
StorageAccountDetails	存储帐户的详细信息。
SubscriptionIsAllowedToCreateJobValidationRequest	请求验证用于创建作业的订阅权限。
SubscriptionIsAllowedToCreateJobValidationResponseProperties	用于创建作业验证响应的订阅权限的属性。
TransferAllDetails	传输所有数据的详细信息。
TransferConfiguration	用于定义数据传输的配置。
TransferConfigurationType	传输的配置类型。
TransferFilterDetails	筛选数据传输的详细信息。
TransferType	传输的类型。
TransportPreferences	与 SKU 的发货物流相关的首选项
TransportShipmentTypes	指示客户首选的发货物流类型。
ValidateAddress	验证需要寄送设备的客户地址的要求。
ValidationResponse	作业创建前验证的响应。
ValidationStatus	创建订单限制验证状态。

AdditionalErrorInfo

Object

其他错误信息。

名称	类型	说明
info	object	其他错误信息。
type	string	其他错误类型。

AddressType

枚举

地址类型。

值	说明
Commercial	商业地址。
None	地址类型未知。
Residential	住宅地址。

AddressValidationProperties

Object

地址验证输出。

名称	类型	说明
alternateAddresses	ShippingAddress[]	备用地址列表。
error	CloudError	验证响应的错误代码和消息。
validationStatus	AddressValidationStatus	地址验证状态。
validationType	string: ValidateAddress	标识验证响应的类型。

AddressValidationStatus

枚举

地址验证状态。

值	说明
Ambiguous	提供的地址不明确，请选择返回的备用地址之一。
Invalid	提供的地址无效或不受支持。
Valid	提供的地址有效。

ApiError

Object

名称	类型	说明
error	ErrorDetail

AzureFileFilterDetails

Object

筛选详细信息以传输 Azure 文件

名称	类型	说明
filePathList	string[]	要传输的文件的完整路径列表。
filePrefixList	string[]	要传输的 Azure 文件的前缀列表。
fileShareList	string[]	要传输的文件共享列表。

BlobFilterDetails

Object

筛选详细信息以传输 Azure Blob

名称	类型	说明
blobPathList	string[]	要传输的 Blob 的完整路径的列表。
blobPrefixList	string[]	要传输的 Azure Blob 的前缀列表。
containerList	string[]	要传输的 Blob 容器的列表。

CloudError

Object

云错误。

名称	类型	说明
additionalInfo	AdditionalErrorInfo[]	云错误附加信息。
code	string	云错误代码。
details	CloudError[]	云错误详细信息。
message	string	云错误消息。
target	string	云错误目标。

CreateJobValidations

Object

它执行所有作业前创建验证。

名称	类型	说明
individualRequestDetails	ValidationInputRequest[]: CreateOrderLimitForSubscriptionValidationRequest[] DataTransferDetailsValidationRequest[] PreferencesValidationRequest[] SkuAvailabilityValidationRequest[] SubscriptionIsAllowedToCreateJobValidationRequest[] ValidateAddress[]	请求详细信息列表分别包含 validationType 及其请求作为键和值。
validationCategory	string: JobCreationValidation	确定验证的性质。

CreateOrderLimitForSubscriptionValidationRequest

Object

请求验证当前订阅的创建订单限制。

名称	类型	说明
deviceType	SkuName	要用于作业的设备类型。
validationType	string: ValidateCreateOrderLimit	标识验证请求的类型。

CreateOrderLimitForSubscriptionValidationResponseProperties

Object

订阅验证响应的创建订单限制的属性。

名称	类型	说明
error	CloudError	验证响应的错误代码和消息。
status	ValidationStatus	创建订单限制验证状态。
validationType	string: ValidateCreateOrderLimit	标识验证响应的类型。

DataAccountType

枚举

帐户的类型。

值	说明
ManagedDisk	Azure 托管磁盘存储。
StorageAccount	存储帐户。

DataExportDetails

Object

要用于从 Azure 导出数据的数据的详细信息。

名称	类型	默认值	说明
accountDetails	DataAccountDetails: ManagedDiskDetails StorageAccountDetails		要传输的数据的帐户详细信息
logCollectionLevel	LogCollectionLevel	Error	要收集的日志级别。
transferConfiguration	TransferConfiguration		数据传输的配置。

DataImportDetails

Object

要用于将数据导入 Azure 的数据的详细信息。

名称	类型	说明
accountDetails	DataAccountDetails: ManagedDiskDetails StorageAccountDetails	要传输的数据的帐户详细信息

DataTransferDetailsValidationRequest

Object

请求验证导出和导入数据详细信息。

名称	类型	说明
dataExportDetails	DataExportDetails[]	要用于从 Azure 导出数据的 DataTransfer 详细信息列表。
dataImportDetails	DataImportDetails[]	要用于将数据导入 Azure 的 DataTransfer 详细信息列表。
deviceType	SkuName	设备类型。
transferType	TransferType	传输的类型。
validationType	string: ValidateDataTransferDetails	标识验证请求的类型。

DataTransferDetailsValidationResponseProperties

Object

数据传输的属性详细信息验证响应。

名称	类型	说明
error	CloudError	验证响应的错误代码和消息。
status	ValidationStatus	数据传输详细信息验证状态。
validationType	string: ValidateDataTransferDetails	标识验证响应的类型。

Details

Object

名称	类型	说明
code	string
message	string

DoubleEncryption

枚举

定义基于软件的加密启用的辅助层。

值	说明
Disabled	已禁用基于软件的加密。
Enabled	已启用基于软件的加密。

EncryptionPreferences

Object

与加密相关的首选项。

名称	类型	默认值	说明
doubleEncryption	DoubleEncryption	Disabled	定义基于软件的加密启用的辅助层。

ErrorDetail

Object

名称	类型	说明
code	string
details	Details[]
message	string
target	string

FilterFileDetails

Object

要用于数据传输的筛选器文件的详细信息。

名称	类型	说明
filterFilePath	string	包含要传输的所有项的详细信息的文件的路径。
filterFileType	FilterFileType	筛选器文件的类型。

FilterFileType

枚举

筛选器文件的类型。

值	说明
AzureBlob	筛选器文件的类型为 AzureBlob。
AzureFile	筛选器文件的类型为 AzureFiles。

LogCollectionLevel

枚举

要收集的日志级别。

值	说明
Error	只会在日志中收集错误。
Verbose	详细日志记录（包括错误、CRC、大小信息等）。

ManagedDiskDetails

Object

托管磁盘的详细信息。

名称	类型	默认值	说明
dataAccountType	string: ManagedDisk	StorageAccount	要传输的数据的帐户类型。
resourceGroupId	string		计算磁盘的资源组 ID。
sharePassword	string		在设备上创建的所有共享的密码。不应为 TransferType：ExportFromAzure 作业传递。如果未传递，服务将生成密码本身。这不会在“获取呼叫”中返回。密码要求：密码必须至少为 12 个字符，最多 64 个字符。密码必须至少有一个大写字母，一个数字和一个特殊字符。密码不能具有以下字符：IilLoO0 密码只能有字母、数字和以下字符：@#-$%^！+=;：_（）]+
stagingStorageAccountId	string		可用于复制 vhd 进行暂存的存储帐户的资源 ID。

OverallValidationStatus

枚举

总体验证状态。

值	说明
AllValidToProceed	每个输入请求都有效。
CertainInputValidationsSkipped	跳过了某些输入验证。
InputsRevisitRequired	某些输入请求无效。

Preferences

Object

与订单相关的首选项

名称	类型	说明
encryptionPreferences	EncryptionPreferences	与加密相关的首选项。
preferredDataCenterRegion	string[]	首选数据中心区域。
transportPreferences	TransportPreferences	与 SKU 的发货物流相关的首选项。

PreferencesValidationRequest

Object

请求验证传输和数据中心的首选项。

名称	类型	说明
deviceType	SkuName	要用于作业的设备类型。
preference	Preferences	传输和数据中心的首选项。
validationType	string: ValidatePreferences	标识验证请求的类型。

PreferencesValidationResponseProperties

Object

数据中心的属性和传输首选项验证响应。

名称	类型	说明
error	CloudError	验证响应的错误代码和消息。
status	ValidationStatus	请求的数据中心和传输的验证状态。
validationType	string: ValidatePreferences	标识验证响应的类型。

ShippingAddress

Object

客户希望接收设备的寄送地址。

名称	类型	默认值	说明
addressType	AddressType	None	地址类型。
city	string		City 的名称。
companyName	string		公司的名称。
country	string		国家/地区的名称。
postalCode	string		邮政编码。
stateOrProvince	string		州或省的名称。
streetAddress1	string		街道地址行 1。
streetAddress2	string		街道地址行 2。
streetAddress3	string		街道地址行 3。
zipExtendedCode	string		扩展的邮政编码。

SkuAvailabilityValidationRequest

Object

请求验证 SKU 可用性。

名称	类型	说明
country	string	ISO 国家/地区代码。硬件运输的国家/地区。有关代码检查：https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
deviceType	SkuName	要用于作业的设备类型。
location	string	数据传输的位置。有关位置检查：`https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01`
transferType	TransferType	传输的类型。
validationType	string: ValidateSkuAvailability	标识验证请求的类型。

SkuAvailabilityValidationResponseProperties

Object

SKU 可用性验证响应的属性。

名称	类型	说明
error	CloudError	验证响应的错误代码和消息。
status	ValidationStatus	Sku 可用性验证状态。
validationType	string: ValidateSkuAvailability	标识验证响应的类型。

SkuName

枚举

要筛选可用 SKU 的 SKU 名称

值	说明
DataBox	Data Box。
DataBoxDisk	Data Box Disk。
DataBoxHeavy	Data Box Heavy。

StorageAccountDetails

Object

存储帐户的详细信息。

名称	类型	默认值	说明
dataAccountType	string: StorageAccount	StorageAccount	要传输的数据的帐户类型。
sharePassword	string		在设备上创建的所有共享的密码。不应为 TransferType：ExportFromAzure 作业传递。如果未传递，服务将生成密码本身。这不会在“获取呼叫”中返回。密码要求：密码必须至少为 12 个字符，最多 64 个字符。密码必须至少有一个大写字母，一个数字和一个特殊字符。密码不能具有以下字符：IilLoO0 密码只能有字母、数字和以下字符：@#-$%^！+=;：_（）]+
storageAccountId	string		存储帐户资源 ID。

SubscriptionIsAllowedToCreateJobValidationRequest

Object

请求验证用于创建作业的订阅权限。

名称	类型	说明
validationType	string: ValidateSubscriptionIsAllowedToCreateJob	标识验证请求的类型。

SubscriptionIsAllowedToCreateJobValidationResponseProperties

Object

用于创建作业验证响应的订阅权限的属性。

名称	类型	说明
error	CloudError	验证响应的错误代码和消息。
status	ValidationStatus	用于创建作业的订阅权限的验证状态。
validationType	string: ValidateSubscriptionIsAllowedToCreateJob	标识验证响应的类型。

TransferAllDetails

Object

传输所有数据的详细信息。

名称	类型	默认值	说明
dataAccountType	DataAccountType	StorageAccount	数据帐户的类型
transferAllBlobs	boolean		指示是否必须传输所有 Azure Blob
transferAllFiles	boolean		若要指示是否必须传输所有 Azure 文件

TransferConfiguration

Object

用于定义数据传输的配置。

名称	类型	说明
transferAllDetails	TransferAllDetails	用于传输所有数据的筛选器类型和详细信息的映射。仅当 TransferConfigurationType 作为 TransferAll 提供时，才需要此字段
transferConfigurationType	TransferConfigurationType	传输的配置类型。
transferFilterDetails	TransferFilterDetails	筛选器类型和要筛选的详细信息的映射。仅当 TransferConfigurationType 作为 TransferUsingFilter 提供时，才需要此字段。

TransferConfigurationType

枚举

传输的配置类型。

值	说明
TransferAll	传输所有数据。
TransferUsingFilter	使用筛选器传输。

TransferFilterDetails

Object

筛选数据传输的详细信息。

名称	类型	默认值	说明
azureFileFilterDetails	AzureFileFilterDetails		筛选详细信息以传输 Azure 文件。
blobFilterDetails	BlobFilterDetails		筛选用于传输 Blob 的详细信息。
dataAccountType	DataAccountType	StorageAccount	数据的帐户类型。
filterFileDetails	FilterFileDetails[]		要用于数据传输的筛选器文件的详细信息。

TransferType

枚举

传输的类型。

值	说明
ExportFromAzure	从 Azure 导出数据。
ImportToAzure	将数据导入 Azure。

TransportPreferences

Object

与 SKU 的发货物流相关的首选项

名称	类型	说明
preferredShipmentType	TransportShipmentTypes	指示客户首选的发货物流类型。

TransportShipmentTypes

枚举

指示客户首选的发货物流类型。

值	说明
CustomerManaged	货物物流由客户处理。
MicrosoftManaged	运输物流由Microsoft处理。

ValidateAddress

Object

验证需要寄送设备的客户地址的要求。

名称	类型	说明
deviceType	SkuName	要用于作业的设备类型。
shippingAddress	ShippingAddress	客户的寄送地址。
transportPreferences	TransportPreferences	与 SKU 的发货物流相关的首选项。
validationType	string: ValidateAddress	标识验证请求的类型。

ValidationResponse

Object

作业创建前验证的响应。

名称	类型	说明
properties.individualResponseDetails	ValidationInputResponse[]: AddressValidationProperties[] CreateOrderLimitForSubscriptionValidationResponseProperties[] DataTransferDetailsValidationResponseProperties[] PreferencesValidationResponseProperties[] SkuAvailabilityValidationResponseProperties[] SubscriptionIsAllowedToCreateJobValidationResponseProperties[]	响应详细信息列表分别包含 validationType 及其响应作为键和值。
properties.status	OverallValidationStatus	总体验证状态。

ValidationStatus

枚举

创建订单限制验证状态。

值	说明
Invalid	验证不成功
Skipped	跳过验证
Valid	验证成功

通过

Service - Validate Inputs

URI 参数

请求正文

CreateJobValidations

响应

安全性

azure_auth

作用域

示例

ValidateInputs

示例请求

示例响应

定义

AdditionalErrorInfo

AddressType

AddressValidationProperties

AddressValidationStatus

ApiError

AzureFileFilterDetails

BlobFilterDetails

CloudError

CreateJobValidations

CreateOrderLimitForSubscriptionValidationRequest

CreateOrderLimitForSubscriptionValidationResponseProperties

DataAccountType

DataExportDetails

DataImportDetails

DataTransferDetailsValidationRequest

DataTransferDetailsValidationResponseProperties

Details

DoubleEncryption

EncryptionPreferences

ErrorDetail

FilterFileDetails

FilterFileType

LogCollectionLevel

ManagedDiskDetails

OverallValidationStatus

Preferences

PreferencesValidationRequest

PreferencesValidationResponseProperties

ShippingAddress

SkuAvailabilityValidationRequest

SkuAvailabilityValidationResponseProperties

SkuName

StorageAccountDetails

SubscriptionIsAllowedToCreateJobValidationRequest

SubscriptionIsAllowedToCreateJobValidationResponseProperties

TransferAllDetails

TransferConfiguration

TransferConfigurationType

TransferFilterDetails

TransferType

TransportPreferences

TransportShipmentTypes

ValidateAddress

ValidationResponse

ValidationStatus