@azure/arm-databox package

類別

DataBoxManagementClient

介面

AccountCredentialDetails	帳戶的認證詳細數據。
AdditionalErrorInfo	這個類別代表發生錯誤時，資源提供者傳遞的其他資訊。
AddressValidationOutput	地址驗證 API 的輸出。
AddressValidationProperties	地址驗證輸出。
ApiError	模型介面 ApiError
ApplianceNetworkConfiguration	DataBox 的網路適配器組態。
AvailableSkuRequest	顯示可用 SKU 的篩選條件。
AzureFileFilterDetails	篩選詳細數據以傳輸 Azure 檔案
BlobFilterDetails	篩選詳細數據以傳輸 Azure Blob
CancellationReason	取消的原因。
CloudError	提供有關 HTTP 錯誤回應的其他資訊。
ContactDetails	聯繫人詳細數據。
ContactInfo	連絡資訊。
CopyLogDetails	複製期間產生的記錄詳細數據。
CopyProgress	複製進度。
CreateJobValidations	它會執行所有作業前建立驗證。
CreateOrderLimitForSubscriptionValidationRequest	要求驗證目前訂用帳戶的建立訂單限制。
CreateOrderLimitForSubscriptionValidationResponseProperties	訂用帳戶驗證回應之建立訂單限制的屬性。
CustomerDiskJobSecrets	與客戶磁碟作業相關的秘密。
DataAccountDetails	要傳輸之數據的帳戶詳細數據
DataBoxAccountCopyLogDetails	複製 DataBox 作業記憶體帳戶的記錄詳細數據
DataBoxCustomerDiskCopyLogDetails	複製客戶磁碟的記錄詳細數據
DataBoxCustomerDiskCopyProgress	DataBox CustomerDisk 複製進度
DataBoxCustomerDiskJobDetails	客戶磁碟作業詳細數據。
DataBoxDiskCopyLogDetails	複製磁碟的記錄詳細數據
DataBoxDiskCopyProgress	DataBox 磁碟複製進度
DataBoxDiskGranularCopyLogDetails	客戶磁碟的細微複製記錄詳細數據
DataBoxDiskGranularCopyProgress	DataBox 磁碟細微複製進度
DataBoxDiskJobDetails	DataBox 磁碟作業詳細數據。
DataBoxDiskJobSecrets	與磁碟作業相關的秘密。
DataBoxHeavyAccountCopyLogDetails	複製 Databox heavy 記憶體帳戶的記錄詳細數據
DataBoxHeavyJobDetails	Databox Heavy 裝置作業詳細數據
DataBoxHeavyJobSecrets	與數據箱繁重作業相關的秘密。
DataBoxHeavySecret	與數據箱繁重相關的秘密。
DataBoxJobDetails	Databox 作業詳細數據
DataBoxManagementClientOptionalParams	用戶端的選擇性參數。
DataBoxScheduleAvailabilityRequest	要求本文以取得排程數據箱訂單的可用性。
DataBoxSecret	與 DataBox 相關的秘密。
DataExportDetails	要用來從 Azure 匯出數據的數據詳細數據。
DataImportDetails	要用來將數據匯入至 Azure 的數據詳細數據。
DataLocationToServiceLocationMap	數據位置與服務位置的對應
DataTransferDetailsValidationRequest	驗證匯出和匯入數據詳細數據的要求。
DataTransferDetailsValidationResponseProperties	數據傳輸的屬性會詳細數據驗證回應。
DataboxJobSecrets	與數據箱作業相關的秘密。
DatacenterAddressInstructionResponse	指定儲存位置的數據中心指示。
DatacenterAddressLocationResponse	指定儲存位置的數據中心位址。
DatacenterAddressRequest	要求本文以取得數據中心位址。
DatacenterAddressResponse	指定儲存位置的數據中心位址。
DcAccessSecurityCode	Dc 存取安全性代碼
Details	模型介面細節
DeviceCapabilityDetails	指定區域的指定 SKU 的裝置功能詳細數據。
DeviceCapabilityRequest	要求本文以取得指定 SKU 的裝置功能。
DeviceCapabilityResponse	區域中指定 SKU 的裝置功能
DeviceErasureDetails	設備擦除詳細資訊，包括擦除完成狀態、安全擦除 sas 金鑰和 erasureordestructionlog sas 金鑰
DiskScheduleAvailabilityRequest	要求本文以取得排程磁碟訂單的可用性。
DiskSecret	包含磁碟的所有秘密。
EncryptionPreferences	與加密相關的喜好設定。
ErrorDetail	模型介面 ErrorDetail
ExportDiskDetails	匯出磁碟詳細數據
FilterFileDetails	要用於數據傳輸之篩選檔案的詳細數據。
GranularCopyLogDetails	複製期間所產生記錄檔的細微詳細數據。
GranularCopyProgress	細微的複製進度。
HeavyScheduleAvailabilityRequest	要求本文以取得排程繁重訂單的可用性。
IdentityProperties	受控識別屬性。
ImportDiskDetails	匯入磁碟詳細數據
JobDelayDetails	作業延遲通知詳細數據
JobDeliveryInfo	其他傳遞資訊。
JobDetails	作業詳細數據。
JobProperties	作業屬性
JobResource	作業資源。
JobResourceUpdateParameter	JobResourceUpdateParameter。
JobSecrets	秘密的基類
JobStages	作業階段。
JobsBookShipmentPickUpOptionalParams	選擇性參數。
JobsCancelOptionalParams	選擇性參數。
JobsCreateOptionalParams	選擇性參數。
JobsDeleteOptionalParams	選擇性參數。
JobsGetOptionalParams	選擇性參數。
JobsListByResourceGroupOptionalParams	選擇性參數。
JobsListCredentialsOptionalParams	選擇性參數。
JobsListOptionalParams	選擇性參數。
JobsMarkDevicesShippedOptionalParams	選擇性參數。
JobsOperations	代表 Jobs 作業的介面。
JobsUpdateOptionalParams	選擇性參數。
KeyEncryptionKey	加密金鑰，包含金鑰加密不同金鑰的詳細資料。
LastMitigationActionOnJob	上次在作業上執行的緩和動作
ManagedDiskDetails	受控磁碟的詳細數據。
MarkDevicesShippedRequest	提供作業傳遞套件詳細數據的要求本文
MitigateJobRequest	從緩和 API 的要求本文擷取的緩和作業
MitigateOptionalParams	選擇性參數。
NotificationPreference	作業階段的通知喜好設定。
Operation	作業實體。
OperationDisplay	作業顯示
OperationsListOptionalParams	選擇性參數。
OperationsOperations	表示作業作業的介面。
PackageCarrierDetails	套件貨運公司詳細數據。
PackageCarrierInfo	套件電信業者資訊
PackageShippingDetails	套件寄送詳細數據
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
Preferences	與訂單相關的喜好設定
PreferencesValidationRequest	要求驗證傳輸和數據中心的喜好設定。
PreferencesValidationResponseProperties	數據中心和傳輸喜好設定驗證回應的屬性。
RegionConfigurationRequest	要求本文以取得區域的組態。
RegionConfigurationResponse	特定區域的組態回應。
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
ResourceIdentity	資源的 Msi 身分識別詳細數據
RestorePollerOptions
ReverseShippingDetails	作業的反向寄送地址和聯繫人詳細數據。
ScheduleAvailabilityRequest	要求本文以取得排程訂單的可用性。
ScheduleAvailabilityResponse	排程區域中指定 SKU 的可用性。
ServiceListAvailableSkusByResourceGroupOptionalParams	選擇性參數。
ServiceOperations	介面代表服務操作。
ServiceRegionConfigurationByResourceGroupOptionalParams	選擇性參數。
ServiceRegionConfigurationOptionalParams	選擇性參數。
ServiceValidateAddressOptionalParams	選擇性參數。
ServiceValidateInputsByResourceGroupOptionalParams	選擇性參數。
ServiceValidateInputsOptionalParams	選擇性參數。
ShareCredentialDetails	帳戶中共用的認證詳細數據。
ShipmentPickUpRequest	出貨取貨要求詳細數據。
ShipmentPickUpResponse	出貨接回回應。
ShippingAddress	客戶想要接收裝置的寄送位址。
SimplePollerLike	簡單的輪詢器，可用來輪詢長時間執行的作業。
Sku	Sku。
SkuAvailabilityValidationRequest	驗證 SKU 可用性的要求。
SkuAvailabilityValidationResponseProperties	SKU 可用性驗證回應的屬性。
SkuCapacity	SKU 的容量。
SkuCost	描述擷取價格資訊的元數據。
SkuInformation	SKU 的資訊。
SkuProperties	SKU 的特性。
StorageAccountDetails	記憶體帳戶的詳細數據。
SubscriptionIsAllowedToCreateJobValidationRequest	要求驗證建立作業的訂用帳戶許可權。
SubscriptionIsAllowedToCreateJobValidationResponseProperties	建立作業驗證回應之訂用帳戶許可權的屬性。
SystemData	與建立和上次修改資源相關的元數據。
TrackedResource	Azure Resource Manager 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」
TransferAllDetails	傳輸所有數據的詳細數據。
TransferConfiguration	定義數據傳輸的組態。
TransferConfigurationTransferAllDetails	篩選類型和詳細數據的對應，以傳輸所有數據。 只有在 TransferConfigurationType 指定為 TransferAll 時，才需要此字段
TransferConfigurationTransferFilterDetails	篩選類型和要篩選的詳細數據對應。 只有在 TransferConfigurationType 指定為 TransferUsingFilter 時，才需要此字段。
TransferFilterDetails	篩選數據傳輸的詳細數據。
TransportAvailabilityDetails	指定區域的傳輸選項可用性詳細數據。
TransportAvailabilityRequest	要求本文以取得指定 SKU 的傳輸可用性。
TransportAvailabilityResponse	區域中指定 SKU 可用的傳輸選項。
TransportPreferences	與 SKU 的出貨物流相關的喜好設定
UnencryptedCredentials	用於存取裝置的未加密認證。
UpdateJobDetails	更新的作業詳細數據。
UpdateJobProperties	工作屬性更新
UserAssignedIdentity	使用者指派的身分識別屬性
UserAssignedProperties	使用者指派的身分識別屬性。
ValidateAddress	驗證客戶位址的需求，需要寄送裝置的位置。
ValidationInputRequest	必須存在於任何類型的驗證要求中的最小欄位。
ValidationInputResponse	每個個別驗證回應中應存在的最小屬性。
ValidationRequest	任何驗證類別的最低要求需求。
ValidationResponse	作業建立前驗證的回應。
ValidationResponseProperties	就業創造前驗證反應的特性。

