@azure/arm-compute package
接口
类型别名
| AccessControlRulesMode |
此属性允许你指定访问控制规则是处于审核模式、在强制模式还是禁用状态。 可能的值为:“Audit”、“Enforce”或“Disabled”。 服务支持的已知值
审核 |
| AccessLevel |
访问级别,接受的值包括 None、Read、Write。 服务支持的已知值
无 |
| ActionType |
可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 服务支持的已知值内部:操作适用于仅限内部的 API。 |
| AggregatedReplicationState |
这是基于所有区域复制状态标志的聚合复制状态。 服务支持的已知值
未知 |
| AllocationStrategy |
指定将基于其分配 VM 的虚拟机规模集的分配策略。 服务支持的已知值
LowestPrice |
| AlternativeType |
描述备用选项的类型。 服务支持的已知值
无 |
| Architecture |
OS 磁盘支持的 CPU 体系结构。 服务支持的已知值
x64 |
| ArchitectureTypes |
指定架构类型 服务支持的已知值
x64 |
| AvailabilityPolicyDiskDelay |
确定如何处理 I/O 速度较慢的磁盘。 服务支持的已知值
无:默认为未指定 av 策略的行为,即在磁盘 io 速度慢时重新启动 VM。 |
| AzureSupportedClouds |
云设置为字符串文字类型的支持值 |
| CachingTypes |
指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 默认值为: Standard storage 的 None。高级存储的 ReadOnly |
| CapacityReservationGroupInstanceViewTypes |
容量类型预留组实例视图类型 |
| CapacityReservationInstanceViewTypes |
容量类型预留实例视图类型 |
| ComponentNames |
组件名称。 目前,唯一允许的值是Microsoft-Windows-Shell-Setup。 |
| ConfidentialVMEncryptionType |
机密虚拟机加密类型 服务支持的已知值
EncryptedVMGuestStateOnlyWithPmk |
| ConsistencyModeTypes |
RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关详细信息,请参阅 https://aka.ms/RestorePoints。 服务支持的已知值
CrashConsistent |
| ContinuablePage |
描述结果页的接口。 |
| CopyCompletionErrorReason |
如果通过 CopyStart 操作创建的资源的后台副本失败,则指示错误代码。 服务支持的已知值CopySourceNotFound:指示在复制启动操作创建的资源的后台副本正在进行时删除源快照。 |
| CreatedByType |
创建资源的实体类型。 服务支持的已知值
用户:实体是由用户创建的。 |
| DataAccessAuthMode |
导出或上传到磁盘或快照时的其他身份验证要求。 服务支持的已知值
AzureActiveDirectory:使用导出/上传 URL 时,系统会检查用户是否在 Azure Active Directory 中具有标识,并具有导出/上传数据所需的权限。 请参阅 aka.ms/DisksAzureADAuth。 |
| DedicatedHostLicenseTypes |
指定将应用于在专用主机上部署的 VM 的软件许可证类型。 可能的值为:None、Windows_Server_Hybrid、Windows_Server_Perpetual。 默认值为:None。 |
| DeleteOptions |
指定删除 VM 时网络接口发生的情况 服务支持的已知值
删除 |
| DiffDiskOptions |
指定操作系统磁盘的临时磁盘选项。 服务支持的已知值本地 |
| DiffDiskPlacement |
指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置,例如缓存磁盘、资源磁盘或 nvme 磁盘空间。 有关临时 OS 磁盘大小要求的详细信息,请参阅 windows VM 的临时 OS 磁盘大小要求,https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements,Linux VM 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 |
| DiskCreateOption |
这会枚举磁盘创建可能的源。 服务支持的已知值
空:创建由 diskSizeGB 提供大小的空数据磁盘。 |
| DiskCreateOptionTypes |
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。
FromImage: 使用映像创建虚拟机时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。
空: 创建空数据磁盘时使用此值。
复制: 此值用于从快照或其他磁盘创建数据磁盘。
还原: 此值用于从磁盘还原点创建数据磁盘。 服务支持的已知值
FromImage |
| DiskDeleteOptionTypes |
指定删除 VM 时托管磁盘的行为,例如是删除还是分离托管磁盘。 支持的值为:Delete。 如果使用此值,则会在删除 VM 时删除托管磁盘。 分离。 如果使用此值,则会在删除 VM 后保留托管磁盘。 最低 API 版本:2021-03-01。 服务支持的已知值
删除 |
| DiskDetachOptionTypes |
指定要在分离磁盘时使用的分离行为,或者已在从虚拟机分离过程中使用。 支持的值为: ForceDetach。 detachOption: ForceDetach 仅适用于托管数据磁盘。 如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试,并且磁盘仍未释放,则使用强制分离作为最后手段选项从 VM 强行分离磁盘。 使用此分离行为时,可能不会刷新所有写入。
此功能仍处于预览阶段。 若要强制分离数据磁盘更新到BeDetached 到“true”,以及设置 detachOption:“ForceDetach”。 服务支持的已知值ForceDetach |
| DiskEncryptionSetIdentityType |
DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的Azure Active Directory租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密资源失去对密钥的访问权限。 服务支持的已知值
SystemAssigned |
| DiskEncryptionSetType |
用于加密磁盘数据的密钥类型。 服务支持的已知值
EncryptionAtRestWithCustomerKey:使用 diskEncryptionSet 的资源将使用客户管理的密钥进行静态加密,客户可以更改和吊销这些密钥。 |
| DiskSecurityTypes |
指定 VM 的 SecurityType。 仅适用于 OS 磁盘。 服务支持的已知值
TrustedLaunch:受信任的启动提供安全功能,例如安全启动和虚拟受信任平台模块 (vTPM) |
| DiskState |
这枚举了磁盘的可能状态。 服务支持的已知值
未附加:磁盘未使用,可以附加到 VM。 |
| DiskStorageAccountTypes |
SKU 名称。 服务支持的已知值
Standard_LRS:标准 HDD 本地冗余存储。 最适合备份、非关键访问和不经常访问。 |
| DomainNameLabelScopeTypes |
域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签 服务支持的已知值
TenantReuse |
| EdgeZoneStorageAccountType |
指定要用于存储映像的存储帐户类型。 此属性不可更新。 服务支持的已知值
Standard_LRS |
| EncryptionType |
用于加密磁盘数据的密钥类型。 服务支持的已知值
EncryptionAtRestWithPlatformKey:磁盘使用平台托管密钥进行静态加密。 它是默认加密类型。 这不是磁盘加密集的有效加密类型。 |
| EndpointAccess |
此属性允许你指定是否允许请求访问主机终结点。 可能的值为:“Allow”、“Deny”。 服务支持的已知值
允许 |
| EndpointTypes |
此属性允许指定此配置文件为其定义访问控制的终结点类型。 可能的值为:“WireServer”或“IMDS” |
| ExecutionState |
脚本执行状态。 服务支持的已知值
未知 |
| ExpandTypeForListVMs |
ExpandTypeForListVMs 类型 |
| ExpandTypesForGetCapacityReservationGroups |
扩展类型ForGetCapacityReservationGroups类型 |
| ExpandTypesForGetVMScaleSets |
ExpandTypesForGetVMScaleSets 类型 |
| ExpandTypesForListVMs |
ExpandTypesForListVMs 类型 |
| ExtendedLocationType |
扩展位置的类型。 服务支持的已知值EdgeZone |
| ExtendedLocationTypes |
extendedLocation 的类型。 服务支持的已知值EdgeZone |
| FileFormat |
用于在VHDX文件格式快照中请求SAS时指定文件格式 服务支持的已知值
VHD:VHD 文件是虚拟硬盘文件格式的磁盘映像文件。 |
| GalleryApplicationCustomActionParameterType |
指定自定义操作参数的类型。 可能的值包括:String、ConfigurationDataBlob 或 LogOutputBlob |
| GalleryApplicationScriptRebootBehavior |
自选。 在重新启动时安装/更新/删除库应用程序时要执行的操作。 服务支持的已知值
无 |
| GalleryExpandParams |
GalleryExpandParams 类型 |
| GalleryExtendedLocationType |
它是扩展位置的类型。 服务支持的已知值
EdgeZone |
| GalleryProvisioningState |
预配状态,仅出现在响应中。 服务支持的已知值
创建 |
| GalleryScriptParameterType |
指定 Gallery Script 参数的类型。 可能的值有:字符串、整数、双重、布尔值、枚举 服务支持的已知值
String:字符串画廊脚本参数类型 |
| GallerySharingPermissionTypes |
此属性允许指定共享库的权限。 可能的值包括:Private、GroupsCommunity。 服务支持的已知值
专用 |
| HighSpeedInterconnectPlacement |
指定虚拟机规模集的高速互连放置。 服务支持的已知值
无:无高速互连放置 |
| HostCaching |
磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” |
| HyperVGeneration |
虚拟机监控程序的代次。 服务支持的已知值
V1 |
| HyperVGenerationType |
指定与资源相关的 HyperVGeneration 类型 服务支持的已知值
V1 |
| HyperVGenerationTypes |
指定了 HyperVGeneration 类型 服务支持的已知值
V1 |
| IPVersion |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 服务支持的已知值
IPv4 |
| IPVersions |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 服务支持的已知值
IPv4 |
| ImageState |
描述图像的状态。 服务支持的已知值
活动 |
| InstanceViewTypes |
实例视图类型类型 |
| IntervalInMins |
用于创建 LogAnalytics 调用速率日志的间隔值(以分钟为单位)。 |
| LifecycleHookAction |
如果平台在等待前未收到客户对目标资源的响应,将应用于虚拟机中的目标资源的动作会触发生命周期钩子事件。 服务支持的已知值
批准:生命周期钩子事件中目标资源的生命周期钩子将被批准。 |
| LifecycleHookActionState |
虚拟机中目标资源的审批状态,规模设置生命周期钩事件。 服务支持的已知值
等待:目标资源的生命周期钩子正在等待批准。 |
| LinuxPatchAssessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 服务支持的已知值
ImageDefault |
| LinuxVMGuestPatchAutomaticByPlatformRebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 服务支持的已知值
未知 |
| LinuxVMGuestPatchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 服务支持的已知值
ImageDefault |
| MaintenanceOperationResultCodeTypes |
上次维护操作结果代码。 |
| Mode |
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。 服务支持的已知值
审核 |
| Modes |
指定执行模式。 在审核模式下,系统就像强制实施访问控制策略一样,包括在日志中发出访问拒绝条目,但它实际上不会拒绝对主机终结点的任何请求。 在“强制”模式下,系统将强制实施访问控制,这是建议的作模式。 服务支持的已知值
审核 |
| NetworkAccessPolicy |
通过网络访问磁盘的策略。 服务支持的已知值
AllowAll:磁盘可以导出或上传到任何网络。 |
| NetworkApiVersion |
指定了Microsoft。在网络接口配置中创建网络资源时使用的网络API版本 服务支持的已知值
2020-11-01 |
| NetworkInterfaceAuxiliaryMode |
指定是否为网络接口资源启用辅助模式。 服务支持的已知值
无 |
| NetworkInterfaceAuxiliarySku |
指定是否为网络接口资源启用辅助 SKU。 服务支持的已知值
无 |
| OperatingSystemStateTypes |
OS 状态。 对于托管映像,请使用通用化。 |
| OperatingSystemType |
获取操作系统类型。 服务支持的已知值
Windows |
| OperatingSystemTypes |
此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括:Windows、Linux。 |
| OrchestrationMode |
指定虚拟机规模集的业务流程模式。 服务支持的已知值
统一 |
| OrchestrationServiceNames |
服务的名称。 服务支持的已知值
AutomaticRepairs |
| OrchestrationServiceOperationStatus |
服务的最新运行状态。 服务支持的已知值
InProgress:InProgress 业务流程服务作状态。 |
| OrchestrationServiceState |
服务的当前状态。 服务支持的已知值
NotRunning |
| OrchestrationServiceStateAction |
要执行的作。 服务支持的已知值
恢复 |
| Origin |
该行动的预定执行人;如资源基访问控制(RBAC)和审计日志用户体验。 默认值为“user,system” 服务支持的已知值
用户:指示操作是由用户启动的。 |
| PassNames |
通行名类型 |
| PatchAssessmentState |
描述给定修补程序的可用性。 服务支持的已知值
未知 |
| PatchInstallationState |
安装作完成后的修补程序状态。 服务支持的已知值
未知 |
| PatchOperationStatus |
操作的总体成功或失败状态。 在操作完成之前,它将保持“InProgress”。 此时,它会变成“未知”、“失败”、“成功”或“已完成警告”。 服务支持的已知值
未知 |
| PolicyViolationCategory |
描述策略违规的性质。 服务支持的已知值
其他 |
| PrivateEndpointConnectionProvisioningState |
当前预配状态。 服务支持的已知值
已成功 |
| PrivateEndpointServiceConnectionStatus |
专用终结点连接状态。 服务支持的已知值
挂起的 |
| ProtocolTypes |
指定 WinRM 侦听器的协议。 可能的值为:http、https。 |
| ProvisionedBandwidthCopyOption |
如果在快照上设置了此字段,并且 createOption 为 CopyStart,则会以更快的速度复制快照。 服务支持的已知值
无 |
| ProximityPlacementGroupType |
指定邻近放置组的类型。 可能的值包括:标准:在 Azure 区域或可用性区域中共同定位资源。
超级:供将来使用。 服务支持的已知值
标准 |
| PublicIPAddressSkuName |
指定公共 IP sku 名称 服务支持的已知值
基本 |
| PublicIPAddressSkuTier |
指定公共 IP SKU 层 服务支持的已知值
区域 |
| PublicIPAllocationMethod |
指定公共IP分配类型 服务支持的已知值
动态 |
| PublicNetworkAccess |
用于控制磁盘上的导出的策略。 服务支持的已知值
启用:当 NetworkAccessPolicy 设置为 AllowAll 时,可以生成 SAS URI 以访问 Internet 上公开的磁盘的基础数据。 当 NetworkAccessPolicy 设置为 AllowPrivate 时,只能从受信任的 Azure VNET 访问数据。 |
| RebalanceBehavior |
将用于跨可用性区域在规模集中重新创建虚拟机的重新平衡行为的类型。 默认且目前仅支持的值为 CreateBeforeDelete。 服务支持的已知值CreateBeforeDelete |
| RebalanceStrategy |
用于跨可用性区域在规模集中重新均衡虚拟机的重新平衡策略的类型。 默认且目前仅支持的值是“重新创建”。 服务支持的已知值重新创建 |
| RepairAction |
用于修复规模集中运行不正常的虚拟机的修复操作类型(替换、重启、重置映像)。 默认值将被替换。 服务支持的已知值
替换 |
| ReplicationMode |
可选参数,用于指定要用于复制的模式。 此属性不可更新。 服务支持的已知值
完整 |
| ReplicationState |
这是区域复制状态。 服务支持的已知值
未知 |
| ReplicationStatusTypes |
复制类型状态类型 |
| ReservationType |
指示容量预留的类型。 允许的值为“阻止”(块容量预留)和“目标”(目标)预留,用于使虚拟机在提供容量预留组时使用特定容量预留的预留。 预留类型是不可变的,分配后无法更改。 服务支持的已知值
目标:在提供容量预留组时使用按需分配的容量预留。 |
| ResilientVMDeletionStatus |
指定虚拟机的弹性 VM 删除状态。 服务支持的已知值
已启用 |
| ResourceIdOptionsForGetCapacityReservationGroups |
资源IdOptionsForGetCapacityReservationGroups类型 |
| ResourceIdentityType |
用于虚拟机规模集的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。 |
| ResourceSkuCapacityScaleType |
适用于 SKU 的缩放类型。 |
| ResourceSkuRestrictionsReasonCode |
限制的原因。 |
| ResourceSkuRestrictionsType |
限制的类型。 |
| RestorePointCollectionExpandOptions |
恢复点集合展开选项类型 |
| RestorePointEncryptionType |
用于加密磁盘还原点数据的密钥类型。 服务支持的已知值
EncryptionAtRestWithPlatformKey:磁盘还原点使用平台托管密钥进行静态加密。 |
| RestorePointExpandOptions |
恢复点类型展开选项 |
| RollingUpgradeActionType |
在滚动升级上执行的最后一个作。 |
| RollingUpgradeStatusCode |
指示升级当前状态的代码。 |
| ScriptShellTypes |
脚本 shell 类型。 服务支持的已知值
默认:默认脚本 shell 类型。 |
| SecurityEncryptionTypes |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。
注意: 只能为机密 VM 设置它。 服务支持的已知值
VMGuestStateOnly |
| SecurityTypes |
指定虚拟机安全类型;UefiSettings 仅在设置为 TrustedLaunch 或 ConfidentialVM 时启用,并返回从 API 版本 2025-11-01 起的标准值。 服务支持的已知值
标准:表示没有 UEFI 功能(如 SecureBoot 或 vTPM)的虚拟机;当未指定安全类型时,该值作为默认值返回。 |
| SelectPermissions |
选择权限类型 |
| SettingNames |
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。 |
| SharedGalleryHostCaching |
磁盘的主机缓存。 有效的值有“无”、“只读”和“可读写” 服务支持的已知值
无 |
| SharedToValues |
共享值类型 |
| SharingProfileGroupTypes |
此属性允许您指定共享组的类型。 可能的值为: Subscriptions、AADTenants。 服务支持的已知值
订阅 |
| SharingState |
库的共享状态,仅显示在响应中。 服务支持的已知值
已成功 |
| SharingUpdateOperationTypes |
此属性允许您指定库共享更新的作类型。 可能的值为: Add、Remove、Reset。 服务支持的已知值
添加 |
| SnapshotAccessState |
快照的状态,用于确定快照的访问可用性。 服务支持的已知值
未知:默认值。 |
| SnapshotStorageAccountTypes |
SKU 名称。 服务支持的已知值
Standard_LRS:标准 HDD 本地冗余存储 |
| SoftDeletedArtifactTypes |
软删除资源的工件类型 服务支持的已知值图像 |
| SshEncryptionTypes |
要生成的 SSH 密钥的加密类型。 有关可能的值集,请参阅 SshEncryptionTypes。 如果没有提供,将默认使用 RSA 服务支持的已知值
RSA |
| StatusLevelTypes |
级别代码。 |
| StorageAccountStrategy |
指定选择存储账户类型时应采用的策略。 不能与 storageAccountType 一起指定,但可以通过指定 targetRegions[].storageAccountType 来覆盖每个区域。 此属性不可更新。 服务支持的已知值
PreferStandard_ZRS:如果区域支持,选择Standard_ZRS存储,否则选择Standard_LRS存储,除非指定区域存储账户类型覆盖。 如果没有指定storageAccountStrategy,则默认策略为(从API版本2025-03-03起)。 |
| StorageAccountType |
指定要用于存储映像的存储帐户类型。 此属性不可更新。 服务支持的已知值
Standard_LRS |
| 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 |
| StorageAlignmentStatus |
指定磁盘的存储对齐状态。 服务支持的已知值
未对齐:磁盘没有存储故障域以计算故障域映射。 单个存储故障域故障可能影响所有引用该磁盘配置文件的虚拟机。 |
| StorageFaultDomainAlignmentType |
指定磁盘的存储故障域对齐类型。 服务支持的已知值
Aligned:磁盘存储故障域映射到计算故障域。 如果磁盘不支持足够的故障域,部署将失败。 |
| SupportedSecurityOption |
指支持创建可信启动或机密虚拟机的磁盘的安全能力 服务支持的已知值
TrustedLaunchSupported:磁盘支持创建受信任的启动 VM。 |
| UefiKeyType |
密钥签名的类型。 服务支持的已知值
sha256 |
| UefiSignatureTemplateName |
包含默认 UEFI 密钥的签名模板的名称。 服务支持的已知值
NoSignatureTemplate |
| UpgradeMode |
指定升级到规模集中虚拟机的模式。 |
| UpgradeOperationInvoker |
升级作的调用方 |
| UpgradeState |
指示升级当前状态的代码。 |
| VMGuestPatchClassificationLinux |
VMGuest补丁分类Linux的类型 |
| VMGuestPatchClassificationWindows |
VMGuestPatchClassificationWindows 类型 |
| VMGuestPatchRebootBehavior |
描述修补程序的重新启动要求。 服务支持的已知值
未知 |
| VMGuestPatchRebootSetting |
定义在软件更新作期间重新启动 VM 是可以接受的。 服务支持的已知值
IfRequired |
| VMGuestPatchRebootStatus |
完成作后虚拟机的重新启动状态。 服务支持的已知值
未知 |
| VMScaleSetLifecycleHookEventState |
虚拟机规模集生命周期钩事件可以处于状态。 这不是客户可以设定的。 它仅由平台设定。 服务支持的已知值
激活:生命周期钩事件处于激活状态。 例如,等待客户的回复。 |
| VMScaleSetLifecycleHookEventType |
指定客户希望接收虚拟机规模集生命周期钩事件的场景。 服务支持的已知值
UpgradeAutoOS Scheduling:在虚拟机规模集中自动升级操作开始前,向客户发送生命周期钩事件。 |
| ValidationStatus |
此属性指定映像版本的 validationProfile 的状态。 服务支持的已知值
未知 |
| VirtualMachineEvictionPolicyTypes |
规定了Azure Spot VM/VMSS的驱逐策略 服务支持的已知值
解除分配 |
| VirtualMachinePriorityTypes |
指定独立虚拟机或规模集中的虚拟机的优先级。 “Low”枚举将来将被弃用,请使用“Spot”作为枚举来部署 Azure Spot VM/VMSS。 服务支持的已知值
常规 |
| VirtualMachineScaleSetScaleInRules |
VirtualMachineScaleSetScaleInRules 类型 |
| VirtualMachineScaleSetSkuScaleType |
适用于 SKU 的缩放类型。 |
| VirtualMachineSizeTypes |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 服务支持的已知值
Basic_A0 |
| VmDiskTypes |
不允许的 VM 磁盘类型。 服务支持的已知值
无 |
| WindowsPatchAssessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 服务支持的已知值
ImageDefault |
| WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 服务支持的已知值
未知 |
| WindowsVMGuestPatchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 服务支持的已知值
手动 |
| ZonalPlatformFaultDomainAlignMode |
指定虚拟机规模集计算与存储容错域计数之间的对齐模式。 服务支持的已知值
对齐 |
| ZonePlacementPolicyType |
指定资源在可用性区域中放置的策略。 可能的值为: 任意 (用于虚拟机)、 自动 (用于虚拟机规模集)- 作为资源创建的一部分,系统将自动选取可用性区域。 服务支持的已知值
任意 |
枚举
| AzureClouds |
一个用来描述Azure云环境的enum。 |
| KnownAccessControlRulesMode |
此属性允许你指定访问控制规则是处于审核模式、在强制模式还是禁用状态。 可能的值为:“Audit”、“Enforce”或“Disabled”。 |
| KnownAccessLevel |
访问级别,接受的值包括 None、Read、Write。 |
| KnownActionType |
可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 |
| KnownAggregatedReplicationState |
这是基于所有区域复制状态标志的聚合复制状态。 |
| KnownAllocationStrategy |
指定将基于其分配 VM 的虚拟机规模集的分配策略。 |
| KnownAlternativeType |
描述备用选项的类型。 |
| KnownArchitecture |
OS 磁盘支持的 CPU 体系结构。 |
| KnownArchitectureTypes |
指定体系结构类型 |
| KnownAvailabilityPolicyDiskDelay |
确定如何处理 I/O 速度较慢的磁盘。 |
| KnownCapacityReservationGroupInstanceViewTypes | |
| KnownCapacityReservationInstanceViewTypes | |
| KnownConfidentialVMEncryptionType |
机密 VM 加密类型 |
| KnownConsistencyModeTypes |
RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关详细信息,请参阅 https://aka.ms/RestorePoints。 |
| KnownCopyCompletionErrorReason |
如果通过 CopyStart 操作创建的资源的后台副本失败,则指示错误代码。 |
| KnownCreatedByType |
创建资源的实体类型。 |
| KnownDataAccessAuthMode |
导出或上传到磁盘或快照时的其他身份验证要求。 |
| KnownDeleteOptions |
指定删除 VM 时网络接口发生的情况 |
| KnownDiffDiskOptions |
指定操作系统磁盘的临时磁盘选项。 |
| KnownDiffDiskPlacement |
指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置,例如缓存磁盘、资源磁盘或 nvme 磁盘空间。 有关临时 OS 磁盘大小要求的详细信息,请参阅 windows VM 的临时 OS 磁盘大小要求,https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements,Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements。 NvmeDisk 的最低 API 版本:2024-03-01。 |
| KnownDiskControllerTypes |
指定为 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。 |
| KnownDiskCreateOption |
这会枚举磁盘创建可能的源。 |
| KnownDiskCreateOptionTypes |
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。 FromImage: 使用映像创建虚拟机时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。 空: 创建空数据磁盘时使用此值。 复制: 此值用于从快照或其他磁盘创建数据磁盘。 还原: 此值用于从磁盘还原点创建数据磁盘。 |
| KnownDiskDeleteOptionTypes |
指定删除 VM 时托管磁盘的行为,例如是删除还是分离托管磁盘。 支持的值为:Delete。 如果使用此值,则会在删除 VM 时删除托管磁盘。 分离。 如果使用此值,则会在删除 VM 后保留托管磁盘。 最低 API 版本:2021-03-01。 |
| KnownDiskDetachOptionTypes |
指定要在分离磁盘时使用的分离行为,或者已在从虚拟机分离过程中使用。 支持的值为: ForceDetach。 detachOption: ForceDetach 仅适用于托管数据磁盘。 如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试,并且磁盘仍未释放,则使用强制分离作为最后手段选项从 VM 强行分离磁盘。 使用此分离行为时,可能不会刷新所有写入。 此功能仍处于预览阶段。 若要强制分离数据磁盘更新到BeDetached 到“true”,以及设置 detachOption:“ForceDetach”。 |
| KnownDiskEncryptionSetIdentityType |
DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的Azure Active Directory租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密资源失去对密钥的访问权限。 |
| KnownDiskEncryptionSetType |
用于加密磁盘数据的密钥类型。 |
| KnownDiskSecurityTypes |
指定 VM 的 SecurityType。 仅适用于 OS 磁盘。 |
| KnownDiskState |
这枚举了磁盘的可能状态。 |
| KnownDiskStorageAccountTypes |
SKU 名称。 |
| KnownDomainNameLabelScopeTypes |
域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签 |
| KnownEdgeZoneStorageAccountType |
指定要用于存储映像的存储帐户类型。 此属性不可更新。 |
| KnownEncryptionType |
用于加密磁盘数据的密钥类型。 |
| KnownEndpointAccess |
此属性允许你指定是否允许请求访问主机终结点。 可能的值为:“Allow”、“Deny”。 |
| KnownExecutionState |
脚本执行状态。 |
| KnownExpandTypeForListVMs |
ExpandTypeForListVM 的已知值 服务接受的值。 |
| KnownExpandTypesForGetCapacityReservationGroups | |
| KnownExpandTypesForGetVMScaleSets |
ExpandTypesForGetVMScaleSets 服务的已知值。 |
| KnownExpandTypesForListVMs |
ExpandTypesForListVM 服务的已知值。 |
| KnownExtendedLocationType |
扩展位置的类型。 |
| KnownExtendedLocationTypes |
extendedLocation 的类型。 |
| KnownFileFormat |
用于在 VHDX 文件格式快照上请求 SAS 时指定文件格式 |
| KnownGalleryApplicationScriptRebootBehavior |
自选。 在重新启动时安装/更新/删除库应用程序时要执行的操作。 |
| KnownGalleryExpandParams |
GalleryExpandParams 的已知值 服务接受的值。 |
| KnownGalleryExtendedLocationType |
它是扩展位置的类型。 |
| KnownGalleryProvisioningState |
预配状态,仅出现在响应中。 |
| KnownGalleryScriptParameterType |
指定 Gallery Script 参数的类型。 可能的值有:字符串、整数、双重、布尔值、枚举 |
| KnownGallerySharingPermissionTypes |
此属性允许指定共享库的权限。 可能的值包括:Private、GroupsCommunity。 |
| KnownHighSpeedInterconnectPlacement |
指定虚拟机规模集的高速互连放置。 |
| KnownHyperVGeneration |
虚拟机监控程序的代次。 |
| KnownHyperVGenerationType |
指定与资源关联的 HyperVGeneration 类型 |
| KnownHyperVGenerationTypes |
指定 HyperVGeneration 类型 |
| KnownIPVersion |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
| KnownIPVersions |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
| KnownImageState |
描述图像的状态。 |
| KnownLifecycleHookAction |
如果平台在等待前未收到客户对目标资源的响应,将应用于虚拟机中的目标资源的动作会触发生命周期钩子事件。 |
| KnownLifecycleHookActionState |
虚拟机中目标资源的审批状态,规模设置生命周期钩事件。 |
| KnownLinuxPatchAssessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 |
| KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
| KnownLinuxVMGuestPatchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
| KnownMode |
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。 |
| KnownModes |
指定执行模式。 在审核模式下,系统就像强制实施访问控制策略一样,包括在日志中发出访问拒绝条目,但它实际上不会拒绝对主机终结点的任何请求。 在“强制”模式下,系统将强制实施访问控制,这是建议的作模式。 |
| KnownNetworkAccessPolicy |
通过网络访问磁盘的策略。 |
| KnownNetworkApiVersion |
指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本 |
| KnownNetworkInterfaceAuxiliaryMode |
指定是否为网络接口资源启用辅助模式。 |
| KnownNetworkInterfaceAuxiliarySku |
指定是否为网络接口资源启用辅助 SKU。 |
| KnownOperatingSystemType |
获取操作系统类型。 |
| KnownOrchestrationMode |
指定虚拟机规模集的业务流程模式。 |
| KnownOrchestrationServiceNames |
服务的名称。 |
| KnownOrchestrationServiceOperationStatus |
服务的最新运行状态。 |
| KnownOrchestrationServiceState |
服务的当前状态。 |
| KnownOrchestrationServiceStateAction |
要执行的作。 |
| KnownOrigin |
该行动的预定执行人;如资源基访问控制(RBAC)和审计日志用户体验。 默认值为“user,system” |
| KnownPatchAssessmentState |
描述给定修补程序的可用性。 |
| KnownPatchInstallationState |
安装作完成后的修补程序状态。 |
| KnownPatchOperationStatus |
操作的总体成功或失败状态。 在操作完成之前,它将保持“InProgress”。 此时,它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。 |
| KnownPolicyViolationCategory |
描述策略违规的性质。 |
| KnownPrivateEndpointConnectionProvisioningState |
当前预配状态。 |
| KnownPrivateEndpointServiceConnectionStatus |
专用终结点连接状态。 |
| KnownProvisionedBandwidthCopyOption |
如果在快照上设置了此字段,并且 createOption 为 CopyStart,则会以更快的速度复制快照。 |
| KnownProximityPlacementGroupType |
指定邻近放置组的类型。 可能的值包括:标准:在 Azure 区域或可用性区域中共同定位资源。 超级:供将来使用。 |
| KnownPublicIPAddressSkuName |
指定公共 IP SKU 名称 |
| KnownPublicIPAddressSkuTier |
指定公共 IP SKU 层 |
| KnownPublicIPAllocationMethod |
指定公共 IP 分配类型 |
| KnownPublicNetworkAccess |
用于控制磁盘上的导出的策略。 |
| KnownRebalanceBehavior |
将用于跨可用性区域在规模集中重新创建虚拟机的重新平衡行为的类型。 默认且目前仅支持的值为 CreateBeforeDelete。 |
| KnownRebalanceStrategy |
用于跨可用性区域在规模集中重新均衡虚拟机的重新平衡策略的类型。 默认且目前仅支持的值是“重新创建”。 |
| KnownRepairAction |
用于修复规模集中运行不正常的虚拟机的修复操作类型(替换、重启、重置映像)。 默认值将被替换。 |
| KnownReplicationMode |
可选参数,用于指定要用于复制的模式。 此属性不可更新。 |
| KnownReplicationState |
这是区域复制状态。 |
| KnownReplicationStatusTypes |
ReplicationStatusTypes 服务的已知值。 |
| KnownReservationType |
指示容量预留的类型。 允许的值为“阻止”(块容量预留)和“目标”(目标)预留,用于使虚拟机在提供容量预留组时使用特定容量预留的预留。 预留类型是不可变的,分配后无法更改。 |
| KnownResilientVMDeletionStatus |
指定虚拟机的弹性 VM 删除状态。 |
| KnownResourceIdOptionsForGetCapacityReservationGroups | |
| KnownRestorePointCollectionExpandOptions | |
| KnownRestorePointEncryptionType |
用于加密磁盘还原点数据的密钥类型。 |
| KnownRestorePointExpandOptions |
RestorePointExpandOptions 服务的已知值。 |
| KnownScriptShellTypes |
脚本 shell 类型。 |
| KnownSecurityEncryptionTypes |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。 |
| KnownSecurityTypes |
指定虚拟机安全类型;UefiSettings 仅在设置为 TrustedLaunch 或 ConfidentialVM 时启用,并返回从 API 版本 2025-11-01 起的标准值。 |
| KnownSelectPermissions |
SelectPermissions 服务的已知值。 |
| KnownSharedGalleryHostCaching |
磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” |
| KnownSharedToValues |
SharedToValues 的已知值 服务接受的值。 |
| KnownSharingProfileGroupTypes |
此属性允许您指定共享组的类型。 可能的值为: Subscriptions、AADTenants。 |
| KnownSharingState |
库的共享状态,仅显示在响应中。 |
| KnownSharingUpdateOperationTypes |
此属性允许您指定库共享更新的作类型。 可能的值为: Add、Remove、Reset。 |
| KnownSnapshotAccessState |
快照的状态,用于确定快照的访问可用性。 |
| KnownSnapshotStorageAccountTypes |
SKU 名称。 |
| KnownSoftDeletedArtifactTypes |
软删除资源的项目类型 |
| KnownSshEncryptionTypes |
要生成的 SSH 密钥的加密类型。 有关可能的值集,请参阅 SshEncryptionTypes。 如果未提供,则默认为 RSA |
| KnownStorageAccountStrategy |
指定选择存储账户类型时应采用的策略。 不能与 storageAccountType 一起指定,但可以通过指定 targetRegions[].storageAccountType 来覆盖每个区域。 此属性不可更新。 |
| KnownStorageAccountType |
指定要用于存储映像的存储帐户类型。 此属性不可更新。 |
| KnownStorageAccountTypes |
指定托管磁盘的存储帐户类型。 只能在创建规模集时设置托管 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 |
| KnownStorageAlignmentStatus |
指定磁盘的存储对齐状态。 |
| KnownStorageFaultDomainAlignmentType |
指定磁盘的存储故障域对齐类型。 |
| KnownSupportedSecurityOption |
指支持创建受信任启动或机密 VM 的磁盘的安全功能 |
| KnownUefiKeyType |
密钥签名的类型。 |
| KnownUefiSignatureTemplateName |
包含默认 UEFI 密钥的签名模板的名称。 |
| KnownVMGuestPatchClassificationLinux |
VMGuestPatchClassificationLinux 服务的已知值。 |
| KnownVMGuestPatchClassificationWindows | |
| KnownVMGuestPatchRebootBehavior |
描述修补程序的重新启动要求。 |
| KnownVMGuestPatchRebootSetting |
定义在软件更新作期间重新启动 VM 是可以接受的。 |
| KnownVMGuestPatchRebootStatus |
完成作后虚拟机的重新启动状态。 |
| KnownVMScaleSetLifecycleHookEventState |
虚拟机规模集生命周期钩事件可以处于状态。 这不是客户可以设定的。 它仅由平台设定。 |
| KnownVMScaleSetLifecycleHookEventType |
指定客户希望接收虚拟机规模集生命周期钩事件的场景。 |
| KnownValidationStatus |
此属性指定映像版本的 validationProfile 的状态。 |
| KnownVirtualMachineEvictionPolicyTypes |
指定 Azure 现成 VM/VMSS 的逐出策略 |
| KnownVirtualMachinePriorityTypes |
指定独立虚拟机或规模集中的虚拟机的优先级。 “Low”枚举将来将被弃用,请使用“Spot”作为枚举来部署 Azure Spot VM/VMSS。 |
| KnownVirtualMachineScaleSetScaleInRules | |
| KnownVirtualMachineSizeTypes |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 |
| KnownVmDiskTypes |
不允许的 VM 磁盘类型。 |
| KnownWindowsPatchAssessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 |
| KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
| KnownWindowsVMGuestPatchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
| KnownZonalPlatformFaultDomainAlignMode |
指定虚拟机规模集计算与存储容错域计数之间的对齐模式。 |
| KnownZonePlacementPolicyType |
指定资源在可用性区域中放置的策略。 可能的值为: 任意 (用于虚拟机)、 自动 (用于虚拟机规模集)- 作为资源创建的一部分,系统将自动选取可用性区域。 |
函数
| restore |
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。 |
函数详细信息
restorePoller<TResponse, TResult>(ComputeManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。
function restorePoller<TResponse, TResult>(client: ComputeManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
参数
- client
- ComputeManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返回
PollerLike<OperationState<TResult>, TResult>