@azure/arm-imagebuilder package
インターフェイス
| DataDisk |
データディスクの特性。 |
| DistributeVersioner |
配布用に新しい x.y.z バージョン番号を生成する方法について説明します。 |
| DistributeVersionerLatest |
既存のバージョン番号に基づいて最新のバージョン番号を生成します。 |
| DistributeVersionerSource |
ソース イメージのバージョン番号に基づいてバージョン番号を生成します |
| ErrorAdditionalInfo |
リソース管理エラーの追加情報。 |
| ErrorDetail |
エラーの詳細。 |
| ErrorResponse |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 |
| ImageBuilderClientOptionalParams |
クライアントのオプションのパラメーター。 |
| ImageTemplate |
イメージ テンプレートは、Microsoft.VirtualMachineImages プロバイダーによって管理される ARM リソースです |
| ImageTemplateAutoRun |
イメージ テンプレートを作成/更新時にビルドする必要があるかどうかを示します |
| ImageTemplateCustomizer |
イメージのカスタマイズの単位について説明します |
| ImageTemplateDistributor |
ジェネリック分散オブジェクト |
| ImageTemplateFileCustomizer |
VM (Linux、Windows) にファイルをアップロードします。 Packer ファイル プロビジョンタに対応します |
| ImageTemplateFileValidator |
検証に必要なファイルを VM (Linux、Windows) にアップロードします。 Packer ファイル プロビジョンタに対応します |
| ImageTemplateIdentity |
イメージ テンプレートの ID。 |
| ImageTemplateInVMValidator |
イメージの検証 in-VM 単位について説明します |
| ImageTemplateLastRunStatus |
イメージ テンプレートの実行の最新の状態について説明します |
| ImageTemplateManagedImageDistributor |
マネージド ディスク イメージとして配布します。 |
| ImageTemplateManagedImageSource |
顧客サブスクリプションのマネージド イメージであるイメージ ソースについて説明します。 このイメージは、Image Builder テンプレートと同じサブスクリプションとリージョンに存在する必要があります。 |
| ImageTemplatePlatformImageSource |
Azure ギャラリー イメージからのイメージ ソースについて説明します。 |
| ImageTemplatePowerShellCustomizer |
VM (Windows) で指定した PowerShell を実行します。 Packer PowerShell プロビジョニング ツールに対応します。 'scriptUri' または 'inline' のいずれかを指定できます。 |
| ImageTemplatePowerShellValidator |
検証フェーズ (Windows) 中に指定された PowerShell スクリプトを実行します。 Packer PowerShell プロビジョニング ツールに対応します。 'scriptUri' または 'inline' のいずれかを指定できます。 |
| ImageTemplateProperties |
画像テンプレートの特性を記述します |
| ImageTemplatePropertiesErrorHandling |
ビルドエラー時のエラー処理オプション |
| ImageTemplatePropertiesOptimize |
イメージに対して実行する最適化を指定します。 |
| ImageTemplatePropertiesOptimizeVmBoot |
VM の起動を高速化するために、イメージに最適化が適用されます。 |
| ImageTemplatePropertiesOptimizeWorkload |
特定のワークロードに対して最適化が適用されます。 |
| ImageTemplatePropertiesValidate |
結果のイメージに対して実行される構成オプションと検証の一覧。 |
| ImageTemplateRestartCustomizer |
VM を再起動し、VM がオンラインに戻るのを待機します (Windows)。 Packer windows-restart provisioner に対応します |
| ImageTemplateSharedImageDistributor |
Azure コンピューティング ギャラリー経由で配布します。 |
| ImageTemplateSharedImageVersionSource |
Azure コンピューティング ギャラリーまたは直接共有ギャラリーのイメージ バージョンであるイメージ ソースについて説明します。 |
| ImageTemplateShellCustomizer |
カスタマイズ フェーズ (Linux) 中にシェル スクリプトを実行します。 Packer シェル プロビジョンタに対応します。 'scriptUri' または 'inline' のいずれかを指定できます。 |
| ImageTemplateShellValidator |
検証フェーズ (Linux) 中に指定されたシェル スクリプトを実行します。 Packer シェル プロビジョンタに対応します。 'scriptUri' または 'inline' のいずれかを指定できます。 |
| ImageTemplateSource |
構築、カスタマイズ、配布のための仮想マシン イメージ ソースについて説明します |
| ImageTemplateUpdateParameters |
イメージ テンプレートを更新するためのパラメーター。 |
| ImageTemplateUpdateParametersProperties |
イメージ テンプレートを更新するためのパラメーター。 |
| ImageTemplateVhdDistributor |
ストレージ アカウント内の VHD 経由で配布します。 |
| ImageTemplateVmProfile |
イメージのビルドと検証に使用される仮想マシンについて説明します |
| ImageTemplateWindowsUpdateCustomizer |
Windows 更新プログラムをインストールします。 Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update) に対応します。 |
| Operation |
REST API 操作 |
| OperationDisplay |
操作を記述するオブジェクト。 |
| OperationsListOptionalParams |
省略可能なパラメーター。 |
| OperationsOperations |
オペレーション操作を表すインターフェイス。 |
| PageSettings |
byPage メソッドのオプション |
| PagedAsyncIterableIterator |
完了まで、およびページごとに非同期反復可能な反復を許可するインターフェイス。 |
| PlatformImagePurchasePlan |
プラットフォーム イメージの購入プランの構成。 |
| ProvisioningError |
イメージ テンプレートの作成または更新時に発生したエラーについて説明します |
| ProxyResource |
Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません |
| Resource |
すべての Azure Resource Manager リソースの応答で返される共通フィールド |
| RestorePollerOptions | |
| RunOutput |
イメージ テンプレートを実行して作成された出力を表します。 |
| RunOutputProperties |
実行出力の性質を記述します |
| SimplePollerLike |
実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。 |
| SourceImageTriggerProperties |
トリガーの SourceImage の種類のプロパティ |
| SystemData |
リソースの作成と最後の変更に関連するメタデータ。 |
| TargetRegion |
ターゲット リージョンの情報について説明します。 |
| TrackedResource |
Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
| Trigger |
イメージ テンプレート ビルドを呼び出すことができるトリガーを表します。 |
| TriggerProperties |
トリガーのプロパティについて説明します |
| TriggerStatus |
トリガーの状態について説明します |
| TriggersCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| TriggersDeleteOptionalParams |
省略可能なパラメーター。 |
| TriggersGetOptionalParams |
省略可能なパラメーター。 |
| TriggersListByImageTemplateOptionalParams |
省略可能なパラメーター。 |
| TriggersOperations |
トリガー操作を表すインターフェース。 |
| UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
| VirtualMachineImageTemplatesCancelOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesDeleteOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesGetOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesListOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesOperations |
VirtualMachineImageTemplates操作を表すインターフェース。 |
| VirtualMachineImageTemplatesRunOptionalParams |
省略可能なパラメーター。 |
| VirtualMachineImageTemplatesUpdateOptionalParams |
省略可能なパラメーター。 |
| VirtualNetworkConfig |
仮想ネットワークの構成。 |
型エイリアス
| AutoRunState |
このフィールドを有効にすると、イメージ テンプレートの作成または更新時に自動ビルドがトリガーされます。 |
| AzureSupportedClouds |
文字列リテラル型としてのクラウド設定でサポートされている値 |
| ContinuablePage |
結果のページを記述するインターフェース。 |
| CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー: エンティティはユーザーによって作成されました。 |
| DistributeVersionerUnion |
Alias for DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
ImageTemplateCustomizerUnion のエイリアス |
| ImageTemplateDistributorUnion |
ImageTemplateDistributorUnion の別名 |
| ImageTemplateInVMValidatorUnion |
Alias for ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
ImageTemplateSourceUnion のエイリアス |
| OnBuildError |
ビルド失敗時のエラー処理動作 サービスでサポートされている既知の値
クリーンアップ:クリーンアップ |
| ProvisioningErrorCode |
プロビジョニング失敗のエラーコード サービスでサポートされている既知の値
BadSourceType: BadSourceType |
| ProvisioningState |
リソースのプロビジョニング状態 |
| ReplicationMode |
Azure Compute Galleryでの配布のための複製モードについて説明します。 デフォルト(Full)は使わないでください。 サービスでサポートされている既知の値
完全:フルレプリケーションモード |
| ResourceIdentityType |
イメージ テンプレートに使用される ID の種類。 型 'None' は、イメージ テンプレートからすべての ID を削除します。 |
| RunState |
前回の運行状況 |
| RunSubState |
前回の放送のサブステート |
| SharedImageStorageAccountType |
Azure Compute Galleryのイメージバージョンを保存するためのストレージアカウントタイプを指定します。 サービスでサポートされている既知の値
Standard_LRS:Standard_LRS |
| TriggerPropertiesUnion |
TriggerPropertiesUnion の別名 |
| VMBootOptimizationState |
このフィールドを有効にすると、最終的にカスタマイズされたイメージ出力が最適化され、VM の起動時間が短縮されます。 |
| WorkloadOptimizationState |
このフィールドを有効にすると、特定のワークロードに対してVMイメージが最適化されます。 |
列挙型
| AzureClouds |
Azure Cloud 環境を説明するための列挙式です。 |
| KnownCreatedByType |
リソースを作成したエンティティの種類。 |
| KnownOnBuildError |
ビルド失敗時のエラー処理動作 |
| KnownProvisioningErrorCode |
プロビジョニング失敗のエラーコード |
| KnownReplicationMode |
Azure Compute Galleryでの配布のための複製モードについて説明します。 デフォルト(Full)は使わないでください。 |
| KnownSharedImageStorageAccountType |
Azure Compute Galleryのイメージバージョンを保存するためのストレージアカウントタイプを指定します。 |
| KnownVersions |
使用可能な API バージョン。 |
関数
| is |
RestError の Typeguard |
| restore |
別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。 |
変数
| Rest |
失敗したパイプライン要求のカスタム エラーの種類。 |
関数の詳細
isRestError(unknown)
RestError の Typeguard
function isRestError(e: unknown): eパラメーター
- e
-
unknown
catch 句によってキャッチされる何か。
返品
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>パラメーター
- client
- ImageBuilderClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返品
PollerLike<OperationState<TResult>, TResult>