Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kYXRhYm94L2pvYnMve30=/2022-12-01.xml

<?xml version='1.0' encoding='utf-8'?> <CodeGen plane="mgmt-plane"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.databox/jobs/{}" version="2022-12-01" swagger="mgmt-plane/databox/ResourceProviders/Microsoft.DataBox/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRGF0YUJveC9qb2JzL3tqb2JOYW1lfQ==/V/MjAyMi0xMi0wMQ=="/> <commandGroup name="databox job"> <command name="show" version="2022-12-01"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.databox/jobs/{}" version="2022-12-01" swagger="mgmt-plane/databox/ResourceProviders/Microsoft.DataBox/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRGF0YUJveC9qb2JzL3tqb2JOYW1lfQ==/V/MjAyMi0xMi0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.jobName" options="job-name name n" required="True" idPart="name"> <help short="The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only"/> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Query.expand" options="expand" hide="True" group=""> <help short="$expand is supported on details parameter for job, which provides details on the job stages."/> </arg> </argGroup> <operation operationId="Jobs_Get"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}"> <request method="get"> <path> <param type="string" name="jobName" arg="$Path.jobName" required="True"> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/> <param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> </path> <query> <param type="string" name="$expand" arg="$Query.expand"/> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value=""2022-12-01""/> </const> </query> </request> <response statusCode="200"> <body> <json var="$Instance"> <schema type="object"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.DataBox/jobs/{}"/> </prop> <prop type="IdentityObject" name="identity"> <prop readOnly="True" type="string" name="principalId"/> <prop readOnly="True" type="string" name="tenantId"/> <prop type="string" name="type"> <default value=""None""/> </prop> <prop type="object" name="userAssignedIdentities"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="clientId"/> <prop readOnly="True" type="string" name="principalId"/> </item> </additionalProp> </prop> </prop> <prop type="ResourceLocation" name="location" required="True"/> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" required="True" clientFlatten="True"> <prop readOnly="True" type="string" name="cancellationReason"/> <prop type="object" name="deliveryInfo"> <prop type="dateTime" name="scheduledDateTime"/> </prop> <prop type="string" name="deliveryType"> <default value=""NonScheduled""/> <enum> <item value=""NonScheduled""/> <item value=""Scheduled""/> </enum> </prop> <prop type="object" name="details"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="string" name="chainOfCustodySasKey"/> <prop type="object" name="contactDetails" required="True"> <prop type="string" name="contactName" required="True"/> <prop type="array<string>" name="emailList" required="True"> <item type="string"/> </prop> <prop type="string" name="mobile"/> <prop type="array<object>" name="notificationPreference"> <item type="object"> <prop type="boolean" name="sendNotification" required="True"> <default value="true"/> </prop> <prop type="string" name="stageName" required="True"> <enum> <item value=""AtAzureDC""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""PickedUp""/> <item value=""ShippedToCustomer""/> </enum> </prop> </item> </prop> <prop type="string" name="phone" required="True"/> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="array<object>" name="copyLogDetails"> <item type="object"> <prop type="string" name="copyLogDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <discriminator property="copyLogDetailsType" value="DataBox"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="string" name="copyLogLink"/> <prop readOnly="True" type="string" name="copyVerboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="string" name="diskSerialNumber"/> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="array<string>" name="copyLogLink"> <item type="string"/> </prop> <prop readOnly="True" type="array<string>" name="copyVerboseLogLink"> <item type="string"/> </prop> </discriminator> </item> </prop> <prop readOnly="True" type="string" name="dataCenterCode"> <enum> <item value=""AM2""/> <item value=""AMS06""/> <item value=""AMS20""/> <item value=""AUH20""/> <item value=""AdHoc""/> <item value=""BJB""/> <item value=""BJS20""/> <item value=""BL20""/> <item value=""BL7""/> <item value=""BN1""/> <item value=""BN7""/> <item value=""BOM01""/> <item value=""BY1""/> <item value=""BY2""/> <item value=""BY21""/> <item value=""BY24""/> <item value=""CBR20""/> <item value=""CH1""/> <item value=""CPQ02""/> <item value=""CPQ20""/> <item value=""CWL20""/> <item value=""CYS04""/> <item value=""DSM05""/> <item value=""DUB07""/> <item value=""FRA22""/> <item value=""HKG20""/> <item value=""Invalid""/> <item value=""JNB21""/> <item value=""JNB22""/> <item value=""LON24""/> <item value=""MAA01""/> <item value=""MEL23""/> <item value=""MNZ21""/> <item value=""MWH01""/> <item value=""ORK70""/> <item value=""OSA02""/> <item value=""OSA20""/> <item value=""OSA22""/> <item value=""PAR22""/> <item value=""PNQ01""/> <item value=""PUS20""/> <item value=""SEL20""/> <item value=""SEL21""/> <item value=""SG2""/> <item value=""SHA03""/> <item value=""SIN20""/> <item value=""SN5""/> <item value=""SN6""/> <item value=""SN8""/> <item value=""SSE90""/> <item value=""SVG20""/> <item value=""SYD03""/> <item value=""SYD23""/> <item value=""TYO01""/> <item value=""TYO22""/> <item value=""YQB20""/> <item value=""YTO20""/> <item value=""YTO21""/> <item value=""ZRH20""/> </enum> </prop> <prop type="array<object>" name="dataExportDetails"> <item type="object"> <prop type="@DataAccountDetails_read" name="accountDetails" required="True"/> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> <prop type="object" name="transferConfiguration" required="True"> <prop type="object" name="transferAllDetails"> <prop type="object" name="include"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="boolean" name="transferAllBlobs"/> <prop type="boolean" name="transferAllFiles"/> </prop> </prop> <prop type="string" name="transferConfigurationType" required="True"> <enum> <item value=""TransferAll""/> <item value=""TransferUsingFilter""/> </enum> </prop> <prop type="object" name="transferFilterDetails"> <prop type="object" name="include"> <prop type="object" name="azureFileFilterDetails"> <prop type="array<string>" name="filePathList"> <item type="string"/> </prop> <prop type="array<string>" name="filePrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="fileShareList"> <item type="string"/> </prop> </prop> <prop type="object" name="blobFilterDetails"> <prop type="array<string>" name="blobPathList"> <item type="string"/> </prop> <prop type="array<string>" name="blobPrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="containerList"> <item type="string"/> </prop> </prop> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="array<object>" name="filterFileDetails"> <item type="object"> <prop type="string" name="filterFilePath" required="True"/> <prop type="string" name="filterFileType" required="True"> <enum> <item value=""AzureBlob""/> <item value=""AzureFile""/> </enum> </prop> </item> </prop> </prop> </prop> </prop> </item> </prop> <prop type="array<object>" name="dataImportDetails"> <item type="object"> <prop type="object" name="accountDetails" required="True" cls="DataAccountDetails_read"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <discriminator property="dataAccountType" value="ManagedDisk"> <prop type="string" name="resourceGroupId" required="True"/> <prop type="string" name="stagingStorageAccountId" required="True"/> </discriminator> <discriminator property="dataAccountType" value="StorageAccount"> <prop type="string" name="storageAccountId" required="True"/> </discriminator> </prop> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> </item> </prop> <prop type="object" name="datacenterAddress"> <prop readOnly="True" type="string" name="dataCenterAzureLocation"/> <prop type="string" name="datacenterAddressType" required="True"> <enum> <item value=""DatacenterAddressInstruction""/> <item value=""DatacenterAddressLocation""/> </enum> </prop> <prop readOnly="True" type="array<string>" name="supportedCarriersForReturnShipment"> <item type="string"/> </prop> <discriminator property="datacenterAddressType" value="DatacenterAddressInstruction"> <prop readOnly="True" type="string" name="communicationInstruction"/> </discriminator> <discriminator property="datacenterAddressType" value="DatacenterAddressLocation"> <prop readOnly="True" type="string" name="additionalShippingInformation"/> <prop readOnly="True" type="string" name="addressType"/> <prop readOnly="True" type="string" name="city"/> <prop readOnly="True" type="string" name="company"/> <prop readOnly="True" type="string" name="contactPersonName"/> <prop readOnly="True" type="string" name="country"/> <prop readOnly="True" type="string" name="phone"/> <prop readOnly="True" type="string" name="phoneExtension"/> <prop readOnly="True" type="string" name="state"/> <prop readOnly="True" type="string" name="street1"/> <prop readOnly="True" type="string" name="street2"/> <prop readOnly="True" type="string" name="street3"/> <prop readOnly="True" type="string" name="zip"/> </discriminator> </prop> <prop type="object" name="deliveryPackage" cls="PackageShippingDetails_read"> <prop readOnly="True" type="string" name="carrierName"/> <prop readOnly="True" type="string" name="trackingId"/> <prop readOnly="True" type="string" name="trackingUrl"/> </prop> <prop type="object" name="deviceErasureDetails"> <prop readOnly="True" type="string" name="deviceErasureStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="string" name="erasureOrDestructionCertificateSasKey"/> </prop> <prop type="integer32" name="expectedDataSizeInTeraBytes"/> <prop type="string" name="jobDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="array<object>" name="jobStages"> <item type="object"> <prop readOnly="True" type="string" name="displayName"/> <prop readOnly="True" type="string" name="stageName"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop readOnly="True" type="string" name="stageStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="stageTime"/> </item> </prop> <prop type="object" name="keyEncryptionKey"> <prop type="object" name="identityProperties"> <prop type="string" name="type"/> <prop type="object" name="userAssigned"> <prop type="string" name="resourceId"/> </prop> </prop> <prop type="string" name="kekType" required="True"> <default value=""MicrosoftManaged""/> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> <prop type="string" name="kekUrl"/> <prop type="string" name="kekVaultResourceID"/> </prop> <prop type="object" name="lastMitigationActionOnJob"> <prop type="dateTime" name="actionDateTimeInUtc"/> <prop type="string" name="customerResolution"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </prop> <prop type="boolean" name="isPerformedByCustomer"/> </prop> <prop type="object" name="preferences"> <prop type="object" name="encryptionPreferences"> <prop type="string" name="doubleEncryption"> <default value=""Disabled""/> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> <prop type="string" name="hardwareEncryption"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> </prop> <prop type="array<string>" name="preferredDataCenterRegion"> <item type="string"/> </prop> <prop type="@TransportPreferences_read" name="reverseTransportPreferences"/> <prop type="array<string>" name="storageAccountAccessTierPreferences"> <item type="string"> <enum> <item value=""Archive""/> </enum> </item> </prop> <prop type="object" name="transportPreferences" cls="TransportPreferences_read"> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="string" name="preferredShipmentType" required="True"> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> </prop> </prop> <prop readOnly="True" type="@PackageShippingDetails_read" name="returnPackage"/> <prop readOnly="True" type="string" name="reverseShipmentLabelSasKey"/> <prop type="object" name="reverseShippingDetails"> <prop type="object" name="contactDetails"> <prop type="string" name="contactName" required="True"> <format minLength="1"/> </prop> <prop type="string" name="mobile"/> <prop type="string" name="phone" required="True"> <format minLength="1"/> </prop> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="@ShippingAddress_read" name="shippingAddress"/> </prop> <prop type="object" name="shippingAddress" cls="ShippingAddress_read"> <prop type="string" name="addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city"/> <prop type="string" name="companyName"/> <prop type="string" name="country" required="True"/> <prop type="string" name="postalCode"/> <prop type="boolean" name="skipAddressValidation"/> <prop type="string" name="stateOrProvince"/> <prop type="string" name="streetAddress1" required="True"/> <prop type="string" name="streetAddress2"/> <prop type="string" name="streetAddress3"/> <prop type="string" name="taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode"/> </prop> <discriminator property="jobDetailsType" value="DataBox"> <prop readOnly="True" type="array<@CopyProgress_read>" name="copyProgress"> <item type="@CopyProgress_read"/> </prop> <prop type="string" name="devicePassword"/> </discriminator> <discriminator property="jobDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="object" name="deliverToDcPackageDetails"> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> <prop type="boolean" name="enableManifestBackup"> <default value="false"/> </prop> <prop readOnly="True" type="object" name="exportDiskDetailsCollection"> <additionalProp readOnly="True"> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop readOnly="True" type="string" name="manifestFile"/> <prop readOnly="True" type="string" name="manifestHash"/> </item> </additionalProp> </prop> <prop type="object" name="importDiskDetailsCollection"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop type="string" name="bitLockerKey" required="True" secret="True"/> <prop type="string" name="manifestFile" required="True"/> <prop type="string" name="manifestHash" required="True"/> </item> </additionalProp> </prop> <prop type="object" name="returnToCustomerPackageDetails" required="True"> <prop type="string" name="carrierAccountNumber" secret="True"/> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesCopied"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer32" name="percentComplete"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> </item> </prop> <prop readOnly="True" type="object" name="disksAndSizeDetails"> <additionalProp readOnly="True"> <item type="integer32"/> </additionalProp> </prop> <prop readOnly="True" type="array<object>" name="granularCopyLogDetails"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop const="True" type="string" name="copyLogDetailsType" required="True"> <default value=""DataBoxCustomerDisk""/> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </item> </prop> <prop readOnly="True" type="array<object>" name="granularCopyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="passkey"/> <prop type="object" name="preferredDisks"> <additionalProp> <item type="integer32"/> </additionalProp> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object" cls="CopyProgress_read"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="devicePassword"/> </discriminator> </prop> <prop type="object" name="error" cls="CloudError_read"> <prop readOnly="True" type="array<object>" name="additionalInfo"> <item type="object"> <prop type="string" name="type"/> </item> </prop> <prop type="string" name="code"/> <prop readOnly="True" type="array<@CloudError_read>" name="details"> <item type="@CloudError_read"/> </prop> <prop type="string" name="message"/> <prop type="string" name="target"/> </prop> <prop readOnly="True" type="boolean" name="isCancellable"/> <prop readOnly="True" type="boolean" name="isCancellableWithoutFee"/> <prop readOnly="True" type="boolean" name="isDeletable"/> <prop readOnly="True" type="boolean" name="isPrepareToShipEnabled"/> <prop readOnly="True" type="boolean" name="isShippingAddressEditable"/> <prop readOnly="True" type="string" name="reverseShippingDetailsUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="string" name="reverseTransportPreferenceUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="startTime"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop type="string" name="transferType" required="True"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </prop> <prop type="object" name="sku" required="True"> <prop type="string" name="displayName"/> <prop type="string" name="family"/> <prop type="string" name="name" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> </prop> <prop type="object" name="systemData"> <prop readOnly="True" type="dateTime" name="createdAt"/> <prop readOnly="True" type="string" name="createdBy"/> <prop readOnly="True" type="string" name="createdByType"/> <prop readOnly="True" type="dateTime" name="lastModifiedAt"/> <prop readOnly="True" type="string" name="lastModifiedBy"/> <prop readOnly="True" type="string" name="lastModifiedByType"/> </prop> <prop type="object" name="tags"> <additionalProp> <item type="string"/> </additionalProp> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response isError="True"> <body> <json> <schema type="@ODataV4Format"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> <command name="delete" version="2022-12-01" confirmation="Are you sure you want to perform this operation?"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.databox/jobs/{}" version="2022-12-01" swagger="mgmt-plane/databox/ResourceProviders/Microsoft.DataBox/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRGF0YUJveC9qb2JzL3tqb2JOYW1lfQ==/V/MjAyMi0xMi0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.jobName" options="job-name name n" required="True" idPart="name"> <help short="The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only"/> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> </argGroup> <operation operationId="Jobs_Delete"> <longRunning finalStateVia="azure-async-operation"/> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}"> <request method="delete"> <path> <param type="string" name="jobName" arg="$Path.jobName" required="True"> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/> <param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value=""2022-12-01""/> </const> </query> </request> <response statusCode="200"/> <response statusCode="202"> <header> <item name="Location"/> </header> </response> <response statusCode="204"/> <response isError="True"> <body> <json> <schema type="@ODataV4Format"/> </json> </body> </response> </http> </operation> </command> <command name="create" version="2022-12-01" confirmation=""> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.databox/jobs/{}" version="2022-12-01" swagger="mgmt-plane/databox/ResourceProviders/Microsoft.DataBox/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRGF0YUJveC9qb2JzL3tqb2JOYW1lfQ==/V/MjAyMi0xMi0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.jobName" options="job-name name n" required="True" idPart="name"> <help short="The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only"/> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> </argGroup> <argGroup name="ContactDetails"> <arg type="string" var="$jobResource.properties.details.contactDetails.contactName" options="contact-name" group="ContactDetails"> <help short="Contact name of the person."/> </arg> <arg type="array<string>" var="$jobResource.properties.details.contactDetails.emailList" options="email-list" group="ContactDetails"> <help short="List of Email-ids to be notified about job progress."/> <item type="string"/> </arg> <arg type="string" var="$jobResource.properties.details.contactDetails.mobile" options="mobile" group="ContactDetails"> <help short="Mobile number of the contact person."/> </arg> <arg type="array<object>" var="$jobResource.properties.details.contactDetails.notificationPreference" options="notification-preference" hide="True" group="ContactDetails"> <help short="Notification preference for a job stage."/> <item type="object"> <arg type="boolean" var="$jobResource.properties.details.contactDetails.notificationPreference[].sendNotification" options="send-notification" required="True"> <help short="Notification is required or not."/> <default value="true"/> </arg> <arg type="string" var="$jobResource.properties.details.contactDetails.notificationPreference[].stageName" options="stage-name" required="True"> <help short="Name of the stage."/> <enum> <item name="AtAzureDC" value=""AtAzureDC""/> <item name="Created" value=""Created""/> <item name="DataCopy" value=""DataCopy""/> <item name="Delivered" value=""Delivered""/> <item name="DevicePrepared" value=""DevicePrepared""/> <item name="Dispatched" value=""Dispatched""/> <item name="PickedUp" value=""PickedUp""/> <item name="ShippedToCustomer" value=""ShippedToCustomer""/> </enum> </arg> </item> </arg> <arg type="string" var="$jobResource.properties.details.contactDetails.phone" options="phone" group="ContactDetails"> <help short="Phone number of the contact person."/> </arg> <arg type="string" var="$jobResource.properties.details.contactDetails.phoneExtension" options="phone-extension" hide="True" group="ContactDetails"> <help short="Phone extension number of the contact person."/> </arg> </argGroup> <argGroup name="Details"> <arg type="object" var="$jobResource.properties.details.DataBox" options="data-box" group="Details"> <help short="Databox Job Details."/> <arg type="string" var="$jobResource.properties.details.DataBox.devicePassword" options="device-password"> <help short="Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+"/> </arg> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxCustomerDisk" options="data-box-customer-disk" group="Details"> <help short="Customer disk job details."/> <arg type="boolean" var="$jobResource.properties.details.DataBoxCustomerDisk.enableManifestBackup" options="enable-manifest-backup"> <help short="Flag to indicate if disk manifest should be backed-up in the Storage Account."/> <default value="false"/> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection" options="import-disk-details-collection"> <help short="Contains the map of disk serial number to the disk details for import jobs."/> <additionalProp> <item type="object"> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.bitLockerKey" options="bit-locker-key" required="True"> <help short="BitLocker key used to encrypt the disk."/> </arg> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.manifestFile" options="manifest-file" required="True"> <help short="The relative path of the manifest file on the disk."/> </arg> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.manifestHash" options="manifest-hash" required="True"> <help short="The Base16-encoded MD5 hash of the manifest file on the disk."/> </arg> </item> </additionalProp> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails" options="return-to-customer-package-details" required="True"> <help short="Return package shipping details."/> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.carrierAccountNumber" options="carrier-account-number"> <help short="Carrier Account Number of customer for customer disk."/> </arg> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.carrierName" options="carrier-name"> <help short="Name of the carrier."/> </arg> <arg type="string" var="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.trackingId" options="tracking-id"> <help short="Tracking Id of shipment."/> </arg> </arg> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxDisk" options="data-box-disk" group="Details"> <help short="Databox Heavy Device Job Details"/> <arg type="string" var="$jobResource.properties.details.DataBoxDisk.passkey" options="passkey"> <help short="User entered passkey for DataBox Disk job."/> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxDisk.preferredDisks" options="preferred-disks"> <help short="User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int."/> <additionalProp> <item type="integer32"/> </additionalProp> </arg> </arg> <arg type="object" var="$jobResource.properties.details.DataBoxHeavy" options="data-box-heavy" group="Details"> <help short="Databox Heavy Device Job Details"/> <arg type="string" var="$jobResource.properties.details.DataBoxHeavy.devicePassword" options="device-password"> <help short="Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+"/> </arg> </arg> <arg type="array<object>" var="$jobResource.properties.details.dataExportDetails" options="data-export-details" group="Details"> <help short="Details of the data to be exported from azure."/> <item type="object"> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].accountDetails" options="account-details" required="True"> <help short="Account details of the data to be transferred"/> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk" options="managed-disk"> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk.resourceGroupId" options="resource-group-id" required="True"> <help short="Resource Group Id of the compute disks."/> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk.stagingStorageAccountId" options="staging-storage-account-id" required="True"> <help short="Resource Id of the storage account that can be used to copy the vhd for staging."/> </arg> </arg> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].accountDetails.StorageAccount" options="storage-account"> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].accountDetails.StorageAccount.storageAccountId" options="storage-account-id" required="True" group="StorageAccount"> <help short="Storage Account Resource Id."/> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].accountDetails.sharePassword" options="share-password"> <help short="Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+"/> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].logCollectionLevel" options="log-collection-level"> <help short="Level of the logs to be collected."/> <default value=""Error""/> <enum> <item name="Error" value=""Error""/> <item name="Verbose" value=""Verbose""/> </enum> </arg> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration" options="transfer-configuration" required="True"> <help short="Configuration for the data transfer."/> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails" options="transfer-all-details"> <help short="Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll"/> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include" options="include"> <help short="Details to transfer all data."/> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.dataAccountType" options="data-account-type" required="True"> <help short="Type of the account of data"/> <default value=""StorageAccount""/> <enum> <item name="ManagedDisk" value=""ManagedDisk""/> <item name="StorageAccount" value=""StorageAccount""/> </enum> </arg> <arg type="boolean" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.transferAllBlobs" options="transfer-all-blobs"> <help short="To indicate if all Azure blobs have to be transferred"/> </arg> <arg type="boolean" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.transferAllFiles" options="transfer-all-files"> <help short="To indicate if all Azure Files have to be transferred"/> </arg> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferConfigurationType" options="transfer-configuration-type" required="True"> <help short="Type of the configuration for transfer."/> <enum> <item name="TransferAll" value=""TransferAll""/> <item name="TransferUsingFilter" value=""TransferUsingFilter""/> </enum> </arg> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails" options="transfer-filter-details"> <help short="Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter."/> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails" options="azure-file-filter-details" group="Include"> <help short="Filter details to transfer Azure files."/> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.filePathList" options="file-path-list"> <help short="List of full path of the files to be transferred."/> <item type="string"/> </arg> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.filePrefixList" options="file-prefix-list"> <help short="Prefix list of the Azure files to be transferred."/> <item type="string"/> </arg> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.fileShareList" options="file-share-list"> <help short="List of file shares to be transferred."/> <item type="string"/> </arg> </arg> <arg type="object" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails" options="blob-filter-details" group="Include"> <help short="Filter details to transfer blobs."/> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.blobPathList" options="blob-path-list"> <help short="List of full path of the blobs to be transferred."/> <item type="string"/> </arg> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.blobPrefixList" options="blob-prefix-list"> <help short="Prefix list of the Azure blobs to be transferred."/> <item type="string"/> </arg> <arg type="array<string>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.containerList" options="container-list"> <help short="List of blob containers to be transferred."/> <item type="string"/> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.dataAccountType" options="data-account-type" group="Include"> <help short="Type of the account of data."/> <default value=""StorageAccount""/> <enum> <item name="ManagedDisk" value=""ManagedDisk""/> <item name="StorageAccount" value=""StorageAccount""/> </enum> </arg> <arg type="array<object>" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails" options="filter-file-details" group="Include"> <help short="Details of the filter files to be used for data transfer."/> <item type="object"> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails[].filterFilePath" options="filter-file-path" required="True"> <help short="Path of the file that contains the details of all items to transfer."/> </arg> <arg type="string" var="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails[].filterFileType" options="filter-file-type" required="True"> <help short="Type of the filter file."/> <enum> <item name="AzureBlob" value=""AzureBlob""/> <item name="AzureFile" value=""AzureFile""/> </enum> </arg> </item> </arg> </arg> </arg> </item> </arg> <arg type="array<object>" var="$jobResource.properties.details.dataImportDetails" options="data-import-details" group="Details"> <help short="Details of the data to be imported into azure."/> <item type="object"> <arg type="object" var="$jobResource.properties.details.dataImportDetails[].accountDetails" options="account-details" required="True"> <help short="Account details of the data to be transferred"/> <arg type="object" var="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk" options="managed-disk"> <arg type="string" var="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk.resourceGroupId" options="resource-group-id" required="True"> <help short="Resource Group Id of the compute disks."/> </arg> <arg type="string" var="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk.stagingStorageAccountId" options="staging-storage-account-id" required="True"> <help short="Resource Id of the storage account that can be used to copy the vhd for staging."/> </arg> </arg> <arg type="object" var="$jobResource.properties.details.dataImportDetails[].accountDetails.StorageAccount" options="storage-account"> <arg type="string" var="$jobResource.properties.details.dataImportDetails[].accountDetails.StorageAccount.storageAccountId" options="storage-account-id" required="True" group="StorageAccount"> <help short="Storage Account Resource Id."/> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataImportDetails[].accountDetails.sharePassword" options="share-password"> <help short="Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+"/> </arg> </arg> <arg type="string" var="$jobResource.properties.details.dataImportDetails[].logCollectionLevel" options="log-collection-level"> <help short="Level of the logs to be collected."/> <default value=""Error""/> <enum> <item name="Error" value=""Error""/> <item name="Verbose" value=""Verbose""/> </enum> </arg> </item> </arg> <arg type="integer32" var="$jobResource.properties.details.expectedDataSizeInTeraBytes" options="expected-data-size" group="Details"> <help short="The expected size of the data, which needs to be transferred in this job, in terabytes."/> </arg> <arg type="object" var="$jobResource.properties.details.preferences" options="preferences" hide="True" group="Details"> <help short="Preferences for the order."/> <arg type="object" var="$jobResource.properties.details.preferences.encryptionPreferences" options="encryption-preferences"> <help short="Preferences related to the Encryption."/> <arg type="string" var="$jobResource.properties.details.preferences.encryptionPreferences.doubleEncryption" options="double-encryption"> <help short="Defines secondary layer of software-based encryption enablement."/> <default value=""Disabled""/> <enum> <item name="Disabled" value=""Disabled""/> <item name="Enabled" value=""Enabled""/> </enum> </arg> <arg type="string" var="$jobResource.properties.details.preferences.encryptionPreferences.hardwareEncryption" options="hardware-encryption"> <help short="Defines Hardware level encryption (Only for disk)"/> <enum> <item name="Disabled" value=""Disabled""/> <item name="Enabled" value=""Enabled""/> </enum> </arg> </arg> <arg type="array<string>" var="$jobResource.properties.details.preferences.preferredDataCenterRegion" options="preferred-data-center-region"> <help short="Preferred data center region."/> <item type="string"/> </arg> <arg type="@TransportPreferences_create" var="$jobResource.properties.details.preferences.reverseTransportPreferences" options="reverse-transport-preferences"> <help short="Optional Preferences related to the reverse shipment logistics of the sku."/> </arg> <arg type="array<string>" var="$jobResource.properties.details.preferences.storageAccountAccessTierPreferences" options="storage-account-access-tier-preferences"> <help short="Preferences related to the Access Tier of storage accounts."/> <item type="string"> <enum> <item name="Archive" value=""Archive""/> </enum> </item> </arg> <arg type="object" var="$jobResource.properties.details.preferences.transportPreferences" options="transport-preferences" cls="TransportPreferences_create"> <help short="Preferences related to the shipment logistics of the sku."/> <arg type="string" var="@TransportPreferences_create.preferredShipmentType" options="preferred-shipment-type" required="True"> <help short="Indicates Shipment Logistics type that the customer preferred."/> <enum> <item name="CustomerManaged" value=""CustomerManaged""/> <item name="MicrosoftManaged" value=""MicrosoftManaged""/> </enum> </arg> </arg> </arg> <arg type="object" var="$jobResource.properties.details.reverseShippingDetails" options="reverse-shipping-details" hide="True" group="Details"> <help short="Optional Reverse Shipping details for order."/> <arg type="object" var="$jobResource.properties.details.reverseShippingDetails.contactDetails" options="contact-details"> <help short="Contact Info."/> <arg type="string" var="$jobResource.properties.details.reverseShippingDetails.contactDetails.contactName" options="contact-name" required="True"> <help short="Contact name of the person."/> <format minLength="1"/> </arg> <arg type="string" var="$jobResource.properties.details.reverseShippingDetails.contactDetails.mobile" options="mobile"> <help short="Mobile number of the contact person."/> </arg> <arg type="string" var="$jobResource.properties.details.reverseShippingDetails.contactDetails.phone" options="phone" required="True"> <help short="Phone number of the contact person."/> <format minLength="1"/> </arg> <arg type="string" var="$jobResource.properties.details.reverseShippingDetails.contactDetails.phoneExtension" options="phone-extension"> <help short="Phone extension number of the contact person."/> </arg> </arg> <arg type="object" var="$jobResource.properties.details.reverseShippingDetails.shippingAddress" options="shipping-address" cls="ShippingAddress_create"> <arg type="string" var="@ShippingAddress_create.addressType" options="address-type"> <help short="Type of address."/> <default value=""None""/> <enum> <item name="Commercial" value=""Commercial""/> <item name="None" value=""None""/> <item name="Residential" value=""Residential""/> </enum> </arg> <arg type="string" var="@ShippingAddress_create.city" options="city"> <help short="Name of the City."/> </arg> <arg type="string" var="@ShippingAddress_create.companyName" options="company-name"> <help short="Name of the company."/> </arg> <arg type="string" var="@ShippingAddress_create.country" options="country" required="True"> <help short="Name of the Country."/> </arg> <arg type="string" var="@ShippingAddress_create.postalCode" options="postal-code"> <help short="Postal code."/> </arg> <arg type="boolean" var="@ShippingAddress_create.skipAddressValidation" options="skip-address-validation"> <help short="Flag to indicate if customer has chosen to skip default address validation"/> </arg> <arg type="string" var="@ShippingAddress_create.stateOrProvince" options="state-or-province"> <help short="Name of the State or Province."/> </arg> <arg type="string" var="@ShippingAddress_create.streetAddress1" options="street-address1" required="True"> <help short="Street Address line 1."/> </arg> <arg type="string" var="@ShippingAddress_create.streetAddress2" options="street-address2"> <help short="Street Address line 2."/> </arg> <arg type="string" var="@ShippingAddress_create.streetAddress3" options="street-address3"> <help short="Street Address line 3."/> </arg> <arg type="string" var="@ShippingAddress_create.taxIdentificationNumber" options="tax-identification-number"> <help short="Tax Identification Number"/> </arg> <arg type="string" var="@ShippingAddress_create.zipExtendedCode" options="zip-extended-code"> <help short="Extended Zip Code."/> </arg> </arg> </arg> </argGroup> <argGroup name="JobResource"> <arg type="object" var="$jobResource.identity" options="identity" group="JobResource"> <help short="Msi identity of the resource"/> <arg type="string" var="$jobResource.identity.type" options="type"> <help short="Identity type"/> <default value=""None""/> </arg> <arg type="object" var="$jobResource.identity.userAssignedIdentities" options="user-assigned-identities"> <help short="User Assigned Identities"/> <additionalProp> <item type="object"> <blank value="{}"/> </item> </additionalProp> </arg> </arg> <arg type="ResourceLocation" var="$jobResource.location" options="location l" required="True" group="JobResource"> <help short="The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed."/> </arg> <arg type="object" var="$jobResource.tags" options="tags" group="JobResource"> <help short="The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups)."/> <additionalProp> <item type="string"/> </additionalProp> </arg> </argGroup> <argGroup name="KeyEncryptionKey"> <arg type="object" var="$jobResource.properties.details.keyEncryptionKey.identityProperties" options="kek-identity" group="KeyEncryptionKey"> <help short="Managed identity properties used for key encryption."/> <arg type="string" var="$jobResource.properties.details.keyEncryptionKey.identityProperties.type" options="type"> <help short="Managed service identity type."/> </arg> <arg type="object" var="$jobResource.properties.details.keyEncryptionKey.identityProperties.userAssigned" options="user-assigned"> <help short="User assigned identity properties."/> <arg type="string" var="$jobResource.properties.details.keyEncryptionKey.identityProperties.userAssigned.resourceId" options="resource-id"> <help short="Arm resource id for user assigned identity to be used to fetch MSI token."/> </arg> </arg> </arg> <arg type="string" var="$jobResource.properties.details.keyEncryptionKey.kekType" options="kek-type" group="KeyEncryptionKey"> <help short="Type of encryption key used for key encryption."/> <default value=""MicrosoftManaged""/> <enum> <item name="CustomerManaged" value=""CustomerManaged""/> <item name="MicrosoftManaged" value=""MicrosoftManaged""/> </enum> </arg> <arg type="string" var="$jobResource.properties.details.keyEncryptionKey.kekUrl" options="kek-url" group="KeyEncryptionKey"> <help short="Key encryption key. It is required in case of Customer managed KekType."/> </arg> <arg type="string" var="$jobResource.properties.details.keyEncryptionKey.kekVaultResourceID" options="kek-vault-resource-id" group="KeyEncryptionKey"> <help short="Kek vault resource id. It is required in case of Customer managed KekType."/> </arg> </argGroup> <argGroup name="Properties"> <arg type="object" var="$jobResource.properties.deliveryInfo" options="delivery-info" hide="True" group="Properties"> <help short="Delivery Info of Job."/> <arg type="dateTime" var="$jobResource.properties.deliveryInfo.scheduledDateTime" options="scheduled-date-time"> <help short="Scheduled date time."/> </arg> </arg> <arg type="string" var="$jobResource.properties.deliveryType" options="delivery-type" hide="True" group="Properties"> <help short="Delivery type of Job."/> <default value=""NonScheduled""/> <enum> <item name="NonScheduled" value=""NonScheduled""/> <item name="Scheduled" value=""Scheduled""/> </enum> </arg> <arg type="string" var="$jobResource.properties.transferType" options="transfer-type" required="True" group="Properties"> <help short="Type of the data transfer."/> <enum> <item name="ExportFromAzure" value=""ExportFromAzure""/> <item name="ImportToAzure" value=""ImportToAzure""/> </enum> </arg> </argGroup> <argGroup name="ShippingAddress"> <arg type="string" var="$jobResource.properties.details.shippingAddress.addressType" options="address-type" hide="True" group="ShippingAddress"> <help short="address type"/> <default value=""None""/> <enum> <item name="Commercial" value=""Commercial""/> <item name="None" value=""None""/> <item name="Residential" value=""Residential""/> </enum> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.city" options="city" group="ShippingAddress"> <help short="Name of the city."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.companyName" options="company-name" group="ShippingAddress"> <help short="Name of the company."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.country" options="country" group="ShippingAddress"> <help short="Name of the Country."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.postalCode" options="postal-code" group="ShippingAddress"> <help short="Postal code."/> </arg> <arg type="boolean" var="$jobResource.properties.details.shippingAddress.skipAddressValidation" options="skip-address-validation" hide="True" group="ShippingAddress"> <help short="skip address validation"/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.stateOrProvince" options="state-or-province" group="ShippingAddress"> <help short="Name of the State or Province."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.streetAddress1" options="street-address1" group="ShippingAddress"> <help short="Street Address line 1."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.streetAddress2" options="street-address2" group="ShippingAddress"> <help short="Street Address line 2."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.streetAddress3" options="street-address3" group="ShippingAddress"> <help short="Street Address line 3."/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.taxIdentificationNumber" options="tax-identification-number" hide="True" group="ShippingAddress"> <help short="tax identification number"/> </arg> <arg type="string" var="$jobResource.properties.details.shippingAddress.zipExtendedCode" options="zip-extended-code" hide="True" group="ShippingAddress"> <help short="zip extended code"/> </arg> </argGroup> <argGroup name="Sku"> <arg type="string" var="$jobResource.sku.displayName" options="display-name" hide="True" group="Sku"> <help short="The display name of the sku."/> </arg> <arg type="string" var="$jobResource.sku.family" options="family" hide="True" group="Sku"> <help short="The sku family."/> </arg> <arg type="string" var="$jobResource.sku.name" options="sku" required="True" group="Sku"> <help short="The sku name."/> <enum> <item name="DataBox" value=""DataBox""/> <item name="DataBoxCustomerDisk" value=""DataBoxCustomerDisk""/> <item name="DataBoxDisk" value=""DataBoxDisk""/> <item name="DataBoxHeavy" value=""DataBoxHeavy""/> </enum> </arg> </argGroup> <operation operationId="Jobs_Create"> <longRunning finalStateVia="azure-async-operation"/> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}"> <request method="put"> <path> <param type="string" name="jobName" arg="$Path.jobName" required="True"> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/> <param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value=""2022-12-01""/> </const> </query> <body> <json> <schema type="object" name="jobResource" required="True" clientFlatten="True"> <prop type="IdentityObject" name="identity" arg="$jobResource.identity"> <prop type="string" name="type" arg="$jobResource.identity.type"> <default value=""None""/> </prop> <prop type="object" name="userAssignedIdentities" arg="$jobResource.identity.userAssignedIdentities"> <additionalProp> <item type="object"/> </additionalProp> </prop> </prop> <prop type="ResourceLocation" name="location" arg="$jobResource.location" required="True"/> <prop type="object" name="properties" required="True" clientFlatten="True"> <prop type="object" name="deliveryInfo" arg="$jobResource.properties.deliveryInfo"> <prop type="dateTime" name="scheduledDateTime" arg="$jobResource.properties.deliveryInfo.scheduledDateTime"/> </prop> <prop type="string" name="deliveryType" arg="$jobResource.properties.deliveryType"> <default value=""NonScheduled""/> <enum> <item value=""NonScheduled""/> <item value=""Scheduled""/> </enum> </prop> <prop type="object" name="details"> <prop type="object" name="contactDetails" required="True"> <prop type="string" name="contactName" arg="$jobResource.properties.details.contactDetails.contactName" required="True"/> <prop type="array<string>" name="emailList" arg="$jobResource.properties.details.contactDetails.emailList" required="True"> <item type="string"/> </prop> <prop type="string" name="mobile" arg="$jobResource.properties.details.contactDetails.mobile"/> <prop type="array<object>" name="notificationPreference" arg="$jobResource.properties.details.contactDetails.notificationPreference"> <item type="object"> <prop type="boolean" name="sendNotification" arg="$jobResource.properties.details.contactDetails.notificationPreference[].sendNotification" required="True"> <default value="true"/> </prop> <prop type="string" name="stageName" arg="$jobResource.properties.details.contactDetails.notificationPreference[].stageName" required="True"> <enum> <item value=""AtAzureDC""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""PickedUp""/> <item value=""ShippedToCustomer""/> </enum> </prop> </item> </prop> <prop type="string" name="phone" arg="$jobResource.properties.details.contactDetails.phone" required="True"/> <prop type="string" name="phoneExtension" arg="$jobResource.properties.details.contactDetails.phoneExtension"/> </prop> <prop type="array<object>" name="dataExportDetails" arg="$jobResource.properties.details.dataExportDetails"> <item type="object"> <prop type="object" name="accountDetails" arg="$jobResource.properties.details.dataExportDetails[].accountDetails" required="True"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item arg="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk" value=""ManagedDisk""/> <item arg="$jobResource.properties.details.dataExportDetails[].accountDetails.StorageAccount" value=""StorageAccount""/> </enum> </prop> <prop type="string" name="sharePassword" arg="$jobResource.properties.details.dataExportDetails[].accountDetails.sharePassword" secret="True"/> <discriminator property="dataAccountType" value="ManagedDisk"> <prop type="string" name="resourceGroupId" arg="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk.resourceGroupId" required="True"/> <prop type="string" name="stagingStorageAccountId" arg="$jobResource.properties.details.dataExportDetails[].accountDetails.ManagedDisk.stagingStorageAccountId" required="True"/> </discriminator> <discriminator property="dataAccountType" value="StorageAccount"> <prop type="string" name="storageAccountId" arg="$jobResource.properties.details.dataExportDetails[].accountDetails.StorageAccount.storageAccountId" required="True"/> </discriminator> </prop> <prop type="string" name="logCollectionLevel" arg="$jobResource.properties.details.dataExportDetails[].logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> <prop type="object" name="transferConfiguration" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration" required="True"> <prop type="object" name="transferAllDetails" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails"> <prop type="object" name="include" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include"> <prop type="string" name="dataAccountType" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="boolean" name="transferAllBlobs" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.transferAllBlobs"/> <prop type="boolean" name="transferAllFiles" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferAllDetails.include.transferAllFiles"/> </prop> </prop> <prop type="string" name="transferConfigurationType" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferConfigurationType" required="True"> <enum> <item value=""TransferAll""/> <item value=""TransferUsingFilter""/> </enum> </prop> <prop type="object" name="transferFilterDetails" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails"> <prop type="object" name="include"> <prop type="object" name="azureFileFilterDetails" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails"> <prop type="array<string>" name="filePathList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.filePathList"> <item type="string"/> </prop> <prop type="array<string>" name="filePrefixList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.filePrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="fileShareList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.azureFileFilterDetails.fileShareList"> <item type="string"/> </prop> </prop> <prop type="object" name="blobFilterDetails" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails"> <prop type="array<string>" name="blobPathList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.blobPathList"> <item type="string"/> </prop> <prop type="array<string>" name="blobPrefixList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.blobPrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="containerList" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.blobFilterDetails.containerList"> <item type="string"/> </prop> </prop> <prop type="string" name="dataAccountType" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="array<object>" name="filterFileDetails" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails"> <item type="object"> <prop type="string" name="filterFilePath" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails[].filterFilePath" required="True"/> <prop type="string" name="filterFileType" arg="$jobResource.properties.details.dataExportDetails[].transferConfiguration.transferFilterDetails.include.filterFileDetails[].filterFileType" required="True"> <enum> <item value=""AzureBlob""/> <item value=""AzureFile""/> </enum> </prop> </item> </prop> </prop> </prop> </prop> </item> </prop> <prop type="array<object>" name="dataImportDetails" arg="$jobResource.properties.details.dataImportDetails"> <item type="object"> <prop type="object" name="accountDetails" arg="$jobResource.properties.details.dataImportDetails[].accountDetails" required="True"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item arg="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk" value=""ManagedDisk""/> <item arg="$jobResource.properties.details.dataImportDetails[].accountDetails.StorageAccount" value=""StorageAccount""/> </enum> </prop> <prop type="string" name="sharePassword" arg="$jobResource.properties.details.dataImportDetails[].accountDetails.sharePassword" secret="True"/> <discriminator property="dataAccountType" value="ManagedDisk"> <prop type="string" name="resourceGroupId" arg="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk.resourceGroupId" required="True"/> <prop type="string" name="stagingStorageAccountId" arg="$jobResource.properties.details.dataImportDetails[].accountDetails.ManagedDisk.stagingStorageAccountId" required="True"/> </discriminator> <discriminator property="dataAccountType" value="StorageAccount"> <prop type="string" name="storageAccountId" arg="$jobResource.properties.details.dataImportDetails[].accountDetails.StorageAccount.storageAccountId" required="True"/> </discriminator> </prop> <prop type="string" name="logCollectionLevel" arg="$jobResource.properties.details.dataImportDetails[].logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> </item> </prop> <prop type="integer32" name="expectedDataSizeInTeraBytes" arg="$jobResource.properties.details.expectedDataSizeInTeraBytes"/> <prop type="string" name="jobDetailsType" required="True"> <enum> <item arg="$jobResource.properties.details.DataBox" value=""DataBox""/> <item arg="$jobResource.properties.details.DataBoxCustomerDisk" value=""DataBoxCustomerDisk""/> <item arg="$jobResource.properties.details.DataBoxDisk" value=""DataBoxDisk""/> <item arg="$jobResource.properties.details.DataBoxHeavy" value=""DataBoxHeavy""/> </enum> </prop> <prop type="object" name="keyEncryptionKey"> <prop type="object" name="identityProperties" arg="$jobResource.properties.details.keyEncryptionKey.identityProperties"> <prop type="string" name="type" arg="$jobResource.properties.details.keyEncryptionKey.identityProperties.type"/> <prop type="object" name="userAssigned" arg="$jobResource.properties.details.keyEncryptionKey.identityProperties.userAssigned"> <prop type="string" name="resourceId" arg="$jobResource.properties.details.keyEncryptionKey.identityProperties.userAssigned.resourceId"/> </prop> </prop> <prop type="string" name="kekType" arg="$jobResource.properties.details.keyEncryptionKey.kekType" required="True"> <default value=""MicrosoftManaged""/> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> <prop type="string" name="kekUrl" arg="$jobResource.properties.details.keyEncryptionKey.kekUrl"/> <prop type="string" name="kekVaultResourceID" arg="$jobResource.properties.details.keyEncryptionKey.kekVaultResourceID"/> </prop> <prop type="object" name="preferences" arg="$jobResource.properties.details.preferences"> <prop type="object" name="encryptionPreferences" arg="$jobResource.properties.details.preferences.encryptionPreferences"> <prop type="string" name="doubleEncryption" arg="$jobResource.properties.details.preferences.encryptionPreferences.doubleEncryption"> <default value=""Disabled""/> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> <prop type="string" name="hardwareEncryption" arg="$jobResource.properties.details.preferences.encryptionPreferences.hardwareEncryption"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> </prop> <prop type="array<string>" name="preferredDataCenterRegion" arg="$jobResource.properties.details.preferences.preferredDataCenterRegion"> <item type="string"/> </prop> <prop type="@TransportPreferences_create" name="reverseTransportPreferences" arg="$jobResource.properties.details.preferences.reverseTransportPreferences"/> <prop type="array<string>" name="storageAccountAccessTierPreferences" arg="$jobResource.properties.details.preferences.storageAccountAccessTierPreferences"> <item type="string"> <enum> <item value=""Archive""/> </enum> </item> </prop> <prop type="object" name="transportPreferences" arg="$jobResource.properties.details.preferences.transportPreferences" cls="TransportPreferences_create"> <prop type="string" name="preferredShipmentType" arg="@TransportPreferences_create.preferredShipmentType" required="True"> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> </prop> </prop> <prop type="object" name="reverseShippingDetails" arg="$jobResource.properties.details.reverseShippingDetails"> <prop type="object" name="contactDetails" arg="$jobResource.properties.details.reverseShippingDetails.contactDetails"> <prop type="string" name="contactName" arg="$jobResource.properties.details.reverseShippingDetails.contactDetails.contactName" required="True"> <format minLength="1"/> </prop> <prop type="string" name="mobile" arg="$jobResource.properties.details.reverseShippingDetails.contactDetails.mobile"/> <prop type="string" name="phone" arg="$jobResource.properties.details.reverseShippingDetails.contactDetails.phone" required="True"> <format minLength="1"/> </prop> <prop type="string" name="phoneExtension" arg="$jobResource.properties.details.reverseShippingDetails.contactDetails.phoneExtension"/> </prop> <prop type="object" name="shippingAddress" arg="$jobResource.properties.details.reverseShippingDetails.shippingAddress" cls="ShippingAddress_create"> <prop type="string" name="addressType" arg="@ShippingAddress_create.addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city" arg="@ShippingAddress_create.city"/> <prop type="string" name="companyName" arg="@ShippingAddress_create.companyName"/> <prop type="string" name="country" arg="@ShippingAddress_create.country" required="True"/> <prop type="string" name="postalCode" arg="@ShippingAddress_create.postalCode"/> <prop type="boolean" name="skipAddressValidation" arg="@ShippingAddress_create.skipAddressValidation"/> <prop type="string" name="stateOrProvince" arg="@ShippingAddress_create.stateOrProvince"/> <prop type="string" name="streetAddress1" arg="@ShippingAddress_create.streetAddress1" required="True"/> <prop type="string" name="streetAddress2" arg="@ShippingAddress_create.streetAddress2"/> <prop type="string" name="streetAddress3" arg="@ShippingAddress_create.streetAddress3"/> <prop type="string" name="taxIdentificationNumber" arg="@ShippingAddress_create.taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode" arg="@ShippingAddress_create.zipExtendedCode"/> </prop> </prop> <prop type="object" name="shippingAddress"> <prop type="string" name="addressType" arg="$jobResource.properties.details.shippingAddress.addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city" arg="$jobResource.properties.details.shippingAddress.city"/> <prop type="string" name="companyName" arg="$jobResource.properties.details.shippingAddress.companyName"/> <prop type="string" name="country" arg="$jobResource.properties.details.shippingAddress.country" required="True"/> <prop type="string" name="postalCode" arg="$jobResource.properties.details.shippingAddress.postalCode"/> <prop type="boolean" name="skipAddressValidation" arg="$jobResource.properties.details.shippingAddress.skipAddressValidation"/> <prop type="string" name="stateOrProvince" arg="$jobResource.properties.details.shippingAddress.stateOrProvince"/> <prop type="string" name="streetAddress1" arg="$jobResource.properties.details.shippingAddress.streetAddress1" required="True"/> <prop type="string" name="streetAddress2" arg="$jobResource.properties.details.shippingAddress.streetAddress2"/> <prop type="string" name="streetAddress3" arg="$jobResource.properties.details.shippingAddress.streetAddress3"/> <prop type="string" name="taxIdentificationNumber" arg="$jobResource.properties.details.shippingAddress.taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode" arg="$jobResource.properties.details.shippingAddress.zipExtendedCode"/> </prop> <discriminator property="jobDetailsType" value="DataBox"> <prop type="string" name="devicePassword" arg="$jobResource.properties.details.DataBox.devicePassword"/> </discriminator> <discriminator property="jobDetailsType" value="DataBoxCustomerDisk"> <prop type="boolean" name="enableManifestBackup" arg="$jobResource.properties.details.DataBoxCustomerDisk.enableManifestBackup"> <default value="false"/> </prop> <prop type="object" name="importDiskDetailsCollection" arg="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection"> <additionalProp> <item type="object"> <prop type="string" name="bitLockerKey" arg="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.bitLockerKey" required="True" secret="True"/> <prop type="string" name="manifestFile" arg="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.manifestFile" required="True"/> <prop type="string" name="manifestHash" arg="$jobResource.properties.details.DataBoxCustomerDisk.importDiskDetailsCollection{}.manifestHash" required="True"/> </item> </additionalProp> </prop> <prop type="object" name="returnToCustomerPackageDetails" arg="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails" required="True"> <prop type="string" name="carrierAccountNumber" arg="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.carrierAccountNumber" secret="True"/> <prop type="string" name="carrierName" arg="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.carrierName"/> <prop type="string" name="trackingId" arg="$jobResource.properties.details.DataBoxCustomerDisk.returnToCustomerPackageDetails.trackingId"/> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxDisk"> <prop type="string" name="passkey" arg="$jobResource.properties.details.DataBoxDisk.passkey"/> <prop type="object" name="preferredDisks" arg="$jobResource.properties.details.DataBoxDisk.preferredDisks"> <additionalProp> <item type="integer32"/> </additionalProp> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxHeavy"> <prop type="string" name="devicePassword" arg="$jobResource.properties.details.DataBoxHeavy.devicePassword"/> </discriminator> </prop> <prop type="string" name="transferType" arg="$jobResource.properties.transferType" required="True"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </prop> <prop type="object" name="sku" required="True"> <prop type="string" name="displayName" arg="$jobResource.sku.displayName"/> <prop type="string" name="family" arg="$jobResource.sku.family"/> <prop type="string" name="name" arg="$jobResource.sku.name" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> </prop> <prop type="object" name="tags" arg="$jobResource.tags"> <additionalProp> <item type="string"/> </additionalProp> </prop> </schema> </json> </body> </request> <response statusCode="200"> <body> <json var="$Instance"> <schema type="object"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.DataBox/jobs/{}"/> </prop> <prop type="IdentityObject" name="identity"> <prop readOnly="True" type="string" name="principalId"/> <prop readOnly="True" type="string" name="tenantId"/> <prop type="string" name="type"> <default value=""None""/> </prop> <prop type="object" name="userAssignedIdentities"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="clientId"/> <prop readOnly="True" type="string" name="principalId"/> </item> </additionalProp> </prop> </prop> <prop type="ResourceLocation" name="location" required="True"/> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" required="True" clientFlatten="True"> <prop readOnly="True" type="string" name="cancellationReason"/> <prop type="object" name="deliveryInfo"> <prop type="dateTime" name="scheduledDateTime"/> </prop> <prop type="string" name="deliveryType"> <default value=""NonScheduled""/> <enum> <item value=""NonScheduled""/> <item value=""Scheduled""/> </enum> </prop> <prop type="object" name="details"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="string" name="chainOfCustodySasKey"/> <prop type="object" name="contactDetails" required="True"> <prop type="string" name="contactName" required="True"/> <prop type="array<string>" name="emailList" required="True"> <item type="string"/> </prop> <prop type="string" name="mobile"/> <prop type="array<object>" name="notificationPreference"> <item type="object"> <prop type="boolean" name="sendNotification" required="True"> <default value="true"/> </prop> <prop type="string" name="stageName" required="True"> <enum> <item value=""AtAzureDC""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""PickedUp""/> <item value=""ShippedToCustomer""/> </enum> </prop> </item> </prop> <prop type="string" name="phone" required="True"/> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="array<object>" name="copyLogDetails"> <item type="object"> <prop type="string" name="copyLogDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <discriminator property="copyLogDetailsType" value="DataBox"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="string" name="copyLogLink"/> <prop readOnly="True" type="string" name="copyVerboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="string" name="diskSerialNumber"/> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="array<string>" name="copyLogLink"> <item type="string"/> </prop> <prop readOnly="True" type="array<string>" name="copyVerboseLogLink"> <item type="string"/> </prop> </discriminator> </item> </prop> <prop readOnly="True" type="string" name="dataCenterCode"> <enum> <item value=""AM2""/> <item value=""AMS06""/> <item value=""AMS20""/> <item value=""AUH20""/> <item value=""AdHoc""/> <item value=""BJB""/> <item value=""BJS20""/> <item value=""BL20""/> <item value=""BL7""/> <item value=""BN1""/> <item value=""BN7""/> <item value=""BOM01""/> <item value=""BY1""/> <item value=""BY2""/> <item value=""BY21""/> <item value=""BY24""/> <item value=""CBR20""/> <item value=""CH1""/> <item value=""CPQ02""/> <item value=""CPQ20""/> <item value=""CWL20""/> <item value=""CYS04""/> <item value=""DSM05""/> <item value=""DUB07""/> <item value=""FRA22""/> <item value=""HKG20""/> <item value=""Invalid""/> <item value=""JNB21""/> <item value=""JNB22""/> <item value=""LON24""/> <item value=""MAA01""/> <item value=""MEL23""/> <item value=""MNZ21""/> <item value=""MWH01""/> <item value=""ORK70""/> <item value=""OSA02""/> <item value=""OSA20""/> <item value=""OSA22""/> <item value=""PAR22""/> <item value=""PNQ01""/> <item value=""PUS20""/> <item value=""SEL20""/> <item value=""SEL21""/> <item value=""SG2""/> <item value=""SHA03""/> <item value=""SIN20""/> <item value=""SN5""/> <item value=""SN6""/> <item value=""SN8""/> <item value=""SSE90""/> <item value=""SVG20""/> <item value=""SYD03""/> <item value=""SYD23""/> <item value=""TYO01""/> <item value=""TYO22""/> <item value=""YQB20""/> <item value=""YTO20""/> <item value=""YTO21""/> <item value=""ZRH20""/> </enum> </prop> <prop type="array<object>" name="dataExportDetails"> <item type="object"> <prop type="@DataAccountDetails_read" name="accountDetails" required="True"/> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> <prop type="object" name="transferConfiguration" required="True"> <prop type="object" name="transferAllDetails"> <prop type="object" name="include"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="boolean" name="transferAllBlobs"/> <prop type="boolean" name="transferAllFiles"/> </prop> </prop> <prop type="string" name="transferConfigurationType" required="True"> <enum> <item value=""TransferAll""/> <item value=""TransferUsingFilter""/> </enum> </prop> <prop type="object" name="transferFilterDetails"> <prop type="object" name="include"> <prop type="object" name="azureFileFilterDetails"> <prop type="array<string>" name="filePathList"> <item type="string"/> </prop> <prop type="array<string>" name="filePrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="fileShareList"> <item type="string"/> </prop> </prop> <prop type="object" name="blobFilterDetails"> <prop type="array<string>" name="blobPathList"> <item type="string"/> </prop> <prop type="array<string>" name="blobPrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="containerList"> <item type="string"/> </prop> </prop> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="array<object>" name="filterFileDetails"> <item type="object"> <prop type="string" name="filterFilePath" required="True"/> <prop type="string" name="filterFileType" required="True"> <enum> <item value=""AzureBlob""/> <item value=""AzureFile""/> </enum> </prop> </item> </prop> </prop> </prop> </prop> </item> </prop> <prop type="array<object>" name="dataImportDetails"> <item type="object"> <prop type="object" name="accountDetails" required="True" cls="DataAccountDetails_read"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <discriminator property="dataAccountType" value="ManagedDisk"> <prop type="string" name="resourceGroupId" required="True"/> <prop type="string" name="stagingStorageAccountId" required="True"/> </discriminator> <discriminator property="dataAccountType" value="StorageAccount"> <prop type="string" name="storageAccountId" required="True"/> </discriminator> </prop> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> </item> </prop> <prop type="object" name="datacenterAddress"> <prop readOnly="True" type="string" name="dataCenterAzureLocation"/> <prop type="string" name="datacenterAddressType" required="True"> <enum> <item value=""DatacenterAddressInstruction""/> <item value=""DatacenterAddressLocation""/> </enum> </prop> <prop readOnly="True" type="array<string>" name="supportedCarriersForReturnShipment"> <item type="string"/> </prop> <discriminator property="datacenterAddressType" value="DatacenterAddressInstruction"> <prop readOnly="True" type="string" name="communicationInstruction"/> </discriminator> <discriminator property="datacenterAddressType" value="DatacenterAddressLocation"> <prop readOnly="True" type="string" name="additionalShippingInformation"/> <prop readOnly="True" type="string" name="addressType"/> <prop readOnly="True" type="string" name="city"/> <prop readOnly="True" type="string" name="company"/> <prop readOnly="True" type="string" name="contactPersonName"/> <prop readOnly="True" type="string" name="country"/> <prop readOnly="True" type="string" name="phone"/> <prop readOnly="True" type="string" name="phoneExtension"/> <prop readOnly="True" type="string" name="state"/> <prop readOnly="True" type="string" name="street1"/> <prop readOnly="True" type="string" name="street2"/> <prop readOnly="True" type="string" name="street3"/> <prop readOnly="True" type="string" name="zip"/> </discriminator> </prop> <prop type="object" name="deliveryPackage" cls="PackageShippingDetails_read"> <prop readOnly="True" type="string" name="carrierName"/> <prop readOnly="True" type="string" name="trackingId"/> <prop readOnly="True" type="string" name="trackingUrl"/> </prop> <prop type="object" name="deviceErasureDetails"> <prop readOnly="True" type="string" name="deviceErasureStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="string" name="erasureOrDestructionCertificateSasKey"/> </prop> <prop type="integer32" name="expectedDataSizeInTeraBytes"/> <prop type="string" name="jobDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="array<object>" name="jobStages"> <item type="object"> <prop readOnly="True" type="string" name="displayName"/> <prop readOnly="True" type="string" name="stageName"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop readOnly="True" type="string" name="stageStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="stageTime"/> </item> </prop> <prop type="object" name="keyEncryptionKey"> <prop type="object" name="identityProperties"> <prop type="string" name="type"/> <prop type="object" name="userAssigned"> <prop type="string" name="resourceId"/> </prop> </prop> <prop type="string" name="kekType" required="True"> <default value=""MicrosoftManaged""/> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> <prop type="string" name="kekUrl"/> <prop type="string" name="kekVaultResourceID"/> </prop> <prop type="object" name="lastMitigationActionOnJob"> <prop type="dateTime" name="actionDateTimeInUtc"/> <prop type="string" name="customerResolution"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </prop> <prop type="boolean" name="isPerformedByCustomer"/> </prop> <prop type="object" name="preferences"> <prop type="object" name="encryptionPreferences"> <prop type="string" name="doubleEncryption"> <default value=""Disabled""/> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> <prop type="string" name="hardwareEncryption"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> </prop> <prop type="array<string>" name="preferredDataCenterRegion"> <item type="string"/> </prop> <prop type="@TransportPreferences_read" name="reverseTransportPreferences"/> <prop type="array<string>" name="storageAccountAccessTierPreferences"> <item type="string"> <enum> <item value=""Archive""/> </enum> </item> </prop> <prop type="object" name="transportPreferences" cls="TransportPreferences_read"> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="string" name="preferredShipmentType" required="True"> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> </prop> </prop> <prop readOnly="True" type="@PackageShippingDetails_read" name="returnPackage"/> <prop readOnly="True" type="string" name="reverseShipmentLabelSasKey"/> <prop type="object" name="reverseShippingDetails"> <prop type="object" name="contactDetails"> <prop type="string" name="contactName" required="True"> <format minLength="1"/> </prop> <prop type="string" name="mobile"/> <prop type="string" name="phone" required="True"> <format minLength="1"/> </prop> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="@ShippingAddress_read" name="shippingAddress"/> </prop> <prop type="object" name="shippingAddress" cls="ShippingAddress_read"> <prop type="string" name="addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city"/> <prop type="string" name="companyName"/> <prop type="string" name="country" required="True"/> <prop type="string" name="postalCode"/> <prop type="boolean" name="skipAddressValidation"/> <prop type="string" name="stateOrProvince"/> <prop type="string" name="streetAddress1" required="True"/> <prop type="string" name="streetAddress2"/> <prop type="string" name="streetAddress3"/> <prop type="string" name="taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode"/> </prop> <discriminator property="jobDetailsType" value="DataBox"> <prop readOnly="True" type="array<@CopyProgress_read>" name="copyProgress"> <item type="@CopyProgress_read"/> </prop> <prop type="string" name="devicePassword"/> </discriminator> <discriminator property="jobDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="object" name="deliverToDcPackageDetails"> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> <prop type="boolean" name="enableManifestBackup"> <default value="false"/> </prop> <prop readOnly="True" type="object" name="exportDiskDetailsCollection"> <additionalProp readOnly="True"> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop readOnly="True" type="string" name="manifestFile"/> <prop readOnly="True" type="string" name="manifestHash"/> </item> </additionalProp> </prop> <prop type="object" name="importDiskDetailsCollection"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop type="string" name="bitLockerKey" required="True" secret="True"/> <prop type="string" name="manifestFile" required="True"/> <prop type="string" name="manifestHash" required="True"/> </item> </additionalProp> </prop> <prop type="object" name="returnToCustomerPackageDetails" required="True"> <prop type="string" name="carrierAccountNumber" secret="True"/> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesCopied"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer32" name="percentComplete"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> </item> </prop> <prop readOnly="True" type="object" name="disksAndSizeDetails"> <additionalProp readOnly="True"> <item type="integer32"/> </additionalProp> </prop> <prop readOnly="True" type="array<object>" name="granularCopyLogDetails"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop const="True" type="string" name="copyLogDetailsType" required="True"> <default value=""DataBoxCustomerDisk""/> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </item> </prop> <prop readOnly="True" type="array<object>" name="granularCopyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="passkey"/> <prop type="object" name="preferredDisks"> <additionalProp> <item type="integer32"/> </additionalProp> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object" cls="CopyProgress_read"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="devicePassword"/> </discriminator> </prop> <prop type="object" name="error" cls="CloudError_read"> <prop readOnly="True" type="array<object>" name="additionalInfo"> <item type="object"> <prop type="string" name="type"/> </item> </prop> <prop type="string" name="code"/> <prop readOnly="True" type="array<@CloudError_read>" name="details"> <item type="@CloudError_read"/> </prop> <prop type="string" name="message"/> <prop type="string" name="target"/> </prop> <prop readOnly="True" type="boolean" name="isCancellable"/> <prop readOnly="True" type="boolean" name="isCancellableWithoutFee"/> <prop readOnly="True" type="boolean" name="isDeletable"/> <prop readOnly="True" type="boolean" name="isPrepareToShipEnabled"/> <prop readOnly="True" type="boolean" name="isShippingAddressEditable"/> <prop readOnly="True" type="string" name="reverseShippingDetailsUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="string" name="reverseTransportPreferenceUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="startTime"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop type="string" name="transferType" required="True"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </prop> <prop type="object" name="sku" required="True"> <prop type="string" name="displayName"/> <prop type="string" name="family"/> <prop type="string" name="name" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> </prop> <prop type="object" name="systemData"> <prop readOnly="True" type="dateTime" name="createdAt"/> <prop readOnly="True" type="string" name="createdBy"/> <prop readOnly="True" type="string" name="createdByType"/> <prop readOnly="True" type="dateTime" name="lastModifiedAt"/> <prop readOnly="True" type="string" name="lastModifiedBy"/> <prop readOnly="True" type="string" name="lastModifiedByType"/> </prop> <prop type="object" name="tags"> <additionalProp> <item type="string"/> </additionalProp> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response statusCode="202"/> <response isError="True"> <body> <json> <schema type="@ODataV4Format"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> <command name="update" version="2022-12-01"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.databox/jobs/{}" version="2022-12-01" swagger="mgmt-plane/databox/ResourceProviders/Microsoft.DataBox/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRGF0YUJveC9qb2JzL3tqb2JOYW1lfQ==/V/MjAyMi0xMi0wMQ=="/> <argGroup name=""> <arg type="string" var="$Header.If-Match" options="if-match" hide="True" group=""> <help short="Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value."/> </arg> <arg type="string" var="$Path.jobName" options="job-name name n" required="True" idPart="name"> <help short="The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only"/> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> </argGroup> <argGroup name="ContactDetails"> <arg type="string" var="$jobResourceUpdateParameter.properties.details.contactDetails.contactName" options="contact-name" group="ContactDetails"> <help short="Contact name of the person."/> </arg> <arg type="array<string>" var="$jobResourceUpdateParameter.properties.details.contactDetails.emailList" options="email-list" group="ContactDetails"> <help short="List of Email-ids to be notified about job progress."/> <item type="string"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.contactDetails.mobile" options="mobile" group="ContactDetails"> <help short="Mobile number of the contact person."/> </arg> <arg type="array<object>" var="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference" options="notification-preference" hide="True" group="ContactDetails"> <help short="Notification preference for a job stage."/> <item type="object"> <arg type="boolean" var="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference[].sendNotification" options="send-notification" required="True"> <help short="Notification is required or not."/> <default value="true"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference[].stageName" options="stage-name" required="True"> <help short="Name of the stage."/> <enum> <item name="AtAzureDC" value=""AtAzureDC""/> <item name="Created" value=""Created""/> <item name="DataCopy" value=""DataCopy""/> <item name="Delivered" value=""Delivered""/> <item name="DevicePrepared" value=""DevicePrepared""/> <item name="Dispatched" value=""Dispatched""/> <item name="PickedUp" value=""PickedUp""/> <item name="ShippedToCustomer" value=""ShippedToCustomer""/> </enum> </arg> </item> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.contactDetails.phone" options="phone" group="ContactDetails"> <help short="Phone number of the contact person."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.contactDetails.phoneExtension" options="phone-extension" hide="True" group="ContactDetails"> <help short="Phone extension number of the contact person."/> </arg> </argGroup> <argGroup name="Details"> <arg type="object" var="$jobResourceUpdateParameter.properties.details.preferences" options="preferences" hide="True" group="Details"> <help short="Preferences related to the order"/> <arg type="object" var="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences" options="encryption-preferences"> <help short="Preferences related to the Encryption."/> <arg type="string" var="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences.doubleEncryption" options="double-encryption"> <help short="Defines secondary layer of software-based encryption enablement."/> <default value=""Disabled""/> <enum> <item name="Disabled" value=""Disabled""/> <item name="Enabled" value=""Enabled""/> </enum> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences.hardwareEncryption" options="hardware-encryption"> <help short="Defines Hardware level encryption (Only for disk)"/> <enum> <item name="Disabled" value=""Disabled""/> <item name="Enabled" value=""Enabled""/> </enum> </arg> </arg> <arg type="array<string>" var="$jobResourceUpdateParameter.properties.details.preferences.preferredDataCenterRegion" options="preferred-data-center-region"> <help short="Preferred data center region."/> <item type="string"/> </arg> <arg type="@TransportPreferences_update" var="$jobResourceUpdateParameter.properties.details.preferences.reverseTransportPreferences" options="reverse-transport-preferences"> <help short="Optional Preferences related to the reverse shipment logistics of the sku."/> </arg> <arg type="array<string>" var="$jobResourceUpdateParameter.properties.details.preferences.storageAccountAccessTierPreferences" options="storage-account-access-tier-preferences"> <help short="Preferences related to the Access Tier of storage accounts."/> <item type="string"> <enum> <item name="Archive" value=""Archive""/> </enum> </item> </arg> <arg type="object" var="$jobResourceUpdateParameter.properties.details.preferences.transportPreferences" options="transport-preferences" cls="TransportPreferences_update"> <help short="Preferences related to the shipment logistics of the sku."/> <arg type="string" var="@TransportPreferences_update.preferredShipmentType" options="preferred-shipment-type" required="True"> <help short="Indicates Shipment Logistics type that the customer preferred."/> <enum> <item name="CustomerManaged" value=""CustomerManaged""/> <item name="MicrosoftManaged" value=""MicrosoftManaged""/> </enum> </arg> </arg> </arg> <arg type="object" var="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails" options="return-to-customer-package-details" hide="True" group="Details"> <help short="Return package details of job."/> <arg type="string" var="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.carrierAccountNumber" options="carrier-account-number"> <help short="Carrier Account Number of customer for customer disk."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.carrierName" options="carrier-name"> <help short="Name of the carrier."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.trackingId" options="tracking-id"> <help short="Tracking Id of shipment."/> </arg> </arg> <arg type="object" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails" options="reverse-shipping-details" hide="True" group="Details"> <help short="Reverse Shipping Address and contact details for a job."/> <arg type="object" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails" options="contact-details"> <help short="Contact Info."/> <arg type="string" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.contactName" options="contact-name" required="True"> <help short="Contact name of the person."/> <format minLength="1"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.mobile" options="mobile"> <help short="Mobile number of the contact person."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.phone" options="phone" required="True"> <help short="Phone number of the contact person."/> <format minLength="1"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.phoneExtension" options="phone-extension"> <help short="Phone extension number of the contact person."/> </arg> </arg> <arg type="object" var="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.shippingAddress" options="shipping-address" cls="ShippingAddress_update"> <arg type="string" var="@ShippingAddress_update.addressType" options="address-type"> <help short="Type of address."/> <default value=""None""/> <enum> <item name="Commercial" value=""Commercial""/> <item name="None" value=""None""/> <item name="Residential" value=""Residential""/> </enum> </arg> <arg type="string" var="@ShippingAddress_update.city" options="city"> <help short="Name of the City."/> </arg> <arg type="string" var="@ShippingAddress_update.companyName" options="company-name"> <help short="Name of the company."/> </arg> <arg type="string" var="@ShippingAddress_update.country" options="country" required="True"> <help short="Name of the Country."/> </arg> <arg type="string" var="@ShippingAddress_update.postalCode" options="postal-code"> <help short="Postal code."/> </arg> <arg type="boolean" var="@ShippingAddress_update.skipAddressValidation" options="skip-address-validation"> <help short="Flag to indicate if customer has chosen to skip default address validation"/> </arg> <arg type="string" var="@ShippingAddress_update.stateOrProvince" options="state-or-province"> <help short="Name of the State or Province."/> </arg> <arg type="string" var="@ShippingAddress_update.streetAddress1" options="street-address1" required="True"> <help short="Street Address line 1."/> </arg> <arg type="string" var="@ShippingAddress_update.streetAddress2" options="street-address2"> <help short="Street Address line 2."/> </arg> <arg type="string" var="@ShippingAddress_update.streetAddress3" options="street-address3"> <help short="Street Address line 3."/> </arg> <arg type="string" var="@ShippingAddress_update.taxIdentificationNumber" options="tax-identification-number"> <help short="Tax Identification Number"/> </arg> <arg type="string" var="@ShippingAddress_update.zipExtendedCode" options="zip-extended-code"> <help short="Extended Zip Code."/> </arg> </arg> </arg> </argGroup> <argGroup name="JobResourceUpdateParameter"> <arg type="object" var="$jobResourceUpdateParameter.identity" options="identity" hide="True" group="JobResourceUpdateParameter"> <help short="Msi identity of the resource"/> <arg type="string" var="$jobResourceUpdateParameter.identity.type" options="type"> <help short="Identity type"/> <default value=""None""/> </arg> <arg type="object" var="$jobResourceUpdateParameter.identity.userAssignedIdentities" options="user-assigned-identities"> <help short="User Assigned Identities"/> <additionalProp> <item type="object"> <blank value="{}"/> </item> </additionalProp> </arg> </arg> <arg type="object" var="$jobResourceUpdateParameter.tags" options="tags" hide="True" group="JobResourceUpdateParameter"> <help short="The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups)."/> <additionalProp> <item type="string"/> </additionalProp> </arg> </argGroup> <argGroup name="KeyEncryptionKey"> <arg type="object" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties" options="kek-identity" group="KeyEncryptionKey"> <help short="Managed identity properties used for key encryption."/> <arg type="string" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.type" options="type"> <help short="Managed service identity type."/> </arg> <arg type="object" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.userAssigned" options="user-assigned"> <help short="User assigned identity properties."/> <arg type="string" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.userAssigned.resourceId" options="resource-id"> <help short="Arm resource id for user assigned identity to be used to fetch MSI token."/> </arg> </arg> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekType" options="kek-type" group="KeyEncryptionKey"> <help short="Type of encryption key used for key encryption."/> <enum> <item name="CustomerManaged" value=""CustomerManaged""/> <item name="MicrosoftManaged" value=""MicrosoftManaged""/> </enum> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekUrl" options="kek-url" group="KeyEncryptionKey"> <help short="Key encryption key. It is required in case of Customer managed KekType."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekVaultResourceID" options="kek-vault-resource-id" group="KeyEncryptionKey"> <help short="Kek vault resource id. It is required in case of Customer managed KekType."/> </arg> </argGroup> <argGroup name="ShippingAddress"> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.addressType" options="address-type" hide="True" group="ShippingAddress"> <help short="address type"/> <default value=""None""/> <enum> <item name="Commercial" value=""Commercial""/> <item name="None" value=""None""/> <item name="Residential" value=""Residential""/> </enum> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.city" options="city" group="ShippingAddress"> <help short="Name of the city."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.companyName" options="company-name" group="ShippingAddress"> <help short="Name of the company."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.country" options="country" group="ShippingAddress"> <help short="Name of the Country."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.postalCode" options="postal-code" group="ShippingAddress"> <help short="Postal code."/> </arg> <arg type="boolean" var="$jobResourceUpdateParameter.properties.details.shippingAddress.skipAddressValidation" options="skip-address-validation" hide="True" group="ShippingAddress"> <help short="skip address validation"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.stateOrProvince" options="state-or-province" group="ShippingAddress"> <help short="Name of the State or Province."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress1" options="street-address1" group="ShippingAddress"> <help short="Street Address line 1."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress2" options="street-address2" group="ShippingAddress"> <help short="Street Address line 2."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress3" options="street-address3" group="ShippingAddress"> <help short="Street Address line 3."/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.taxIdentificationNumber" options="tax-identification-number" hide="True" group="ShippingAddress"> <help short="tax identification number"/> </arg> <arg type="string" var="$jobResourceUpdateParameter.properties.details.shippingAddress.zipExtendedCode" options="zip-extended-code" hide="True" group="ShippingAddress"> <help short="zip extended code"/> </arg> </argGroup> <operation operationId="Jobs_Update"> <longRunning finalStateVia="azure-async-operation"/> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}"> <request method="patch"> <path> <param type="string" name="jobName" arg="$Path.jobName" required="True"> <format pattern="^[-\w\.]+$" maxLength="24" minLength="3"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/> <param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value=""2022-12-01""/> </const> </query> <header> <param type="string" name="If-Match" arg="$Header.If-Match"/> </header> <body> <json> <schema type="object" name="jobResourceUpdateParameter" required="True" clientFlatten="True"> <prop type="IdentityObject" name="identity" arg="$jobResourceUpdateParameter.identity"> <prop type="string" name="type" arg="$jobResourceUpdateParameter.identity.type"> <default value=""None""/> </prop> <prop type="object" name="userAssignedIdentities" arg="$jobResourceUpdateParameter.identity.userAssignedIdentities"> <additionalProp> <item type="object"/> </additionalProp> </prop> </prop> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="details"> <prop type="object" name="contactDetails"> <prop type="string" name="contactName" arg="$jobResourceUpdateParameter.properties.details.contactDetails.contactName" required="True"/> <prop type="array<string>" name="emailList" arg="$jobResourceUpdateParameter.properties.details.contactDetails.emailList" required="True"> <item type="string"/> </prop> <prop type="string" name="mobile" arg="$jobResourceUpdateParameter.properties.details.contactDetails.mobile"/> <prop type="array<object>" name="notificationPreference" arg="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference"> <item type="object"> <prop type="boolean" name="sendNotification" arg="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference[].sendNotification" required="True"> <default value="true"/> </prop> <prop type="string" name="stageName" arg="$jobResourceUpdateParameter.properties.details.contactDetails.notificationPreference[].stageName" required="True"> <enum> <item value=""AtAzureDC""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""PickedUp""/> <item value=""ShippedToCustomer""/> </enum> </prop> </item> </prop> <prop type="string" name="phone" arg="$jobResourceUpdateParameter.properties.details.contactDetails.phone" required="True"/> <prop type="string" name="phoneExtension" arg="$jobResourceUpdateParameter.properties.details.contactDetails.phoneExtension"/> </prop> <prop type="object" name="keyEncryptionKey"> <prop type="object" name="identityProperties" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties"> <prop type="string" name="type" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.type"/> <prop type="object" name="userAssigned" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.userAssigned"> <prop type="string" name="resourceId" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.identityProperties.userAssigned.resourceId"/> </prop> </prop> <prop type="string" name="kekType" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekType" required="True"> <default value=""MicrosoftManaged""/> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> <prop type="string" name="kekUrl" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekUrl"/> <prop type="string" name="kekVaultResourceID" arg="$jobResourceUpdateParameter.properties.details.keyEncryptionKey.kekVaultResourceID"/> </prop> <prop type="object" name="preferences" arg="$jobResourceUpdateParameter.properties.details.preferences"> <prop type="object" name="encryptionPreferences" arg="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences"> <prop type="string" name="doubleEncryption" arg="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences.doubleEncryption"> <default value=""Disabled""/> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> <prop type="string" name="hardwareEncryption" arg="$jobResourceUpdateParameter.properties.details.preferences.encryptionPreferences.hardwareEncryption"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> </prop> <prop type="array<string>" name="preferredDataCenterRegion" arg="$jobResourceUpdateParameter.properties.details.preferences.preferredDataCenterRegion"> <item type="string"/> </prop> <prop type="@TransportPreferences_update" name="reverseTransportPreferences" arg="$jobResourceUpdateParameter.properties.details.preferences.reverseTransportPreferences"/> <prop type="array<string>" name="storageAccountAccessTierPreferences" arg="$jobResourceUpdateParameter.properties.details.preferences.storageAccountAccessTierPreferences"> <item type="string"> <enum> <item value=""Archive""/> </enum> </item> </prop> <prop type="object" name="transportPreferences" arg="$jobResourceUpdateParameter.properties.details.preferences.transportPreferences" cls="TransportPreferences_update"> <prop type="string" name="preferredShipmentType" arg="@TransportPreferences_update.preferredShipmentType" required="True"> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> </prop> </prop> <prop type="object" name="returnToCustomerPackageDetails" arg="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails"> <prop type="string" name="carrierAccountNumber" arg="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.carrierAccountNumber" secret="True"/> <prop type="string" name="carrierName" arg="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.carrierName"/> <prop type="string" name="trackingId" arg="$jobResourceUpdateParameter.properties.details.returnToCustomerPackageDetails.trackingId"/> </prop> <prop type="object" name="reverseShippingDetails" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails"> <prop type="object" name="contactDetails" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails"> <prop type="string" name="contactName" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.contactName" required="True"> <format minLength="1"/> </prop> <prop type="string" name="mobile" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.mobile"/> <prop type="string" name="phone" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.phone" required="True"> <format minLength="1"/> </prop> <prop type="string" name="phoneExtension" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.contactDetails.phoneExtension"/> </prop> <prop type="object" name="shippingAddress" arg="$jobResourceUpdateParameter.properties.details.reverseShippingDetails.shippingAddress" cls="ShippingAddress_update"> <prop type="string" name="addressType" arg="@ShippingAddress_update.addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city" arg="@ShippingAddress_update.city"/> <prop type="string" name="companyName" arg="@ShippingAddress_update.companyName"/> <prop type="string" name="country" arg="@ShippingAddress_update.country" required="True"/> <prop type="string" name="postalCode" arg="@ShippingAddress_update.postalCode"/> <prop type="boolean" name="skipAddressValidation" arg="@ShippingAddress_update.skipAddressValidation"/> <prop type="string" name="stateOrProvince" arg="@ShippingAddress_update.stateOrProvince"/> <prop type="string" name="streetAddress1" arg="@ShippingAddress_update.streetAddress1" required="True"/> <prop type="string" name="streetAddress2" arg="@ShippingAddress_update.streetAddress2"/> <prop type="string" name="streetAddress3" arg="@ShippingAddress_update.streetAddress3"/> <prop type="string" name="taxIdentificationNumber" arg="@ShippingAddress_update.taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode" arg="@ShippingAddress_update.zipExtendedCode"/> </prop> </prop> <prop type="object" name="shippingAddress"> <prop type="string" name="addressType" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.city"/> <prop type="string" name="companyName" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.companyName"/> <prop type="string" name="country" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.country" required="True"/> <prop type="string" name="postalCode" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.postalCode"/> <prop type="boolean" name="skipAddressValidation" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.skipAddressValidation"/> <prop type="string" name="stateOrProvince" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.stateOrProvince"/> <prop type="string" name="streetAddress1" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress1" required="True"/> <prop type="string" name="streetAddress2" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress2"/> <prop type="string" name="streetAddress3" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.streetAddress3"/> <prop type="string" name="taxIdentificationNumber" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode" arg="$jobResourceUpdateParameter.properties.details.shippingAddress.zipExtendedCode"/> </prop> </prop> </prop> <prop type="object" name="tags" arg="$jobResourceUpdateParameter.tags"> <additionalProp> <item type="string"/> </additionalProp> </prop> </schema> </json> </body> </request> <response statusCode="200"> <body> <json var="$Instance"> <schema type="object"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.DataBox/jobs/{}"/> </prop> <prop type="IdentityObject" name="identity"> <prop readOnly="True" type="string" name="principalId"/> <prop readOnly="True" type="string" name="tenantId"/> <prop type="string" name="type"> <default value=""None""/> </prop> <prop type="object" name="userAssignedIdentities"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="clientId"/> <prop readOnly="True" type="string" name="principalId"/> </item> </additionalProp> </prop> </prop> <prop type="ResourceLocation" name="location" required="True"/> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" required="True" clientFlatten="True"> <prop readOnly="True" type="string" name="cancellationReason"/> <prop type="object" name="deliveryInfo"> <prop type="dateTime" name="scheduledDateTime"/> </prop> <prop type="string" name="deliveryType"> <default value=""NonScheduled""/> <enum> <item value=""NonScheduled""/> <item value=""Scheduled""/> </enum> </prop> <prop type="object" name="details"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="string" name="chainOfCustodySasKey"/> <prop type="object" name="contactDetails" required="True"> <prop type="string" name="contactName" required="True"/> <prop type="array<string>" name="emailList" required="True"> <item type="string"/> </prop> <prop type="string" name="mobile"/> <prop type="array<object>" name="notificationPreference"> <item type="object"> <prop type="boolean" name="sendNotification" required="True"> <default value="true"/> </prop> <prop type="string" name="stageName" required="True"> <enum> <item value=""AtAzureDC""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""PickedUp""/> <item value=""ShippedToCustomer""/> </enum> </prop> </item> </prop> <prop type="string" name="phone" required="True"/> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="array<object>" name="copyLogDetails"> <item type="object"> <prop type="string" name="copyLogDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <discriminator property="copyLogDetailsType" value="DataBox"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="string" name="copyLogLink"/> <prop readOnly="True" type="string" name="copyVerboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="string" name="diskSerialNumber"/> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </discriminator> <discriminator property="copyLogDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="string" name="accountName"/> <prop readOnly="True" type="array<string>" name="copyLogLink"> <item type="string"/> </prop> <prop readOnly="True" type="array<string>" name="copyVerboseLogLink"> <item type="string"/> </prop> </discriminator> </item> </prop> <prop readOnly="True" type="string" name="dataCenterCode"> <enum> <item value=""AM2""/> <item value=""AMS06""/> <item value=""AMS20""/> <item value=""AUH20""/> <item value=""AdHoc""/> <item value=""BJB""/> <item value=""BJS20""/> <item value=""BL20""/> <item value=""BL7""/> <item value=""BN1""/> <item value=""BN7""/> <item value=""BOM01""/> <item value=""BY1""/> <item value=""BY2""/> <item value=""BY21""/> <item value=""BY24""/> <item value=""CBR20""/> <item value=""CH1""/> <item value=""CPQ02""/> <item value=""CPQ20""/> <item value=""CWL20""/> <item value=""CYS04""/> <item value=""DSM05""/> <item value=""DUB07""/> <item value=""FRA22""/> <item value=""HKG20""/> <item value=""Invalid""/> <item value=""JNB21""/> <item value=""JNB22""/> <item value=""LON24""/> <item value=""MAA01""/> <item value=""MEL23""/> <item value=""MNZ21""/> <item value=""MWH01""/> <item value=""ORK70""/> <item value=""OSA02""/> <item value=""OSA20""/> <item value=""OSA22""/> <item value=""PAR22""/> <item value=""PNQ01""/> <item value=""PUS20""/> <item value=""SEL20""/> <item value=""SEL21""/> <item value=""SG2""/> <item value=""SHA03""/> <item value=""SIN20""/> <item value=""SN5""/> <item value=""SN6""/> <item value=""SN8""/> <item value=""SSE90""/> <item value=""SVG20""/> <item value=""SYD03""/> <item value=""SYD23""/> <item value=""TYO01""/> <item value=""TYO22""/> <item value=""YQB20""/> <item value=""YTO20""/> <item value=""YTO21""/> <item value=""ZRH20""/> </enum> </prop> <prop type="array<object>" name="dataExportDetails"> <item type="object"> <prop type="@DataAccountDetails_read" name="accountDetails" required="True"/> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> <prop type="object" name="transferConfiguration" required="True"> <prop type="object" name="transferAllDetails"> <prop type="object" name="include"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="boolean" name="transferAllBlobs"/> <prop type="boolean" name="transferAllFiles"/> </prop> </prop> <prop type="string" name="transferConfigurationType" required="True"> <enum> <item value=""TransferAll""/> <item value=""TransferUsingFilter""/> </enum> </prop> <prop type="object" name="transferFilterDetails"> <prop type="object" name="include"> <prop type="object" name="azureFileFilterDetails"> <prop type="array<string>" name="filePathList"> <item type="string"/> </prop> <prop type="array<string>" name="filePrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="fileShareList"> <item type="string"/> </prop> </prop> <prop type="object" name="blobFilterDetails"> <prop type="array<string>" name="blobPathList"> <item type="string"/> </prop> <prop type="array<string>" name="blobPrefixList"> <item type="string"/> </prop> <prop type="array<string>" name="containerList"> <item type="string"/> </prop> </prop> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop type="array<object>" name="filterFileDetails"> <item type="object"> <prop type="string" name="filterFilePath" required="True"/> <prop type="string" name="filterFileType" required="True"> <enum> <item value=""AzureBlob""/> <item value=""AzureFile""/> </enum> </prop> </item> </prop> </prop> </prop> </prop> </item> </prop> <prop type="array<object>" name="dataImportDetails"> <item type="object"> <prop type="object" name="accountDetails" required="True" cls="DataAccountDetails_read"> <prop type="string" name="dataAccountType" required="True"> <default value=""StorageAccount""/> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <discriminator property="dataAccountType" value="ManagedDisk"> <prop type="string" name="resourceGroupId" required="True"/> <prop type="string" name="stagingStorageAccountId" required="True"/> </discriminator> <discriminator property="dataAccountType" value="StorageAccount"> <prop type="string" name="storageAccountId" required="True"/> </discriminator> </prop> <prop type="string" name="logCollectionLevel"> <default value=""Error""/> <enum> <item value=""Error""/> <item value=""Verbose""/> </enum> </prop> </item> </prop> <prop type="object" name="datacenterAddress"> <prop readOnly="True" type="string" name="dataCenterAzureLocation"/> <prop type="string" name="datacenterAddressType" required="True"> <enum> <item value=""DatacenterAddressInstruction""/> <item value=""DatacenterAddressLocation""/> </enum> </prop> <prop readOnly="True" type="array<string>" name="supportedCarriersForReturnShipment"> <item type="string"/> </prop> <discriminator property="datacenterAddressType" value="DatacenterAddressInstruction"> <prop readOnly="True" type="string" name="communicationInstruction"/> </discriminator> <discriminator property="datacenterAddressType" value="DatacenterAddressLocation"> <prop readOnly="True" type="string" name="additionalShippingInformation"/> <prop readOnly="True" type="string" name="addressType"/> <prop readOnly="True" type="string" name="city"/> <prop readOnly="True" type="string" name="company"/> <prop readOnly="True" type="string" name="contactPersonName"/> <prop readOnly="True" type="string" name="country"/> <prop readOnly="True" type="string" name="phone"/> <prop readOnly="True" type="string" name="phoneExtension"/> <prop readOnly="True" type="string" name="state"/> <prop readOnly="True" type="string" name="street1"/> <prop readOnly="True" type="string" name="street2"/> <prop readOnly="True" type="string" name="street3"/> <prop readOnly="True" type="string" name="zip"/> </discriminator> </prop> <prop type="object" name="deliveryPackage" cls="PackageShippingDetails_read"> <prop readOnly="True" type="string" name="carrierName"/> <prop readOnly="True" type="string" name="trackingId"/> <prop readOnly="True" type="string" name="trackingUrl"/> </prop> <prop type="object" name="deviceErasureDetails"> <prop readOnly="True" type="string" name="deviceErasureStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="string" name="erasureOrDestructionCertificateSasKey"/> </prop> <prop type="integer32" name="expectedDataSizeInTeraBytes"/> <prop type="string" name="jobDetailsType" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="array<object>" name="jobStages"> <item type="object"> <prop readOnly="True" type="string" name="displayName"/> <prop readOnly="True" type="string" name="stageName"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop readOnly="True" type="string" name="stageStatus"> <enum> <item value=""Cancelled""/> <item value=""Cancelling""/> <item value=""CustomerActionPerformed""/> <item value=""CustomerActionPerformedForCleanUp""/> <item value=""Failed""/> <item value=""InProgress""/> <item value=""None""/> <item value=""Succeeded""/> <item value=""SucceededWithErrors""/> <item value=""SucceededWithWarnings""/> <item value=""WaitingForCustomerAction""/> <item value=""WaitingForCustomerActionForCleanUp""/> <item value=""WaitingForCustomerActionForKek""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="stageTime"/> </item> </prop> <prop type="object" name="keyEncryptionKey"> <prop type="object" name="identityProperties"> <prop type="string" name="type"/> <prop type="object" name="userAssigned"> <prop type="string" name="resourceId"/> </prop> </prop> <prop type="string" name="kekType" required="True"> <default value=""MicrosoftManaged""/> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> <prop type="string" name="kekUrl"/> <prop type="string" name="kekVaultResourceID"/> </prop> <prop type="object" name="lastMitigationActionOnJob"> <prop type="dateTime" name="actionDateTimeInUtc"/> <prop type="string" name="customerResolution"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </prop> <prop type="boolean" name="isPerformedByCustomer"/> </prop> <prop type="object" name="preferences"> <prop type="object" name="encryptionPreferences"> <prop type="string" name="doubleEncryption"> <default value=""Disabled""/> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> <prop type="string" name="hardwareEncryption"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> </enum> </prop> </prop> <prop type="array<string>" name="preferredDataCenterRegion"> <item type="string"/> </prop> <prop type="@TransportPreferences_read" name="reverseTransportPreferences"/> <prop type="array<string>" name="storageAccountAccessTierPreferences"> <item type="string"> <enum> <item value=""Archive""/> </enum> </item> </prop> <prop type="object" name="transportPreferences" cls="TransportPreferences_read"> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="string" name="preferredShipmentType" required="True"> <enum> <item value=""CustomerManaged""/> <item value=""MicrosoftManaged""/> </enum> </prop> </prop> </prop> <prop readOnly="True" type="@PackageShippingDetails_read" name="returnPackage"/> <prop readOnly="True" type="string" name="reverseShipmentLabelSasKey"/> <prop type="object" name="reverseShippingDetails"> <prop type="object" name="contactDetails"> <prop type="string" name="contactName" required="True"> <format minLength="1"/> </prop> <prop type="string" name="mobile"/> <prop type="string" name="phone" required="True"> <format minLength="1"/> </prop> <prop type="string" name="phoneExtension"/> </prop> <prop readOnly="True" type="boolean" name="isUpdated"/> <prop type="@ShippingAddress_read" name="shippingAddress"/> </prop> <prop type="object" name="shippingAddress" cls="ShippingAddress_read"> <prop type="string" name="addressType"> <default value=""None""/> <enum> <item value=""Commercial""/> <item value=""None""/> <item value=""Residential""/> </enum> </prop> <prop type="string" name="city"/> <prop type="string" name="companyName"/> <prop type="string" name="country" required="True"/> <prop type="string" name="postalCode"/> <prop type="boolean" name="skipAddressValidation"/> <prop type="string" name="stateOrProvince"/> <prop type="string" name="streetAddress1" required="True"/> <prop type="string" name="streetAddress2"/> <prop type="string" name="streetAddress3"/> <prop type="string" name="taxIdentificationNumber"/> <prop type="string" name="zipExtendedCode"/> </prop> <discriminator property="jobDetailsType" value="DataBox"> <prop readOnly="True" type="array<@CopyProgress_read>" name="copyProgress"> <item type="@CopyProgress_read"/> </prop> <prop type="string" name="devicePassword"/> </discriminator> <discriminator property="jobDetailsType" value="DataBoxCustomerDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="object" name="deliverToDcPackageDetails"> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> <prop type="boolean" name="enableManifestBackup"> <default value="false"/> </prop> <prop readOnly="True" type="object" name="exportDiskDetailsCollection"> <additionalProp readOnly="True"> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop readOnly="True" type="string" name="manifestFile"/> <prop readOnly="True" type="string" name="manifestHash"/> </item> </additionalProp> </prop> <prop type="object" name="importDiskDetailsCollection"> <additionalProp> <item type="object"> <prop readOnly="True" type="string" name="backupManifestCloudPath"/> <prop type="string" name="bitLockerKey" required="True" secret="True"/> <prop type="string" name="manifestFile" required="True"/> <prop type="string" name="manifestHash" required="True"/> </item> </additionalProp> </prop> <prop type="object" name="returnToCustomerPackageDetails" required="True"> <prop type="string" name="carrierAccountNumber" secret="True"/> <prop type="string" name="carrierName"/> <prop type="string" name="trackingId"/> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxDisk"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object"> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesCopied"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer32" name="percentComplete"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> </item> </prop> <prop readOnly="True" type="object" name="disksAndSizeDetails"> <additionalProp readOnly="True"> <item type="integer32"/> </additionalProp> </prop> <prop readOnly="True" type="array<object>" name="granularCopyLogDetails"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop const="True" type="string" name="copyLogDetailsType" required="True"> <default value=""DataBoxCustomerDisk""/> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> <prop readOnly="True" type="string" name="errorLogLink"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="verboseLogLink"/> </item> </prop> <prop readOnly="True" type="array<object>" name="granularCopyProgress"> <item type="object"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="copyStatus"> <enum> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""DeviceFormatted""/> <item value=""DeviceMetadataModified""/> <item value=""DriveCorrupted""/> <item value=""DriveNotDetected""/> <item value=""DriveNotReceived""/> <item value=""Failed""/> <item value=""HardwareError""/> <item value=""InProgress""/> <item value=""MetadataFilesModifiedOrRemoved""/> <item value=""NotReturned""/> <item value=""NotStarted""/> <item value=""OtherServiceError""/> <item value=""OtherUserError""/> <item value=""StorageAccountNotAccessible""/> <item value=""UnsupportedData""/> <item value=""UnsupportedDrive""/> </enum> </prop> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="serialNumber"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="passkey"/> <prop type="object" name="preferredDisks"> <additionalProp> <item type="integer32"/> </additionalProp> </prop> </discriminator> <discriminator property="jobDetailsType" value="DataBoxHeavy"> <prop readOnly="True" type="array<object>" name="copyProgress"> <item type="object" cls="CopyProgress_read"> <prop readOnly="True" type="string" name="accountId"/> <prop readOnly="True" type="array<string>" name="actions"> <item type="string"> <enum> <item value=""MoveToCleanUpDevice""/> <item value=""None""/> <item value=""ReachOutToOperation""/> <item value=""Restart""/> <item value=""Resume""/> </enum> </item> </prop> <prop readOnly="True" type="integer64" name="bytesProcessed"/> <prop readOnly="True" type="string" name="dataAccountType"> <enum> <item value=""ManagedDisk""/> <item value=""StorageAccount""/> </enum> </prop> <prop readOnly="True" type="integer64" name="directoriesErroredOut"/> <prop readOnly="True" type="@CloudError_read" name="error"/> <prop readOnly="True" type="integer64" name="filesErroredOut"/> <prop readOnly="True" type="integer64" name="filesProcessed"/> <prop readOnly="True" type="integer64" name="invalidDirectoriesProcessed"/> <prop readOnly="True" type="integer64" name="invalidFileBytesUploaded"/> <prop readOnly="True" type="integer64" name="invalidFilesProcessed"/> <prop readOnly="True" type="boolean" name="isEnumerationInProgress"/> <prop readOnly="True" type="integer64" name="renamedContainerCount"/> <prop readOnly="True" type="string" name="storageAccountName"/> <prop readOnly="True" type="integer64" name="totalBytesToProcess"/> <prop readOnly="True" type="integer64" name="totalFilesToProcess"/> <prop readOnly="True" type="string" name="transferType"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </item> </prop> <prop type="string" name="devicePassword"/> </discriminator> </prop> <prop type="object" name="error" cls="CloudError_read"> <prop readOnly="True" type="array<object>" name="additionalInfo"> <item type="object"> <prop type="string" name="type"/> </item> </prop> <prop type="string" name="code"/> <prop readOnly="True" type="array<@CloudError_read>" name="details"> <item type="@CloudError_read"/> </prop> <prop type="string" name="message"/> <prop type="string" name="target"/> </prop> <prop readOnly="True" type="boolean" name="isCancellable"/> <prop readOnly="True" type="boolean" name="isCancellableWithoutFee"/> <prop readOnly="True" type="boolean" name="isDeletable"/> <prop readOnly="True" type="boolean" name="isPrepareToShipEnabled"/> <prop readOnly="True" type="boolean" name="isShippingAddressEditable"/> <prop readOnly="True" type="string" name="reverseShippingDetailsUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="string" name="reverseTransportPreferenceUpdate"> <enum> <item value=""Disabled""/> <item value=""Enabled""/> <item value=""NotSupported""/> </enum> </prop> <prop readOnly="True" type="dateTime" name="startTime"/> <prop readOnly="True" type="string" name="status"> <enum> <item value=""Aborted""/> <item value=""AtAzureDC""/> <item value=""AwaitingShipmentDetails""/> <item value=""Cancelled""/> <item value=""Completed""/> <item value=""CompletedWithErrors""/> <item value=""CompletedWithWarnings""/> <item value=""Created""/> <item value=""DataCopy""/> <item value=""Delivered""/> <item value=""DeviceOrdered""/> <item value=""DevicePrepared""/> <item value=""Dispatched""/> <item value=""Failed_IssueDetectedAtAzureDC""/> <item value=""Failed_IssueReportedAtCustomer""/> <item value=""PickedUp""/> <item value=""PreparingToShipFromAzureDC""/> <item value=""ReadyToDispatchFromAzureDC""/> <item value=""ReadyToReceiveAtAzureDC""/> <item value=""ShippedToAzureDC""/> <item value=""ShippedToCustomer""/> </enum> </prop> <prop type="string" name="transferType" required="True"> <enum> <item value=""ExportFromAzure""/> <item value=""ImportToAzure""/> </enum> </prop> </prop> <prop type="object" name="sku" required="True"> <prop type="string" name="displayName"/> <prop type="string" name="family"/> <prop type="string" name="name" required="True"> <enum> <item value=""DataBox""/> <item value=""DataBoxCustomerDisk""/> <item value=""DataBoxDisk""/> <item value=""DataBoxHeavy""/> </enum> </prop> </prop> <prop type="object" name="systemData"> <prop readOnly="True" type="dateTime" name="createdAt"/> <prop readOnly="True" type="string" name="createdBy"/> <prop readOnly="True" type="string" name="createdByType"/> <prop readOnly="True" type="dateTime" name="lastModifiedAt"/> <prop readOnly="True" type="string" name="lastModifiedBy"/> <prop readOnly="True" type="string" name="lastModifiedByType"/> </prop> <prop type="object" name="tags"> <additionalProp> <item type="string"/> </additionalProp> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response statusCode="202"> <header> <item name="Location"/> </header> </response> <response isError="True"> <body> <json> <schema type="@ODataV4Format"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> </commandGroup> </CodeGen>

Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kYXRhYm94L2pvYnMve30=/2022-12-01.xml (4,078 lines of code) (raw):