@azure/arm-computefleet package
クラス
AzureFleetClient |
インターフェイス
AdditionalUnattendContent |
Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。 コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。 |
ApiEntityReference |
API エンティティ参照。 |
ApiError |
フリートの ApiError |
ApiErrorBase |
API エラーベース。 |
ApplicationProfile |
VM/VMSS で使用できるようにする必要があるギャラリー アプリケーションの一覧が含まれています |
AzureFleetClientOptionalParams |
クライアントの省略可能なパラメーター。 |
BaseVirtualMachineProfile |
フリートのベース仮想マシン プロファイルについて説明します |
BootDiagnostics |
ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。 コンソール ログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。 |
CapacityReservationProfile |
容量予約プロファイルのパラメーター。 |
ComputeProfile |
ユーザーのワークロードの実行に使用するコンピューティング プロファイル。 |
DiagnosticsProfile |
ブート診断設定の状態を指定します。 最小 API バージョン: 2015-06-15。 |
DiffDiskSettings |
オペレーティング システム ディスクに指定できるエフェメラル ディスク設定のパラメーターについて説明します。 注: エフェメラル ディスクの設定は、マネージド ディスクに対してのみ指定できます。 |
DiskEncryptionSetParameters |
ディスクに指定できるカスタマー マネージド ディスク暗号化セットのリソース ID のパラメーターについて説明します。 注: ディスク暗号化セットのリソース ID は、マネージド ディスクに対してのみ指定できます。 詳細については、https://aka.ms/mdssewithcmkoverview を参照してください。 |
EncryptionIdentity |
キーコンテナー操作のアクセス トークンを取得するために ADE によって使用されるマネージド ID を指定します。 |
ErrorAdditionalInfo |
リソース管理エラーの追加情報。 |
ErrorDetail |
エラーの詳細。 |
ErrorResponse |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 |
Fleet |
コンピューティング フリート リソース |
FleetProperties |
コンピューティング フリートの詳細。 |
FleetUpdate |
フリート更新モデル |
FleetsCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
FleetsDeleteOptionalParams |
省略可能なパラメーター。 |
FleetsGetOptionalParams |
省略可能なパラメーター。 |
FleetsListByResourceGroupOptionalParams |
省略可能なパラメーター。 |
FleetsListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
FleetsListVirtualMachineScaleSetsOptionalParams |
省略可能なパラメーター。 |
FleetsOperations |
フリート操作を表すインターフェイス。 |
FleetsUpdateOptionalParams |
省略可能なパラメーター。 |
ImageReference |
使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 注: イメージ参照パブリッシャーとオファーは、スケール セットの作成時にのみ設定できます。 |
InnerError |
内部エラーの詳細。 |
KeyVaultSecretReference |
Key Vault シークレットへの参照について説明します |
LinuxConfiguration |
仮想マシン上の Linux オペレーティング システムの設定を指定します。 サポートされている Linux ディストリビューションの一覧については、Azure-Endorsed ディストリビューション |
LinuxPatchSettings |
Linux での VM ゲストパッチ適用に関連する設定を指定します。 |
LinuxVMGuestPatchAutomaticByPlatformSettings |
Linux パッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。 |
ManagedServiceIdentity |
マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) |
ManagedServiceIdentityUpdate |
省略可能なプロパティを追加するためのテンプレート。 |
OSImageNotificationProfile |
OS イメージのスケジュールされたイベント関連の構成を指定します。 |
Operation |
リソース プロバイダー操作 API から返される REST API 操作の詳細 |
OperationDisplay |
ローカライズされた表示情報と操作。 |
OperationsListOptionalParams |
省略可能なパラメーター。 |
OperationsOperations |
操作操作を表すインターフェイス。 |
PageSettings |
byPage メソッドのオプション |
PagedAsyncIterableIterator |
完了とページごとの非同期反復を可能にするインターフェイス。 |
PatchSettings |
Windows での VM ゲストパッチ適用に関連する設定を指定します。 |
Plan |
リソースを計画します。 |
ProxyAgentSettings |
仮想マシンの作成時に ProxyAgent の設定を指定します。 最小 API バージョン: 2023-09-01。 |
PublicIPAddressSku |
パブリック IP SKU について説明します。 OrchestrationMode をフレキシブルとしてのみ設定できます。 |
RegularPriorityProfile |
Compute Fleet の標準インスタンスの構成オプション。 |
Resource |
すべての Azure Resource Manager リソースの応答で返される共通フィールド |
ResourcePlanUpdate |
省略可能なプロパティを追加するためのテンプレート。 |
RestorePollerOptions | |
ScheduledEventsProfile |
スケジュールされたイベント関連の構成を指定します。 |
SecurityPostureReference |
スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定します。 最小 API バージョン: 2023-03-01 |
SecurityProfile |
仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 |
ServiceArtifactReference |
"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。 最小 API バージョン: 2022-11-01 |
SpotPriorityProfile |
Compute Fleet のスポット インスタンスの構成オプション。 |
SshConfiguration |
Azure で実行されている Linux ベースの VM の SSH 構成 |
SshPublicKey |
SSH 証明書の公開キーと、公開キーが配置されている Linux VM 上のパスに関する情報が含まれています。 |
SubResource |
SubResource について説明します |
SystemData |
リソースの作成と最後の変更に関連するメタデータ。 |
TerminateNotificationProfile |
Terminate Scheduled Event 関連の構成を指定します。 |
TrackedResource |
Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
UefiSettings |
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 最小 API バージョン: 2020-12-01。 |
UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
VMDiskSecurityProfile |
マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM にのみ設定できます。 |
VMGalleryApplication |
コンピューティング ギャラリー アプリケーションのバージョンを参照するために必要な情報を指定します |
VMSizeProperties |
仮想マシンの VM サイズ プロパティの設定を指定します。 |
VaultCertificate |
Key Vault 内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。 |
VaultSecretGroup |
すべて同じ Key Vault 内にある証明書のセットについて説明します。 |
VirtualHardDisk |
ディスクの URI について説明します。 |
VirtualMachineScaleSet |
AzureFleet の virtualMachineScaleSet |
VirtualMachineScaleSetDataDisk |
仮想マシン スケール セットのデータ ディスクについて説明します。 |
VirtualMachineScaleSetExtension |
仮想マシン スケール セット拡張機能について説明します。 |
VirtualMachineScaleSetExtensionProfile |
仮想マシン スケール セット拡張機能プロファイルについて説明します。 |
VirtualMachineScaleSetExtensionProperties |
仮想マシン スケール セット拡張機能のプロパティについて説明します。 |
VirtualMachineScaleSetHardwareProfile |
仮想マシン スケール セットのハードウェア設定を指定します。 |
VirtualMachineScaleSetIPConfiguration |
仮想マシン スケール セットネットワーク プロファイルの IP 構成について説明します。 |
VirtualMachineScaleSetIPConfigurationProperties |
仮想マシン スケール セットネットワーク プロファイルの IP 構成プロパティについて説明します。 |
VirtualMachineScaleSetIpTag |
パブリック IP アドレスに関連付けられている IP タグを格納します。 |
VirtualMachineScaleSetManagedDiskParameters |
ScaleSet マネージド ディスクのパラメーターについて説明します。 |
VirtualMachineScaleSetNetworkConfiguration |
仮想マシン スケール セットネットワーク プロファイルのネットワーク構成について説明します。 |
VirtualMachineScaleSetNetworkConfigurationDnsSettings |
仮想マシン スケール セットのネットワーク構成の DNS 設定について説明します。 |
VirtualMachineScaleSetNetworkConfigurationProperties |
仮想マシン スケール セットネットワーク プロファイルの IP 構成について説明します。 |
VirtualMachineScaleSetNetworkProfile |
仮想マシン スケール セットのネットワーク プロファイルについて説明します。 |
VirtualMachineScaleSetOSDisk |
仮想マシン スケール セットのオペレーティング システム ディスクについて説明します。 |
VirtualMachineScaleSetOSProfile |
仮想マシン スケール セットの OS プロファイルについて説明します。 |
VirtualMachineScaleSetPublicIPAddressConfiguration |
仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings |
仮想マシン スケール セットのネットワーク構成の DNS 設定について説明します。 |
VirtualMachineScaleSetPublicIPAddressConfigurationProperties |
仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します |
VirtualMachineScaleSetStorageProfile |
仮想マシン スケール セットのストレージ プロファイルについて説明します。 |
VmSizeProfile |
VM サイズに関する仕様。 これには、今後対応するランクと重みも含まれます。 |
WinRMConfiguration |
VM の Windows リモート管理の構成について説明します |
WinRMListener |
Windows リモート管理リスナーのプロトコルと拇印について説明します |
WindowsConfiguration |
仮想マシン上の Windows オペレーティング システムの設定を指定します。 |
WindowsVMGuestPatchAutomaticByPlatformSettings |
Windows のパッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。 |
型エイリアス
ActionType |
拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 サービスでサポートされている既知の値内部 |
CachingTypes |
キャッシュ要件を指定します。 サービスでサポートされている既知の値
なし |
ContinuablePage |
結果のページを記述するインターフェイス。 |
CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー |
DeleteOptions |
VM が削除されたときのネットワーク インターフェイスの動作を指定する サービスでサポートされている既知の値
削除 |
DiffDiskOptions |
オペレーティング システム ディスクのエフェメラル ディスク オプションを指定します。 サービスでサポートされている既知の値ローカル |
DiffDiskPlacement |
オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスクまたはリソース ディスク領域などの場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM のエフェメラル OS ディスク サイズの要件と、NvmeDisk の最小 api バージョン (2024-03-01) https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Linux VM を参照してください。 サービスでサポートされている既知の値
CacheDisk |
DiskControllerTypes |
VM と VirtualMachineScaleSet 用に構成されたディスク コントローラーの種類を指定します。 このプロパティは、オペレーティング システム ディスクと VM SKU が第 2 世代 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2) をサポートしている仮想マシンでのみサポートされています。リージョンの Microsoft.Compute SKU API の応答で VM SKU 機能の一部として返される HyperVGenerations 機能に V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list) が含まれていることを確認してください。 サポートされているディスク コントローラーの種類の詳細については、https://aka.ms/azure-diskcontrollertypesを参照してください。 サービスでサポートされている既知の値SCSI の |
DiskCreateOptionTypes |
仮想マシンの作成方法を指定します。 サービスでサポートされている既知の値FromImage の |
DiskDeleteOptionTypes |
VM が削除されたときのマネージド ディスクの動作を指定します (マネージド ディスクを削除するかデタッチするかなど)。 サポートされている値は、削除です。 この値を使用すると、VM の削除時にマネージド ディスクが削除されます。 切り離す。 この値を使用すると、VM が削除された後もマネージド ディスクが保持されます。 最小 API バージョン: 2021-03-01。 サービスでサポートされている既知の値
削除 |
DomainNameLabelScopeTypes |
ドメイン名ラベルスコープ。ドメイン名ラベル スコープと vm インデックスからポリシーに従って生成されたハッシュ ドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。 サービスでサポートされている既知の値
TenantReuse |
EvictionPolicy |
さまざまな種類の削除ポリシー サービスでサポートされている既知の値
削除 |
IPVersion |
Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 サービスでサポートされている既知の値IPv4 の |
LinuxPatchAssessmentMode |
IaaS 仮想マシンの VM ゲスト パッチ評価のモードを指定します。 サービスでサポートされている既知の値
ImageDefault |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting |
すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。 サービスでサポートされている既知の値
不明な |
LinuxVMGuestPatchMode |
OrchestrationMode をフレキシブルとして使用して、仮想マシン スケール セットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲスト パッチ適用のモードを指定します。 サービスでサポートされている既知の値
ImageDefault |
ManagedServiceIdentityType |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 サービスでサポートされている既知の値
なし |
Mode |
機能が有効になっている場合に ProxyAgent が実行されるモードを指定します。
ProxyAgent は監査または監視を開始しますが、監査モードでエンドポイントをホストする要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。 既定値は [強制モード] です。 サービスでサポートされている既知の値
監査 |
NetworkApiVersion |
は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します サービスでサポートされている既知の値2020-11-01 |
NetworkInterfaceAuxiliaryMode |
ネットワーク インターフェイス リソースに対して補助モードを有効にするかどうかを指定します。 サービスでサポートされている既知の値
なし |
NetworkInterfaceAuxiliarySku |
ネットワーク インターフェイス リソースに対して補助 SKU を有効にするかどうかを指定します。 サービスでサポートされている既知の値
なし |
OperatingSystemTypes |
このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。 使用可能な値は、Windows Linuxです。 サービスでサポートされている既知の値Windows の |
Origin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です サービスでサポートされている既知の値ユーザー の |
ProtocolTypes |
WinRM リスナーのプロトコルを指定します。 指定できる値は、http 、httpsです。 サービスでサポートされている既知の値http の |
ProvisioningState |
ProvisioningState のエイリアス |
PublicIPAddressSkuName |
パブリック IP SKU 名を指定します。 サービスでサポートされている既知の値
Basic |
PublicIPAddressSkuTier |
パブリック IP SKU レベルを指定する サービスでサポートされている既知の値
地域 |
RegularPriorityAllocationStrategy |
コンピューティング フリートの通常の VM 割り当て戦略の種類 サービスでサポートされている既知の値LowestPrice の |
ResourceProvisioningState |
リソースの種類のプロビジョニング状態。 サービスでサポートされている既知の値成功した の |
SecurityEncryptionTypes |
マネージド ディスクの EncryptionType を指定します。
注: 機密 VM にのみ設定できます。 サービスでサポートされている既知の値
VMGuestStateOnly |
SecurityTypes |
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。 サービスでサポートされている既知の値TrustedLaunch の |
SettingNames |
コンテンツが適用される設定の名前を指定します。 指定できる値は、FirstLogonCommands と AutoLogon です。 サービスでサポートされている既知の値
AutoLogon |
SpotAllocationStrategy |
コンピューティング フリートのスポット割り当て戦略の種類 サービスでサポートされている既知の値PriceCapacityOptimized の |
StorageAccountTypes |
マネージド ディスクのストレージ アカウントの種類を指定します。 マネージド OS ディスク ストレージ アカウントの種類は、スケール セットの作成時にのみ設定できます。 注: UltraSSD_LRSは、データ ディスクでのみ使用できます。 OS ディスクでは使用できません。
Standard_LRSは Standard HDD を使用します。 StandardSSD_LRSは Standard SSD を使用します。 Premium_LRSは Premium SSD を使用します。 UltraSSD_LRSは Ultra ディスクを使用します。 Premium_ZRSでは、Premium SSD ゾーン冗長ストレージが使用されます。 StandardSSD_ZRSでは、Standard SSD ゾーン冗長ストレージが使用されます。 Windows Virtual Machines でサポートされるディスクの詳細については、「https://docs.microsoft.com/azure/virtual-machines/windows/disks-types」を参照してください。Linux Virtual Machines については、https://docs.microsoft.com/azure/virtual-machines/linux/disks-types を参照してください。 サービスでサポートされている既知の値
Standard_LRS |
Versions |
API のバージョン |
WindowsPatchAssessmentMode |
IaaS 仮想マシンの VM ゲスト パッチ評価のモードを指定します。 サービスでサポートされている既知の値
ImageDefault |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。 サービスでサポートされている既知の値
不明な |
WindowsVMGuestPatchMode |
OrchestrationMode をフレキシブルとして使用して、仮想マシン スケール セットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲスト パッチ適用のモードを指定します。 サービスでサポートされている既知の値手動 の |
列挙型
関数
restore |
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。 |
関数の詳細
restorePoller<TResponse, TResult>(AzureFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。
function restorePoller<TResponse, TResult>(client: AzureFleetClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- AzureFleetClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
戻り値
PollerLike<OperationState<TResult>, TResult>
Azure SDK for JavaScript