@azure/arm-computefleet package
類別
AzureFleetClient |
介面
AdditionalUnattendContent |
指定 Windows 安裝程式所使用的 Unattend.xml 檔案中可包含的其他 XML 格式化資訊。 內容是透過設定名稱、元件名稱和套用內容的傳遞來定義。 |
ApiEntityReference |
API 實體參考。 |
ApiError |
適用於 Fleet 的 ApiError |
ApiErrorBase |
API 錯誤基底。 |
ApplicationProfile |
包含應該提供給 VM/VMSS 的資源庫應用程式清單 |
AzureFleetClientOptionalParams |
用戶端的選擇性參數。 |
BaseVirtualMachineProfile |
描述艦隊的基底虛擬機配置檔 |
BootDiagnostics |
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。 |
CapacityReservationProfile |
容量保留配置文件的參數。 |
ComputeProfile |
要用於執行使用者工作負載的計算配置檔。 |
DiagnosticsProfile |
指定開機診斷設定狀態。 API 版本下限:2015-06-15。 |
DiffDiskSettings |
描述可針對操作系統磁碟指定之暫時磁碟設定的參數。 注意: 暫時磁碟設定只能指定給受控磁碟。 |
DiskEncryptionSetParameters |
描述可針對磁碟指定之客戶受控磁碟加密集資源標識符的參數。 注意: 只能為受控磁碟指定磁碟加密集資源標識符。 如需詳細資訊,請參閱 https://aka.ms/mdssewithcmkoverview。 |
EncryptionIdentity |
指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。 |
ErrorAdditionalInfo |
資源管理錯誤其他資訊。 |
ErrorDetail |
錯誤詳細數據。 |
ErrorResponse |
所有 Azure Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。 |
Fleet |
計算機隊資源 |
FleetProperties |
計算機隊的詳細數據。 |
FleetUpdate |
機隊更新模型 |
FleetsCreateOrUpdateOptionalParams |
選擇性參數。 |
FleetsDeleteOptionalParams |
選擇性參數。 |
FleetsGetOptionalParams |
選擇性參數。 |
FleetsListByResourceGroupOptionalParams |
選擇性參數。 |
FleetsListBySubscriptionOptionalParams |
選擇性參數。 |
FleetsListVirtualMachineScaleSetsOptionalParams |
選擇性參數。 |
FleetsOperations |
代表 Fleets 作業的介面。 |
FleetsUpdateOptionalParams |
選擇性參數。 |
ImageReference |
指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但未用於其他建立作業時,則需要此元素。 注意:映像參考發行者和供應專案只能在您建立擴展集時設定。 |
InnerError |
內部錯誤詳細數據。 |
KeyVaultSecretReference |
描述 Key Vault 秘密的參考 |
LinuxConfiguration |
指定虛擬機上的Linux作業系統設定。 如需支援的 Linux 發行版清單,請參閱 Azure-Endorsed 發行版上的 Linux。 |
LinuxPatchSettings |
指定與Linux上的VM客體修補相關的設定。 |
LinuxVMGuestPatchAutomaticByPlatformSettings |
指定在Linux修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。 |
ManagedServiceIdentity |
受控服務識別(系統指派和/或使用者指派的身分識別) |
ManagedServiceIdentityUpdate |
用於新增選擇性屬性的範本。 |
OSImageNotificationProfile |
指定OS映像排程事件相關組態。 |
Operation |
從資源提供者作業 API API 傳回的 REST API 作業詳細數據 |
OperationDisplay |
和作業的當地語系化顯示資訊。 |
OperationsListOptionalParams |
選擇性參數。 |
OperationsOperations |
表示作業作業的介面。 |
PageSettings |
byPage 方法的選項 |
PagedAsyncIterableIterator |
介面,可讓異步反覆運算同時完成和逐頁執行。 |
PatchSettings |
指定與 Windows 上的 VM 客體修補相關的設定。 |
Plan |
規劃資源。 |
ProxyAgentSettings |
在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限:2023-09-01。 |
PublicIPAddressSku |
描述公用IP Sku。 它只能將 OrchestrationMode 設定為彈性。 |
RegularPriorityProfile |
計算機隊中一般實例的組態選項。 |
Resource |
回應中針對所有 Azure Resource Manager 資源傳回的常見欄位 |
ResourcePlanUpdate |
用於新增選擇性屬性的範本。 |
RestorePollerOptions | |
ScheduledEventsProfile |
指定排程的事件相關組態。 |
SecurityPostureReference |
指定要用於擴展集中所有虛擬機的安全性狀態。 API 版本下限:2023-03-01 |
SecurityProfile |
指定虛擬機或虛擬機擴展集的安全性配置檔設定。 |
ServiceArtifactReference |
指定使用 'latest' 映射版本時,用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。 API 版本下限:2022-11-01 |
SpotPriorityProfile |
計算機隊中Spot實例的組態選項。 |
SshConfiguration |
在 Azure 上執行的 Linux 型 VM 的 SSH 設定 |
SshPublicKey |
包含 SSH 憑證公鑰的相關信息,以及放置公鑰之 Linux VM 上的路徑。 |
SubResource |
描述 SubResource |
SystemData |
與建立和上次修改資源相關的元數據。 |
TerminateNotificationProfile |
指定終止已排程的事件相關組態。 |
TrackedResource |
Azure Resource Manager 的資源模型定義已追蹤最上層資源,其具有「標記」和「位置」 |
UefiSettings |
指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限:2020-12-01。 |
UserAssignedIdentity |
使用者指派的身分識別屬性 |
VMDiskSecurityProfile |
指定受控磁碟的安全性配置檔設定。 注意: 只能針對機密 VM 設定。 |
VMGalleryApplication |
指定參考計算資源庫應用程式版本的必要資訊 |
VMSizeProperties |
指定虛擬機上的 VM 大小屬性設定。 |
VaultCertificate |
描述 Key Vault 中的單一憑證參考,以及憑證應該位於 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 修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。 |
類型別名
ActionType |
可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。 服務支援的已知值內部 |
CachingTypes |
指定快取需求。 服務支援的已知值
無 |
ContinuablePage |
描述結果頁面的介面。 |
CreatedByType |
建立資源的實體種類。 服務支援的已知值
使用者 |
DeleteOptions |
指定刪除 VM 時網路介面會發生什麼事 服務支援的已知值
刪除 |
DiffDiskOptions |
指定作業系統磁碟的暫時磁碟選項。 服務支援的已知值本機 |
DiffDiskPlacement |
指定作業系統磁碟的暫時磁碟位置。 用戶可以在要求中使用這個屬性來選擇位置,也就是快取磁碟或資源磁碟空間以進行暫時 OS 磁碟布建。 如需暫時 OS 磁碟大小需求的詳細資訊,請參閱 windows VM 的暫時 OS 磁碟大小需求,請參閱 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 和 Linux VM 的暫時性 OS 磁碟需求,https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements NvmeDisk 的最低 API 版本:2024-03-01。 服務支援的已知值
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 功能https://docs.microsoft.com/rest/api/compute/resourceskus/list。 如需支援的磁碟控制器類型詳細資訊,請參閱 https://aka.ms/azure-diskcontrollertypes。 服務支援的已知值
SCSI |
DiskCreateOptionTypes |
指定應如何建立虛擬機。 服務支援的已知值
FromImage |
DiskDeleteOptionTypes |
指定刪除 VM 時受控磁碟的行為,例如,受控磁碟是否遭到刪除或中斷連結。 支援的值為:Delete。 如果使用此值,則會在刪除 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 |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 服務支援的已知值
ImageDefault |
ManagedServiceIdentityType |
受控服務識別的類型(允許 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 名稱。 服務支援的已知值
基本 |
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使用標準 HDD。 StandardSSD_LRS使用標準 SSD。 Premium_LRS使用進階 SSD。 UltraSSD_LRS使用 Ultra 磁碟。 Premium_ZRS使用進階 SSD 區域備援記憶體。 StandardSSD_ZRS使用標準 SSD 區域備援記憶體。 如需 Windows 虛擬機所支援磁碟的詳細資訊,請參閱 https://docs.microsoft.com/azure/virtual-machines/windows/disks-types,如需 Linux 虛擬機的詳細資訊,請參閱 https://docs.microsoft.com/azure/virtual-machines/linux/disks-types 服務支援的已知值
Standard_LRS |
Versions |
Api 版本 |
WindowsPatchAssessmentMode |
指定 IaaS 虛擬機的 VM 客體修補評估模式。 服務支援的已知值
ImageDefault |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。 服務支援的已知值
未知 |
WindowsVMGuestPatchMode |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 服務支援的已知值
手動 |
列舉
函式
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>