你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@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 用于获取 keyvault 操作的访问令牌的托管标识。 |
ErrorAdditionalInfo |
资源管理错误附加信息。 |
ErrorDetail |
错误详细信息。 |
ErrorResponse |
所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。 |
Fleet |
计算机群资源 |
FleetProperties |
计算机群的详细信息。 |
FleetUpdate |
群更新模型 |
FleetsCreateOrUpdateOptionalParams |
可选参数。 |
FleetsDeleteOptionalParams |
可选参数。 |
FleetsGetOptionalParams |
可选参数。 |
FleetsListByResourceGroupOptionalParams |
可选参数。 |
FleetsListBySubscriptionOptionalParams |
可选参数。 |
FleetsListVirtualMachineScaleSetsOptionalParams |
可选参数。 |
FleetsOperations |
表示机队操作的接口。 |
FleetsUpdateOptionalParams |
可选参数。 |
ImageReference |
指定要使用的图像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但不在其他创建操作中使用,则需要此元素。 注意:只能在创建规模集时设置映像引用发布者和产品/服务。 |
InnerError |
内部错误详细信息。 |
KeyVaultSecretReference |
描述对 Key Vault 机密的引用 |
LinuxConfiguration |
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。 |
LinuxPatchSettings |
指定与 Linux 上的 VM 来宾修补相关的设置。 |
LinuxVMGuestPatchAutomaticByPlatformSettings |
指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。 |
ManagedServiceIdentity |
托管服务标识(系统分配和/或用户分配的标识) |
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 |
计算机群中常规实例的配置选项。 |
Resource |
所有 Azure 资源管理器资源的响应中返回的常见字段 |
ResourcePlanUpdate |
用于添加可选属性的模板。 |
RestorePollerOptions | |
ScheduledEventsProfile |
指定与计划事件相关的配置。 |
SecurityPostureReference |
指定要用于规模集中所有虚拟机的安全状况。 最低 API 版本:2023-03-01 |
SecurityProfile |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
ServiceArtifactReference |
指定使用“latest”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 最低 API 版本:2022-11-01 |
SpotPriorityProfile |
计算机群中现成实例的配置选项。 |
SshConfiguration |
Azure 上运行的基于 Linux 的 VM 的 SSH 配置 |
SshPublicKey |
包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。 |
SubResource |
介绍 SubResource |
SystemData |
与创建和上次修改资源相关的元数据。 |
TerminateNotificationProfile |
指定终止计划事件相关配置。 |
TrackedResource |
Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源 |
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 配置的公共 IPAddress 配置 |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings |
描述虚拟机规模集网络配置的 DNS 设置。 |
VirtualMachineScaleSetPublicIPAddressConfigurationProperties |
介绍虚拟机规模集 IP 配置的公共 IPAddress 配置 |
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 和 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 包含 V2(https://docs.microsoft.com/rest/api/compute/resourceskus/list)时检查作为 VM SKU 功能的一部分返回的 HyperVGenerations 功能。 有关支持的磁盘控制器类型的详细信息,请参阅 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 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 服务支持的已知值
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使用超级磁盘。 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 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 服务支持的已知值
手动 |
枚举
函数
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>