@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 Device ジョブの詳細
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 キー、消去または破壊ログ SAS キーを含むデバイス消去の詳細
DiskScheduleAvailabilityRequest	ディスク注文をスケジュールするための可用性を取得するための要求本文。
DiskSecret	ディスクのすべてのシークレットを格納します。
EncryptionPreferences	暗号化に関連する基本設定。
ErrorDetail	モデルインターフェース ErrorDetail
ExportDiskDetails	ディスクの詳細をエクスポートする
FilterFileDetails	データ転送に使用するフィルター ファイルの詳細。
GranularCopyLogDetails	コピー中に生成されるログの詳細。
GranularCopyProgress	詳細なコピーの進行状況。
HeavyScheduleAvailabilityRequest	大量の注文をスケジュールするための可用性を取得するための要求本文。
IdentityProperties	マネージド ID のプロパティ。
ImportDiskDetails	ディスクの詳細をインポートする
JobDelayDetails	ジョブ遅延通知の詳細
JobDeliveryInfo	追加の配信情報。
JobDetails	ジョブの詳細。
JobProperties	ジョブプロパティ
JobResource	ジョブ リソース。
JobResourceUpdateParameter	JobResourceUpdateParameter。
JobSecrets	シークレットの基本クラス
JobStages	ジョブ ステージ。
JobsBookShipmentPickUpOptionalParams	省略可能なパラメーター。
JobsCancelOptionalParams	省略可能なパラメーター。
JobsCreateOptionalParams	省略可能なパラメーター。
JobsDeleteOptionalParams	省略可能なパラメーター。
JobsGetOptionalParams	省略可能なパラメーター。
JobsListByResourceGroupOptionalParams	省略可能なパラメーター。
JobsListCredentialsOptionalParams	省略可能なパラメーター。
JobsListOptionalParams	省略可能なパラメーター。
JobsMarkDevicesShippedOptionalParams	省略可能なパラメーター。
JobsOperations	ジョブ操作を表すインターフェイス。
JobsUpdateOptionalParams	省略可能なパラメーター。
KeyEncryptionKey	異なるキーを暗号化するためのキーに関する詳細を含む暗号化キー。
LastMitigationActionOnJob	ジョブで実行された最後の軽減アクション
ManagedDiskDetails	マネージド ディスクの詳細。
MarkDevicesShippedRequest	ジョブの配信パッケージの詳細を提供する要求本文
MitigateJobRequest	Mitigate API の要求本文からキャプチャされた軽減ジョブ
MitigateOptionalParams	省略可能なパラメーター。
NotificationPreference	ジョブ ステージの通知設定。
Operation	操作エンティティ。
OperationDisplay	操作の表示
OperationsListOptionalParams	省略可能なパラメーター。
OperationsOperations	操作操作を表すインターフェイス。
PackageCarrierDetails	パッケージの運送業者の詳細。
PackageCarrierInfo	パッケージの運送業者情報
PackageShippingDetails	パッケージの発送の詳細
PageSettings	byPage メソッドのオプション
PagedAsyncIterableIterator	完了とページごとの非同期反復を可能にするインターフェイス。
Preferences	注文に関連する基本設定
PreferencesValidationRequest	トランスポートとデータ センターの基本設定を検証する要求。
PreferencesValidationResponseProperties	データ センターとトランスポート優先検証応答のプロパティ。
RegionConfigurationRequest	リージョンの構成を取得するための要求本文。
RegionConfigurationResponse	リージョンに固有の構成応答。
Resource	すべての Azure Resource Manager リソースの応答で返される共通フィールド
ResourceIdentity	リソースの Msi ID の詳細
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	ユーザー割り当て ID プロパティ
UserAssignedProperties	ユーザー割り当て ID プロパティ。
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: デバイスが受信されなかったので、コピーはトリガーされません。 サポートされていないDrive: デバイスの種類がサポートされていないため、コピーはトリガーされません。 OtherServiceError: サービス エラーが原因でコピーに失敗しました。 OtherUserError: ユーザー エラーが原因でコピーに失敗しました。 DriveNotDetected: ディスク検出エラーが原因でコピーに失敗しました。 DriveCorrupted: ドライブが破損したため、コピーに失敗しました。 MetadataFilesModifiedOrRemoved: メタデータ ファイルが変更または削除されたため、コピーに失敗しました。
CreatedByType	リソースを作成したエンティティの種類。 KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 ユーザー: エンティティはユーザーによって作成されました。 アプリケーション: エンティティはアプリケーションによって作成されました。 ManagedIdentity: エンティティはマネージド ID によって作成されました。 キー: エンティティはキーによって作成されました。
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 DSM11 AMS25 CPQ21 OSA23
DatacenterAddressResponseUnion	DatacenterAddressResponseUnion の別名
DatacenterAddressType	データ センターのアドレスの種類
DelayNotificationStatus	通知の状況 KnownDelayNotificationStatus DelayNotificationStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 アクティブな: 遅延がまだアクティブです 解決済み: 遅延が解決されました
DoubleEncryption	ソフトウェア ベースの暗号化有効化のセカンダリ レイヤーを定義します。
FilterFileType	フィルター ファイルの種類。
GranularCopyLogDetailsUnion	GranularCopyLogDetailsUnion の別名
HardwareEncryption	特定のリージョンの特定の SKU のハードウェア暗号化サポート。
JobDeliveryType	ジョブの配信の種類。
JobDetailsUnion	JobDetailsUnion の別名
JobSecretsUnion	JobSecretsUnion の別名
KekType	キーの暗号化に使用される暗号化キーの種類。
LogCollectionLevel	収集するログのレベル。
ModelName	デバイスのバージョンと容量の組み合わせのカスタマー フレンドリ名。 このフィールドは、新しい世代のデバイス (AzureDataBox120 と AzureDataBox525) を 2025 年 2 月の時点で注文するときにのみ必要です。
NotificationStageName	ステージの名前。 KnownNotificationStageName NotificationStageName と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 DevicePrepared: デバイス準備段階での通知。 ディスパッチされた: デバイスディスパッチステージでの通知。 配信: デバイス配信段階での通知。 PickedUp: ユーザー ステージから取得したデバイスでの通知。 AtAzureDC: Azure データセンターステージで受信したデバイスでの通知。 DataCopy: データ コピーの開始段階での通知。 作成済み: ジョブ作成ステージでの通知。 ShippedToCustomer: 出荷されたデバイスで顧客のステージに通知します。
OverallValidationStatus	全体的な検証ステータス。
PortalDelayErrorCode	遅延エラーコード KnownPortalDelayErrorCode PortalDelayErrorCode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 InternalIssueDelay: 内部的な理由による遅延 ActiveOrderLimitBreachedDelay: アクティブ注文の制限に違反しました。 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 で破棄できます。 Created: 顧客が作成したジョブ。 ShippedToAzureDC: ユーザーがデバイスを AzureDC に出荷しました。 AwaitingShipmentDetails: 顧客からのデバイスの出荷詳細を待機しています。 PrepareingToShipFromAzureDC: 顧客に出荷するデバイスを準備します。 ShippedToCustomer: デバイスを顧客に出荷しました。
StageStatus	デバイスの消去完了状態を保持します
TransferConfigurationType	転送の構成の種類。
TransferType	転送の種類。
TransportShipmentTypes	特定の地域でサポートされている輸送出荷タイプ。
ValidationInputDiscriminator	検証要求のタイプを識別します。
ValidationInputRequestUnion	ValidationInputRequestUnion のエイリアス
ValidationInputResponseUnion	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