類型別名

AccessProtocol	裝置上支援的存取通訊協定。
AddressType	位址的類型。
AddressValidationStatus	地址驗證狀態。
AzureSupportedClouds	雲端設定為字串常值類型的支援值
ClassDiscriminator	指出作業詳細數據的類型。
ContinuablePage	描述結果頁面的介面。
CopyLogDetailsUnion	CopyLogDetailsUnion 的別名
CopyStatus	副本狀態 KnownCopyStatus 可以與 CopyStatus 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 NotStarted：數據複製尚未啟動。 InProgress：數據複製正在進行中。 已完成：數據複製已完成。 CompletedWithErrors：數據複製已完成，並出現錯誤。 失敗：數據複製失敗。 未複製任何數據。 NotReturned：未傳回未傳回裝置時觸發任何複製。 HardwareError：裝置發生硬體問題。 DeviceFormatted：數據複製失敗。 裝置已由使用者格式化。 DeviceMetadataModified：數據複製失敗。 裝置元數據已由使用者修改。 StorageAccountNotAccessible：數據複製失敗。 複製期間無法存取記憶體帳戶。 UnsupportedData：數據複製失敗。 不支援裝置數據內容。 DriveNotReceived：未收到裝置時觸發任何複製。 UnsupportedDrive：不支援因為裝置類型而觸發任何複製。 OtherServiceError：複製因服務錯誤而失敗。 OtherUserError：複製因使用者錯誤而失敗。 DriveNotDetected：因為磁碟偵測錯誤而複製失敗。 磁碟驅動器已更正：複製因磁碟驅動器損毀而失敗。 MetadataFilesModifiedOrRemoved：複製因修改或移除元數據檔案而失敗。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：實體是由使用者建立的。 應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。 金鑰：實體是由金鑰所建立。
CustomerResolutionCode	客戶提供的解析代碼。
DataAccountDetailsUnion	DataAccountDetailsUnion 別名
DataAccountType	帳戶的類型。
DataCenterCode	DataCenter 程式代碼。 KnownDataCenterCode 可以與 DataCenterCode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 無效的 BY2 BY1 ORK70 AM2 AMS20 BY21 BY24 MWH01 AMS06 SSE90 SYD03 SYD23 CBR20 YTO20 CWL20 LON24 BOM01 BL20 BL7 SEL20 TYO01 BN1 SN5 CYS04 TYO22 YTO21 YQB20 FRA22 MAA01 CPQ02 CPQ20 SIN20 HKG20 SG2 MEL23 SEL21 OSA20 SHA03 BJB JNB22 JNB21 MNZ21 SN8 AUH20 ZRH20 PUS20 AdHoc CH1 DSM05 DUB07 PNQ01 SVG20 OSA02 OSA22 PAR22 BN7 SN6 BJS20 BL24 IDC5 泰奧23 NTG20 DXB23 帝斯曼11 AMS25 CPQ21 OSA23
DatacenterAddressResponseUnion	DatacenterAddressResponseUnion 的別名
DatacenterAddressType	數據中心地址類型
DelayNotificationStatus	通知狀態 KnownDelayNotificationStatus 可以與 DelayNotificationStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 作用中：延遲仍然作用中 解決：已解決延遲
DoubleEncryption	定義軟體型加密啟用的第二層。
FilterFileType	篩選檔案的類型。
GranularCopyLogDetailsUnion	GranularCopyLogDetailsUnion 別名
HardwareEncryption	指定區域之指定 SKU 的硬體加密支援。
JobDeliveryType	作業的傳遞類型。
JobDetailsUnion	JobDetailsUnion 的別名
JobSecretsUnion	JobSecretsUnion 的別名
KekType	用於金鑰加密的加密金鑰類型。
LogCollectionLevel	要收集的記錄層級。
ModelName	裝置版本和容量組合的客戶易記名稱。 只有在訂購較新一代裝置時，才需要此字段，也就是截至 2025 年 2 月/2025 年 2 月的 AzureDataBox120 和 AzureDataBox525
NotificationStageName	階段的名稱。 KnownNotificationStageName 可以與 NotificationStageName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 DevicePrepared：裝置備妥階段的通知。 分派：裝置分派階段的通知。 已傳遞：裝置傳遞階段的通知。 PickedUp：裝置上從用戶階段挑選的通知。 AtAzureDC：在 Azure 數據中心階段收到的裝置通知。 DataCopy：數據複製開始階段的通知。 建立：作業建立階段的通知。 ShippedToCustomer：將裝置寄送到客戶階段的通知。
OverallValidationStatus	整體驗證狀態。
PortalDelayErrorCode	延遲錯誤代碼 KnownPortalDelayErrorCode 可以與 PortalDelayErrorCode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 InternalIssueDelay：因任何內部原因而延遲 ActiveOrderLimitBreachedDelay：違反 Active Order 限制。 HighDemandDelay： 高需求 LargeNumberOfFilesDelay：由於大量檔案而複製速度緩慢
ReverseShippingDetailsEditStatus	反向寄送地址和聯繫人資訊的可編輯狀態
ReverseTransportPreferenceEditStatus	反向傳輸喜好設定的可編輯狀態
ScheduleAvailabilityRequestUnion	ScheduleAvailabilityRequestUnion 的別名
ShareDestinationFormatType	共用的類型。
SkuDisabledReason	停用 SKU 的原因。
SkuName	SKU 名稱。
StageName	進行中的階段名稱。 KnownStageName 可以與 StageName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 DeviceOrdered：已建立訂單。 DevicePrepared：已針對訂單準備裝置。 分派：裝置已分派給訂單的使用者。 已傳遞：裝置已傳遞給訂單的使用者。 PickedUp：裝置已從使用者和傳輸至 Azure 資料中心。 AtAzureDC：已從使用者收到 Azure 資料中心的裝置。 DataCopy：從 Azure 資料中心的裝置複製數據。 已完成：訂單已完成。 CompletedWithErrors：訂單已完成並出現錯誤。 已取消：訂單已取消。 Failed_IssueReportedAtCustomer：訂單因用戶回報的問題而失敗。 Failed_IssueDetectedAtAzureDC：訂單因 Azure 數據中心偵測到的問題而失敗。 中止：訂單已中止。 CompletedWithWarnings：訂單已完成，並出現警告。 ReadyToDispatchFromAzureDC：裝置已準備好從 Azure DC 傳送給客戶。 ReadyToReceiveAtAzureDC：裝置可以在 Azure DC 卸除。 建立：客戶建立的工作。 ShippedToAzureDC：使用者將裝置運送到 AzureDC。 AwaitingShipmentDetails：等候客戶的裝置出貨詳細數據。 PreparingToShipFromAzureDC：準備裝置寄送給客戶。 ShippedToCustomer：將裝置寄送給客戶。
StageStatus	保留裝置清除完成狀態
TransferConfigurationType	要傳輸的組態類型。
TransferType	傳輸的類型。
TransportShipmentTypes	指定區域支援的運輸貨件類型。
ValidationInputDiscriminator	識別驗證要求的類型。
ValidationInputRequestUnion	ValidationInputRequestUnion 的別名
ValidationInputResponseUnion	驗證輸入回應聯合的別名
ValidationRequestUnion	ValidationRequestUnion 別名
ValidationStatus	建立訂單限制驗證狀態。

列舉

AzureClouds	描述 Azure 雲端環境的列舉。
KnownCopyStatus	複本的狀態
KnownCreatedByType	建立資源的實體種類。
KnownDataCenterCode	DataCenter 程式代碼。
KnownDelayNotificationStatus	通知的狀態
KnownNotificationStageName	階段的名稱。
KnownPortalDelayErrorCode	延遲錯誤碼
KnownStageName	進行中的階段名稱。
KnownVersions	可用的 API 版本。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(DataBoxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e

unknown

catch 子句攔截到的東西。

傳回

e

restorePoller<TResponse, TResult>(DataBoxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

function restorePoller<TResponse, TResult>(client: DataBoxManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client

DataBoxManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor