你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Virtual Machine Scale Sets - List By Location

获取指定位置的指定订阅下的所有 VM 规模集。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets?api-version=2024-03-01

URI 参数

名称 必需 类型 说明
location
path True

string

查询订阅下的 VM 规模集的位置。

正则表达式模式: ^[-\w\._]+$

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

VirtualMachineScaleSetListResult

确定

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Lists all the VM scale sets under the specified subscription for the specified location.

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/eastus/virtualMachineScaleSets?api-version=2024-03-01

示例响应

{
  "value": [
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {
        "myTag1": "tagValue1"
      },
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": false,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": false
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS"
              },
              "diskSizeGB": 30
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": false
            }
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        }
                      }
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  }
                }
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": false,
        "doNotRunExtensionsOnOverprovisionedVMs": false,
        "platformFaultDomainCount": 1
      }
    },
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {
        "myTag1": "tagValue2"
      },
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": false,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": false
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS"
              },
              "diskSizeGB": 30
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": false
            }
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic1",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        }
                      }
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  }
                }
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": false,
        "doNotRunExtensionsOnOverprovisionedVMs": false,
        "platformFaultDomainCount": 1
      }
    }
  ]
}

定义

名称 说明
AdditionalCapabilities

在虚拟机或虚拟机规模集上启用或禁用某个功能。

AdditionalUnattendContent

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 XML 格式信息。 通过设置名称、组件名称和应用内容的传递来定义内容。

ApiEntityReference

API 实体引用。

ApiError

Api 错误。

ApiErrorBase

Api 错误基。

ApplicationProfile

包含应提供给 VM/VMSS 的库应用程序列表

AutomaticOSUpgradePolicy

用于执行自动 OS 升级的配置参数。

AutomaticRepairsPolicy

指定虚拟机规模集上的自动修复的配置参数。

BillingProfile

指定 Azure 现成 VM 或 VMSS 的计费相关详细信息。 最低 API 版本:2019-03-01。

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

CachingTypes

指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 对于标准存储,默认值为: None。高级存储的 ReadOnly。

CapacityReservationProfile

容量预留配置文件的参数。

CloudError

来自计算服务的错误响应。

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

DeleteOptions

指定删除 VM 时公共 IP 会发生什么情况

DiagnosticsProfile

指定启动诊断设置状态。 最低 API 版本:2015-06-15。

DiffDiskOptions

指定操作系统磁盘的临时磁盘设置。

DiffDiskPlacement

指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的缓存磁盘、资源磁盘或 nvme 磁盘空间的位置。 有关临时 OS 磁盘大小要求的详细信息,请参阅 上的 Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本:2024-03-01。

DiffDiskSettings

描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意: 只能为托管磁盘指定临时磁盘设置。

DiskControllerTypes
DiskCreateOptionTypes

指定应如何创建规模集中的虚拟机。 唯一允许的值为: FromImage。 使用映像创建虚拟机时,将使用此值。 如果使用平台映像,则还要使用上述 imageReference 元素。 如果使用市场映像,则还需使用前面所述的计划元素。

DiskDeleteOptionTypes

指定在 VMSS 灵活删除时是应删除还是分离 OS 磁盘 (此功能仅适用于灵活 OrchestrationMode) VMSS。

可能的值:

删除 如果使用此值,则会在删除 VMSS Flex VM 时删除 OS 磁盘。

分离 如果使用此值,则会在删除 VMSS Flex VM 后保留 OS 磁盘。

默认值设置为 Delete。 对于临时 OS 磁盘,默认值设置为 Delete。 用户无法更改临时 OS 磁盘的删除选项。

DiskEncryptionSetParameters

介绍可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview

DomainNameLabelScopeTypes

域名标签范围。根据策略从域名标签范围和 vm 索引生成的哈希域名标签是将要创建的 PublicIPAddress 资源的域名标签

EncryptionIdentity

指定 ADE 用于获取密钥保管库操作的访问令牌的托管标识。

EventGridAndResourceGraph

指定 eventGridAndResourceGraph 相关的计划事件相关配置。

ExtendedLocation

扩展位置的复杂类型。

ExtendedLocationTypes

扩展位置的类型。

ImageReference

指定要使用的映像的相关信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但未在其他创建操作中使用,则此元素是必需的。 注意:只能在创建规模集时设置映像引用发布者和产品/服务。

InnerError

内部错误详细信息。

IPVersion

从 Api-Version 2019-07-01 开始提供,它表示特定的 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 可能的值为:“IPv4”和“IPv6”。

KeyVaultSecretReference

描述对 Key Vault 机密的引用

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 发行版的列表,请参阅 Linux on Azure-Endorsed Distributions

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

LinuxPatchSettings

指定与 Linux 上的 VM 来宾修补相关的设置。

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

LinuxVMGuestPatchAutomaticByPlatformSettings

指定在 Linux 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,它将强制实施访问控制。 默认值为“强制模式”。

NetworkApiVersion

指定在业务流程模式为“灵活”的虚拟机规模集的网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本

NetworkInterfaceAuxiliaryMode

指定是否为网络接口资源启用辅助模式。

NetworkInterfaceAuxiliarySku

指定是否为网络接口资源启用辅助 SKU。

OperatingSystemTypes

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括: Windows、Linux。

OrchestrationMode

指定虚拟机规模集的业务流程模式。

OSImageNotificationProfile
PassNames

传递名称。 目前,唯一允许的值为 OobeSystem。

PatchSettings

指定与 Windows 上的 VM 来宾修补相关的设置。

Plan

指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以供编程使用,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击“ 想要以编程方式部署”“入门”->。 输入任何所需信息,然后单击“ 保存”。

PriorityMixPolicy

指定具有灵活业务流程模式的规模集中现成 VM 和常规优先级 VM 的目标拆分。 借助此属性,客户能够指定在 VMSS 灵活实例横向扩展时创建的常规优先级 VM 的基数,以及在达到此基本目标后在现成 VM 和常规优先级 VM 之间拆分。

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

PublicIPAddressSku

介绍公共 IP SKU。 只能将 OrchestrationMode 设置为灵活。

PublicIPAddressSkuName

指定公共 IP SKU 名称

PublicIPAddressSkuTier

指定公共 IP SKU 层

RepairAction

修复操作的类型 (替换、重启、重置映像) ,这些操作将用于修复规模集中的不正常虚拟机。 默认值为 replace。

ResiliencyPolicy

描述复原策略 - resiliencVMCreationPolicy 和/或 resiliencVMDeletionPolicy。

ResilientVMCreationPolicy

执行可复原 VM 创建时使用的配置参数。

ResilientVMDeletionPolicy

执行可复原 VM 删除时使用的配置参数。

ResourceIdentityType

用于虚拟机规模集的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。

RollingUpgradePolicy

执行滚动升级时使用的配置参数。

ScaleInPolicy

介绍虚拟机规模集的横向缩减策略。

ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy

指定与重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关的配置。

ScheduledEventsProfile
securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

SecurityPostureReference

指定要在规模集中使用的安全状况。 最低 API 版本:2023-03-01

SecurityProfile

指定虚拟机或虚拟机规模集的安全配置文件设置。

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

ServiceArtifactReference

指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 最低 API 版本:2022-11-01

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

Sku

介绍虚拟机规模集 SKU。 注意:如果规模集当前使用的硬件不支持新的 VM SKU,则需要在修改 SKU 名称之前解除分配规模集中的 VM。

SpotRestorePolicy

指定虚拟机规模集的 Spot-Try-Restore 属性。 借助此属性,客户可以根据容量可用性和定价约束,以机会启用或禁用逐出的现成 VMSS VM 实例的自动还原。

SshConfiguration

适用于在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置

SshPublicKey

包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。

SubResource
TerminateNotificationProfile
UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

UpgradeMode

指定升级到规模集中虚拟机的模式。

可能的值为:

手动 - 控制将更新应用到规模集中的虚拟机。 可以使用 manualUpgrade 操作执行此操作。

自动 - 规模集中的所有虚拟机同时自动更新。

UpgradePolicy

描述升级策略 - 自动、手动或滚动。

UserAssignedIdentities

与虚拟机关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

UserInitiatedReboot

指定与重启相关的计划事件相关配置。

UserInitiatedRedeploy

指定重新部署相关的计划事件相关配置。

VaultCertificate

描述 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。

VaultSecretGroup

描述一组证书,这些证书都位于同一 Key Vault 中。

VirtualHardDisk

描述磁盘的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure 现成虚拟机和 Azure 现成规模集的逐出策略。 对于 Azure 现成虚拟机,支持“Deallocate”和“Delete”,最低 api 版本为 2019-03-01。 对于 Azure 现成规模集,支持“Deallocate”和“Delete”,最低 api 版本为 2017-10-30-preview。

VirtualMachinePriorityTypes

指定规模集中虚拟机的优先级。 最低 API 版本:2017-10-30-preview。

VirtualMachineScaleSet

介绍虚拟机规模集。

VirtualMachineScaleSetDataDisk

介绍虚拟机规模集数据磁盘。

VirtualMachineScaleSetExtension

介绍虚拟机规模集扩展。

VirtualMachineScaleSetExtensionProfile

描述虚拟机规模集扩展配置文件。

VirtualMachineScaleSetHardwareProfile

指定虚拟机规模集的硬件设置。

VirtualMachineScaleSetIdentity

虚拟机规模集的标识。

VirtualMachineScaleSetIPConfiguration

介绍虚拟机规模集网络配置文件的 IP 配置。

VirtualMachineScaleSetIpTag

包含与公共 IP 地址关联的 IP 标记。

VirtualMachineScaleSetListResult

列出虚拟机操作响应。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 托管磁盘的参数。

VirtualMachineScaleSetNetworkConfiguration

介绍虚拟机规模集网络配置文件的网络配置。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

介绍虚拟机规模集网络配置的 DNS 设置。

VirtualMachineScaleSetNetworkProfile

介绍虚拟机规模集网络配置文件。

VirtualMachineScaleSetOSDisk

介绍虚拟机规模集操作系统磁盘。

VirtualMachineScaleSetOSProfile

介绍虚拟机规模集 OS 配置文件。

VirtualMachineScaleSetPublicIPAddressConfiguration

介绍虚拟机规模集 IP 配置的 PublicIPAddress 配置

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

介绍虚拟机规模集网络配置的 DNS 设置。

VirtualMachineScaleSetScaleInRules

在虚拟机规模集中缩放时要遵循的规则。

可能的值为:

默认 在虚拟机规模集进行缩放时,如果规模集是区域性规模集,则规模集将首先跨区域进行均衡。 然后,它将尽可能跨容错域进行均衡。 在每个容错域中,选择要删除的虚拟机将是不受横向缩减保护的最新虚拟机。

OldestVM 缩小虚拟机规模集时,将选择删除未受到横向缩减保护的最早虚拟机。 对于区域性虚拟机规模集,规模集将首先跨区域均衡。 在每个区域中,将选择删除未受保护的最早虚拟机。

NewestVM 缩小虚拟机规模集时,将选择删除未受到横向缩减保护的最新虚拟机。 对于区域性虚拟机规模集,规模集将首先跨区域均衡。 在每个区域中,将选择删除未受保护的最新虚拟机。

VirtualMachineScaleSetStorageProfile

介绍虚拟机规模集存储配置文件。

VirtualMachineScaleSetVMProfile

介绍虚拟机规模集虚拟机配置文件。

VMDiskSecurityProfile

指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。

VMGalleryApplication

指定引用计算库应用程序版本所需的信息

VMSizeProperties

指定虚拟机上的 VM 大小属性设置。

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

WindowsVMGuestPatchAutomaticByPlatformSettings

指定在 Windows 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,业务流程模式为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,请在 VM 中手动应用修补程序。 在此模式下,自动更新被禁用;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

WinRMConfiguration

介绍 VM 的 Windows 远程管理配置

WinRMListener

介绍 Windows 远程管理侦听器的协议和指纹

AdditionalCapabilities

在虚拟机或虚拟机规模集上启用或禁用某个功能。

名称 类型 说明
hibernationEnabled

boolean

在 VM 上启用或禁用休眠功能的标志。

ultraSSDEnabled

boolean

一个标志,用于启用或禁用在 VM 或 VMSS 上具有UltraSSD_LRS存储帐户类型的一个或多个托管数据磁盘的功能。 仅当启用此属性时,才能将存储帐户类型为 UltraSSD_LRS 的托管磁盘添加到虚拟机或虚拟机规模集。

AdditionalUnattendContent

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 XML 格式信息。 通过设置名称、组件名称和应用内容的传递来定义内容。

名称 类型 说明
componentName

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

content

string

指定添加到指定路径和组件的 unattend.xml 文件的 XML 格式化内容。 XML 必须小于 4KB,并且必须包含要插入的设置或功能的根元素。

passName

PassNames

传递名称。 目前,唯一允许的值为 OobeSystem。

settingName

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

ApiEntityReference

API 实体引用。

名称 类型 说明
id

string

采用 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 资源 ID。

ApiError

Api 错误。

名称 类型 说明
code

string

错误代码。

details

ApiErrorBase[]

Api 错误详细信息

innererror

InnerError

Api 内部错误

message

string

错误消息。

target

string

特定错误的目标。

ApiErrorBase

Api 错误基。

名称 类型 说明
code

string

错误代码。

message

string

错误消息。

target

string

特定错误的目标。

ApplicationProfile

包含应提供给 VM/VMSS 的库应用程序列表

名称 类型 说明
galleryApplications

VMGalleryApplication[]

指定应提供给 VM/VMSS 的库应用程序

AutomaticOSUpgradePolicy

用于执行自动 OS 升级的配置参数。

名称 类型 说明
disableAutomaticRollback

boolean

是否应禁用 OS 映像回滚功能。 默认值为 false。

enableAutomaticOSUpgrade

boolean

指示当较新版本的 OS 映像可用时,是否应以滚动方式自动将 OS 升级应用于规模集实例。 默认值为 false。 对于基于 Windows 的规模集,如果此值设置为 true,enableAutomaticUpdates 将自动设置为 false,并且不能设置为 true。

osRollingUpgradeDeferral

boolean

指示自动 OS 升级是否应延迟。 延迟的 OS 升级将通过 IMDS 标记“Platform.PendingOSUpgrade”在每个 VM 的基础上发送高级通知,告知从滚动升级开始的 OS 升级正在传入。 然后,升级将推迟到通过 ApprovRollingUpgrade 调用批准升级。

useRollingUpgradePolicy

boolean

指示是否应在自动操作系统升级期间使用滚动升级策略。 默认值为 false。 如果未在 VMSS 上定义任何策略,则自动 OS 升级将回退到默认策略。

AutomaticRepairsPolicy

指定虚拟机规模集上的自动修复的配置参数。

名称 类型 说明
enabled

boolean

指定是否应在虚拟机规模集上启用自动修复。 默认值为 false。

gracePeriod

string

由于 VM 上的状态更改而暂停自动修复的时间量。 宽限时间在状态更改完成后开始。 这有助于避免过早或意外修复。 持续时间应以 ISO 8601 格式指定。 PT10M) (允许的最小宽限期为 10 分钟,这也是默认值。 pt90M) (允许的最大宽限期为 90 分钟。

repairAction

RepairAction

修复操作的类型 (替换、重启、重置映像) ,这些操作将用于修复规模集中的不正常虚拟机。 默认值为 replace。

BillingProfile

指定 Azure 现成 VM 或 VMSS 的计费相关详细信息。 最低 API 版本:2019-03-01。

名称 类型 说明
maxPrice

number

指定愿意为 Azure 现成 VM/VMSS 支付的最高价格。 此价格以美元为单位。

此价格将与 VM 大小的当前 Azure 现成价格进行比较。 此外,在创建/更新 Azure 现成 VM/VMSS 时会比较价格,仅当 maxPrice 大于当前 Azure 现成价格时,操作才会成功。

如果创建 VM/VMSS 后当前 Azure 现成价格超出 maxPrice,maxPrice 还将用于逐出 Azure 现成 VM/VMSS。

可能的值为:

- 任何大于零的十进制值。 示例:0.01538

-1 – 指示默认价格是按需的。

可以将 maxPrice 设置为 -1,以指示不应出于价格原因逐出 Azure 现成 VM/VMSS。 此外,如果未提供,则默认最大价格为 -1。

最低 API 版本:2019-03-01。

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

名称 类型 说明
enabled

boolean

是否应在虚拟机上启用启动诊断。

storageUri

string

用于放置控制台输出和屏幕截图的存储帐户的 URI。 如果在启用启动诊断时未指定 storageUri,将使用托管存储。

CachingTypes

指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 对于标准存储,默认值为: None。高级存储的 ReadOnly。

名称 类型 说明
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

容量预留配置文件的参数。

名称 类型 说明
capacityReservationGroup

SubResource

指定容量预留组资源 ID,该 ID 用于分配虚拟机或规模集 VM 实例,前提是已预留足够的容量。 有关更多详细信息,请参阅 https://aka.ms/CapacityReservation

CloudError

来自计算服务的错误响应。

名称 类型 说明
error

ApiError

Api 错误。

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

名称 类型 说明
Microsoft-Windows-Shell-Setup

string

DeleteOptions

指定删除 VM 时公共 IP 会发生什么情况

名称 类型 说明
Delete

string

Detach

string

DiagnosticsProfile

指定启动诊断设置状态。 最低 API 版本:2015-06-15。

名称 类型 说明
bootDiagnostics

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 注意:如果指定 storageUri,请确保存储帐户与 VM 位于同一区域和订阅中。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

DiffDiskOptions

指定操作系统磁盘的临时磁盘设置。

名称 类型 说明
Local

string

DiffDiskPlacement

指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的缓存磁盘、资源磁盘或 nvme 磁盘空间的位置。 有关临时 OS 磁盘大小要求的详细信息,请参阅 上的 Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本:2024-03-01。

名称 类型 说明
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意: 只能为托管磁盘指定临时磁盘设置。

名称 类型 说明
option

DiffDiskOptions

指定操作系统磁盘的临时磁盘设置。

placement

DiffDiskPlacement

指定操作系统磁盘的临时磁盘位置。 可能的值为: CacheDisk、ResourceDisk、NvmeDisk。 默认行为为:如果为 VM 大小配置 了 CacheDisk ,则使用 ResourceDiskNvmeDisk 。 请参阅 的 Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes 大小文档,检查哪些 VM 大小公开了缓存磁盘。 NvmeDisk 的最低 API 版本:2024-03-01。

DiskControllerTypes

名称 类型 说明
NVMe

string

SCSI

string

DiskCreateOptionTypes

指定应如何创建规模集中的虚拟机。 唯一允许的值为: FromImage。 使用映像创建虚拟机时,将使用此值。 如果使用平台映像,则还要使用上述 imageReference 元素。 如果使用市场映像,则还需使用前面所述的计划元素。

名称 类型 说明
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

指定在 VMSS 灵活删除时是应删除还是分离 OS 磁盘 (此功能仅适用于灵活 OrchestrationMode) VMSS。

可能的值:

删除 如果使用此值,则会在删除 VMSS Flex VM 时删除 OS 磁盘。

分离 如果使用此值,则会在删除 VMSS Flex VM 后保留 OS 磁盘。

默认值设置为 Delete。 对于临时 OS 磁盘,默认值设置为 Delete。 用户无法更改临时 OS 磁盘的删除选项。

名称 类型 说明
Delete

string

Detach

string

DiskEncryptionSetParameters

介绍可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview

名称 类型 说明
id

string

资源 ID

DomainNameLabelScopeTypes

域名标签范围。根据策略从域名标签范围和 vm 索引生成的哈希域名标签是将要创建的 PublicIPAddress 资源的域名标签

名称 类型 说明
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

指定 ADE 用于获取密钥保管库操作的访问令牌的托管标识。

名称 类型 说明
userAssignedIdentityResourceId

string

指定与 VM 关联的用户标识之一的 ARM 资源 ID。

EventGridAndResourceGraph

指定 eventGridAndResourceGraph 相关的计划事件相关配置。

名称 类型 说明
enable

boolean

指定是否为计划事件相关配置启用了事件网格和资源图。

ExtendedLocation

扩展位置的复杂类型。

名称 类型 说明
name

string

扩展位置的名称。

type

ExtendedLocationTypes

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称 类型 说明
EdgeZone

string

ImageReference

指定要使用的映像的相关信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但未在其他创建操作中使用,则此元素是必需的。 注意:只能在创建规模集时设置映像引用发布者和产品/服务。

名称 类型 说明
communityGalleryImageId

string

指定了 vm 部署的社区库映像唯一 ID。 这可以从社区库映像 GET 调用中提取。

exactVersion

string

以十进制数字指定用于创建虚拟机的平台映像或市场映像的版本。 仅当“version”字段中指定的值为“latest”时,此只读字段与“version”不同。

id

string

资源 ID

offer

string

指定用于创建虚拟机的平台映像或市场映像的套餐。

publisher

string

映像发布者。

sharedGalleryImageId

string

指定 VM 部署的共享库映像唯一 ID。 这可以从共享库映像 GET 调用中提取。

sku

string

映像 SKU。

version

string

指定用于创建虚拟机的平台映像或市场映像的版本。 允许的格式为 Major.Minor.Build 或“latest”。 主要、次要和内部版本是十进制数。 指定“latest”以使用部署时可用的最新版本的映像。 即使使用“最新”,VM 映像也不会在部署后自动更新,即使新版本可用。 请不要对库映像部署使用字段“version”,库映像应始终使用“id”字段进行部署,若要使用库映像的“最新”版本,只需在“id”字段中设置“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleryName}/images/{imageName}”。

InnerError

内部错误详细信息。

名称 类型 说明
errordetail

string

内部错误消息或异常转储。

exceptiontype

string

异常类型。

IPVersion

从 Api-Version 2019-07-01 开始提供,它表示特定的 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 可能的值为:“IPv4”和“IPv6”。

名称 类型 说明
IPv4

string

IPv6

string

KeyVaultSecretReference

描述对 Key Vault 机密的引用

名称 类型 说明
secretUrl

string

引用 Key Vault 中的机密的 URL。

sourceVault

SubResource

包含机密的 Key Vault 的相对 URL。

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 发行版的列表,请参阅 Linux on Azure-Endorsed Distributions

名称 类型 说明
disablePasswordAuthentication

boolean

指定是否应禁用密码身份验证。

enableVMAgentPlatformUpdates

boolean

指示是否为 Linux 虚拟机启用 VMAgent 平台更新。 默认值为 false。

patchSettings

LinuxPatchSettings

[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。

provisionVMAgent

boolean

指示是否应在虚拟机上设置虚拟机代理。 如果未在请求正文中指定此属性,则默认行为是将其设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。

ssh

SshConfiguration

指定 Linux OS 的 SSH 密钥配置。

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

指定与 Linux 上的 VM 来宾修补相关的设置。

名称 类型 说明
assessmentMode

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

指定 Linux 上的 VM 来宾修补中的修补模式 AutomaticByPlatform 的其他设置。

patchMode

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,业务流程模式为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

名称 类型 说明
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

指定在 Linux 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

名称 类型 说明
bypassPlatformSafetyChecksOnUserSchedule

boolean

使客户能够计划修补,而无需意外升级

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,它将强制实施访问控制。 默认值为“强制模式”。

名称 类型 说明
Audit

string

Enforce

string

NetworkApiVersion

指定在业务流程模式为“灵活”的虚拟机规模集的网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本

名称 类型 说明
2020-11-01

string

NetworkInterfaceAuxiliaryMode

指定是否为网络接口资源启用辅助模式。

名称 类型 说明
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

指定是否为网络接口资源启用辅助 SKU。

名称 类型 说明
A1

string

A2

string

A4

string

A8

string

None

string

OperatingSystemTypes

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括: Windows、Linux。

名称 类型 说明
Linux

string

Windows

string

OrchestrationMode

指定虚拟机规模集的业务流程模式。

名称 类型 说明
Flexible

string

Uniform

string

OSImageNotificationProfile

名称 类型 说明
enable

boolean

指定是启用或禁用 OS 映像计划事件。

notBeforeTimeout

string

重置映像或升级其 OS 的虚拟机可能需要批准 OS 映像计划事件的时间长度,然后才能自动批准该事件 (超时) 。 配置以 ISO 8601 格式指定,值必须为 15 分钟 (PT15M)

PassNames

传递名称。 目前,唯一允许的值为 OobeSystem。

名称 类型 说明
OobeSystem

string

PatchSettings

指定与 Windows 上的 VM 来宾修补相关的设置。

名称 类型 说明
assessmentMode

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

指定 Windows 上的 VM 来宾修补中的修补模式 AutomaticByPlatform 的其他设置。

enableHotpatching

boolean

使客户无需重启即可修补其 Azure VM。 对于 enableHotpatching,必须将“provisionVMAgent”设置为 true,“patchMode”必须设置为“AutomaticByPlatform”。

patchMode

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,业务流程模式为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,请在 VM 中手动应用修补程序。 在此模式下,自动更新被禁用;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

Plan

指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以供编程使用,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击“ 想要以编程方式部署”“入门”->。 输入任何所需信息,然后单击“ 保存”。

名称 类型 说明
name

string

计划 ID。

product

string

指定市场中映像的产品。 此值与 imageReference 元素下的 Offer 相同。

promotionCode

string

促销代码。

publisher

string

发布者 ID。

PriorityMixPolicy

指定具有灵活业务流程模式的规模集中现成 VM 和常规优先级 VM 的目标拆分。 借助此属性,客户能够指定在 VMSS 灵活实例横向扩展时创建的常规优先级 VM 的基数,以及在达到此基本目标后在现成 VM 和常规优先级 VM 之间拆分。

名称 类型 说明
baseRegularPriorityCount

integer

横向扩展时,将在此规模集中创建的常规优先级 VM 的基数。

regularPriorityPercentageAboveBase

integer

达到基本常规优先级计数后,应使用常规优先级的 VM 实例的百分比。

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。

名称 类型 说明
Http

string

Https

string

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

名称 类型 说明
enabled

boolean

指定是在虚拟机规模集还是虚拟机规模集上启用 ProxyAgent 功能。

keyIncarnationId

integer

增加此属性的值可让用户重置用于保护来宾和主机之间的信道的密钥。

mode

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,它将强制实施访问控制。 默认值为“强制模式”。

PublicIPAddressSku

介绍公共 IP SKU。 只能将 OrchestrationMode 设置为灵活。

名称 类型 说明
name

PublicIPAddressSkuName

指定公共 IP SKU 名称

tier

PublicIPAddressSkuTier

指定公共 IP SKU 层

PublicIPAddressSkuName

指定公共 IP SKU 名称

名称 类型 说明
Basic

string

Standard

string

PublicIPAddressSkuTier

指定公共 IP SKU 层

名称 类型 说明
Global

string

Regional

string

RepairAction

修复操作的类型 (替换、重启、重置映像) ,这些操作将用于修复规模集中的不正常虚拟机。 默认值为 replace。

名称 类型 说明
Reimage

string

Replace

string

Restart

string

ResiliencyPolicy

描述复原策略 - resiliencVMCreationPolicy 和/或 resiliencVMDeletionPolicy。

名称 类型 说明
resilientVMCreationPolicy

ResilientVMCreationPolicy

执行可复原 VM 创建时使用的配置参数。

resilientVMDeletionPolicy

ResilientVMDeletionPolicy

执行可复原 VM 删除时使用的配置参数。

ResilientVMCreationPolicy

执行可复原 VM 创建时使用的配置参数。

名称 类型 说明
enabled

boolean

指定是否应在虚拟机规模集上启用可复原 VM 创建。 默认值为 false。

ResilientVMDeletionPolicy

执行可复原 VM 删除时使用的配置参数。

名称 类型 说明
enabled

boolean

指定是否应在虚拟机规模集上启用可复原 VM 删除。 默认值为 false。

ResourceIdentityType

用于虚拟机规模集的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RollingUpgradePolicy

执行滚动升级时使用的配置参数。

名称 类型 说明
enableCrossZoneUpgrade

boolean

允许 VMSS 在构造升级批处理时忽略 AZ 边界。 请考虑更新域和 maxBatchInstancePercent 来确定批大小。

maxBatchInstancePercent

integer

通过一批滚动升级同时升级的总虚拟机实例的最大百分比。 由于这是最大值,以前或将来的批处理中运行不正常的实例可能会导致批处理中的实例百分比降低,以确保更高的可靠性。 此参数的默认值为 20%。

maxSurge

boolean

创建新的虚拟机来升级规模集,而不是更新现有虚拟机。 为每个批处理创建新虚拟机后,将删除现有虚拟机。

maxUnhealthyInstancePercent

integer

规模集中可能同时运行不正常的虚拟机实例总数的最大百分比,可以是升级的结果,或者虚拟机运行状况检查在滚动升级中止之前发现处于不正常状态。 在启动任何批处理之前,将检查此约束。 此参数的默认值为 20%。

maxUnhealthyUpgradedInstancePercent

integer

可发现处于不正常状态的已升级虚拟机实例的最大百分比。 此检查将在每个批处理升级后进行。 如果超过此百分比,滚动更新将中止。 此参数的默认值为 20%。

pauseTimeBetweenBatches

string

完成一批中所有虚拟机的更新到开始下一批之间的等待时间。 持续时间应以 ISO 8601 格式指定。 默认值为 0 秒 (PT0S) 。

prioritizeUnhealthyInstances

boolean

升级规模集中所有不正常的实例,然后再升级任何正常实例。

rollbackFailedInstancesOnPolicyBreach

boolean

如果违反滚动升级策略,将失败的实例回滚到以前的模型。

ScaleInPolicy

介绍虚拟机规模集的横向缩减策略。

名称 类型 说明
forceDeletion

boolean

此属性允许指定在虚拟机规模集正在缩放时,是否必须强制删除选择删除的虚拟机。 (预览版中的功能)

rules

VirtualMachineScaleSetScaleInRules[]

在虚拟机规模集中缩放时要遵循的规则。

可能的值为:

默认 在中缩放虚拟机规模集时,如果规模集是区域性规模集,则规模集将首先跨区域进行均衡。 然后,它将尽可能跨容错域进行均衡。 在每个容错域中,选择要删除的虚拟机将是最新的虚拟机,这些虚拟机不受横向缩减保护。

OldestVM 当虚拟机规模集进行横向缩减时,将选择最旧的不受缩减保护的虚拟机进行删除。 对于区域性虚拟机规模集,规模集将首先跨区域进行均衡。 在每个区域中,将选择未受保护的最早虚拟机进行删除。

NewestVM 在缩减虚拟机规模集时,将选择未受到横向缩减保护的最新虚拟机进行删除。 对于区域性虚拟机规模集,规模集将首先跨区域进行均衡。 在每个区域中,将选择未受保护的最新虚拟机进行删除。

ScheduledEventsAdditionalPublishingTargets

名称 类型 说明
eventGridAndResourceGraph

EventGridAndResourceGraph

创建 eventGridAndResourceGraph Scheduled Event 设置时使用的配置参数。

ScheduledEventsPolicy

指定与重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关的配置。

名称 类型 说明
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

发布 scheduledEventsAdditionalPublishingTargets 时使用的配置参数。

userInitiatedReboot

UserInitiatedReboot

创建 userInitiatedReboot 计划事件设置创建时使用的配置参数。

userInitiatedRedeploy

UserInitiatedRedeploy

创建 userInitiatedRedeploy 计划事件设置创建时使用的配置参数。

ScheduledEventsProfile

名称 类型 说明
osImageNotificationProfile

OSImageNotificationProfile

指定与 OS 映像计划事件相关的配置。

terminateNotificationProfile

TerminateNotificationProfile

指定与终止计划事件相关的配置。

securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

名称 类型 说明
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityPostureReference

指定要在规模集中使用的安全状况。 最低 API 版本:2023-03-01

名称 类型 说明
excludeExtensions

string[]

应用安全状况时要排除的虚拟机扩展名称的列表。

id

string

安全状况参考 ID 的格式为 /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest

isOverridable

boolean

用户是否可以覆盖安全状况。

SecurityProfile

指定虚拟机或虚拟机规模集的安全配置文件设置。

名称 类型 说明
encryptionAtHost

boolean

用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密,包括主机本身的资源/临时磁盘。 默认行为为:除非资源的此属性设置为 true,否则将禁用主机上的加密。

encryptionIdentity

EncryptionIdentity

指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。

proxyAgentSettings

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

securityType

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

uefiSettings

UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

名称 类型 说明
ConfidentialVM

string

TrustedLaunch

string

ServiceArtifactReference

指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 最低 API 版本:2022-11-01

名称 类型 说明
id

string

服务项目引用 ID 的格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

名称 类型 说明
AutoLogon

string

FirstLogonCommands

string

Sku

介绍虚拟机规模集 SKU。 注意:如果规模集当前使用的硬件不支持新的 VM SKU,则需要在修改 SKU 名称之前解除分配规模集中的 VM。

名称 类型 说明
capacity

integer

指定规模集中的虚拟机数。

name

string

SKU 名称。

tier

string

指定规模集中虚拟机的层。

可能的值:

标准

基本

SpotRestorePolicy

指定虚拟机规模集的 Spot-Try-Restore 属性。 借助此属性,客户可以根据容量可用性和定价约束,以机会启用或禁用逐出的现成 VMSS VM 实例的自动还原。

名称 类型 说明
enabled

boolean

启用现成-试用-还原功能,根据容量可用性和定价约束尝试以机会方式还原已逐出的 VMSS SPOT 实例

restoreTimeout

string

表示为 ISO 8601 持续时间的超时值,此后平台不会尝试还原 VMSS SPOT 实例

SshConfiguration

适用于在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置

名称 类型 说明
publicKeys

SshPublicKey[]

用于在基于 Linux 的 VM 中进行身份验证的 SSH 公钥列表。

SshPublicKey

包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。

名称 类型 说明
keyData

string

用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥需要至少为 2048 位且采用 ssh-rsa 格式。 若要创建 SSH 密钥,请参阅 [在 Linux 和 Mac 上为 Azure 中的 Linux VM 创建 SSH 密钥]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

指定所创建的 VM 上存储 ssh 公钥的完整路径。 如果该文件已存在,则指定的密钥将追加到该文件上。 示例:/home/user/.ssh/authorized_keys

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。

名称 类型 说明
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

名称 类型 说明
id

string

资源 ID

TerminateNotificationProfile

名称 类型 说明
enable

boolean

指定是启用或禁用 Terminate Scheduled 事件。

notBeforeTimeout

string

在自动批准该事件之前,要删除的虚拟机可能需要批准“终止计划事件”的可配置时间长度, () 超时。 必须以 ISO 8601 格式指定配置,默认值为 5 分钟 (PT5M)

UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

名称 类型 说明
secureBootEnabled

boolean

指定是否应在虚拟机上启用安全启动。 最低 API 版本:2020-12-01。

vTpmEnabled

boolean

指定是否应在虚拟机上启用 vTPM。 最低 API 版本:2020-12-01。

UpgradeMode

指定升级到规模集中虚拟机的模式。

可能的值为:

手动 - 控制将更新应用到规模集中的虚拟机。 可以使用 manualUpgrade 操作执行此操作。

自动 - 规模集中的所有虚拟机同时自动更新。

名称 类型 说明
Automatic

string

Manual

string

Rolling

string

UpgradePolicy

描述升级策略 - 自动、手动或滚动。

名称 类型 说明
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

用于执行自动 OS 升级的配置参数。

mode

UpgradeMode

指定升级到规模集中虚拟机的模式。

可能的值为:

手动 - 控制将更新应用到规模集中的虚拟机。 可以使用 manualUpgrade 操作执行此操作。

自动 - 规模集中的所有虚拟机同时自动更新。

rollingUpgradePolicy

RollingUpgradePolicy

执行滚动升级时使用的配置参数。

UserAssignedIdentities

与虚拟机关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称 类型 说明

UserInitiatedReboot

指定与重启相关的计划事件相关配置。

名称 类型 说明
automaticallyApprove

boolean

指定与重新启动计划事件相关的配置。

UserInitiatedRedeploy

指定重新部署相关的计划事件相关配置。

名称 类型 说明
automaticallyApprove

boolean

指定与重新部署计划事件相关的配置。

VaultCertificate

描述 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。

名称 类型 说明
certificateStore

string

对于 Windows VM,指定应向其添加证书的虚拟机上的证书存储。 指定的证书存储隐式位于 LocalMachine 帐户中。 对于 Linux VM,证书文件放置在 /var/lib/waagent 目录下,X509 证书文件的文件名 <为 UppercaseThumbprint.crt>, <私钥文件名为 UppercaseThumbprint.prv>。 这两个文件都采用 .pem 格式。

certificateUrl

string

这是已作为机密上传到 Key Vault 的证书的 URL。 若要将机密添加到 Key Vault,请参阅 将密钥或机密添加到密钥保管库。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象以 UTF-8 编码:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虚拟机上安装证书,建议使用 适用于 Linux 的 Azure Key Vault 虚拟机扩展适用于 Windows 的 Azure Key Vault 虚拟机扩展

VaultSecretGroup

描述一组证书,这些证书都位于同一 Key Vault 中。

名称 类型 说明
sourceVault

SubResource

包含 VaultCertificates 中所有证书的 Key Vault 的相对 URL。

vaultCertificates

VaultCertificate[]

SourceVault 中包含证书的密钥保管库引用列表。

VirtualHardDisk

描述磁盘的 URI。

名称 类型 说明
uri

string

指定虚拟硬盘的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure 现成虚拟机和 Azure 现成规模集的逐出策略。 对于 Azure 现成虚拟机,支持“Deallocate”和“Delete”,最低 api 版本为 2019-03-01。 对于 Azure 现成规模集,支持“Deallocate”和“Delete”,最低 api 版本为 2017-10-30-preview。

名称 类型 说明
Deallocate

string

Delete

string

VirtualMachinePriorityTypes

指定规模集中虚拟机的优先级。 最低 API 版本:2017-10-30-preview。

名称 类型 说明
Low

string

Regular

string

Spot

string

VirtualMachineScaleSet

介绍虚拟机规模集。

名称 类型 说明
etag

string

Etag 是在 VMSS 的创建/更新/获取响应中返回的属性,以便客户可以在标头中提供它,以确保乐观更新

extendedLocation

ExtendedLocation

虚拟机规模集的扩展位置。

id

string

资源 ID

identity

VirtualMachineScaleSetIdentity

虚拟机规模集的标识(如果已配置)。

location

string

资源位置

name

string

资源名称

plan

Plan

指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以供编程使用,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击“ 想要以编程方式部署”“入门”->。 输入任何所需信息,然后单击“ 保存”。

properties.additionalCapabilities

AdditionalCapabilities

指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。 例如:虚拟机是否支持附加UltraSSD_LRS存储帐户类型的托管数据磁盘。

properties.automaticRepairsPolicy

AutomaticRepairsPolicy

自动修复策略。

properties.constrainedMaximumCapacity

boolean

必须设置为 True 或省略的可选属性。

properties.doNotRunExtensionsOnOverprovisionedVMs

boolean

启用过度预配后,扩展仅在最终保留的请求数目的 VM 上启动。 因此,此属性将确保扩展不会在额外的过度预配的 VM 上运行。

properties.hostGroup

SubResource

指定有关虚拟机规模集驻留的专用主机组的信息。 最低 API 版本:2020-06-01。

properties.orchestrationMode

OrchestrationMode

指定虚拟机规模集的业务流程模式。

properties.overprovision

boolean

指定是否应过度预配虚拟机规模集。

properties.platformFaultDomainCount

integer

每个放置组的容错域计数。

properties.priorityMixPolicy

PriorityMixPolicy

指定用于在同一 VMSS Flex 实例中混合现成 VM 和常规优先级 VM 的所需目标。

properties.provisioningState

string

预配状态,仅显示在响应中。

properties.proximityPlacementGroup

SubResource

指定虚拟机规模集应分配到的邻近放置组的相关信息。 最低 API 版本:2018-04-01。

properties.resiliencyPolicy

ResiliencyPolicy

复原策略

properties.scaleInPolicy

ScaleInPolicy

指定在虚拟机规模集中的虚拟机中缩放时应用的策略。

properties.scheduledEventsPolicy

ScheduledEventsPolicy

ScheduledEventsPolicy。

properties.singlePlacementGroup

boolean

如果为 true,则会将规模集限制为单个放置组,最大大小为 100 个虚拟机。 注意:如果 singlePlacementGroup 为 true,则可能会将其修改为 false。 但是,如果 singlePlacementGroup 为 false,则不可将其修改为 true。

properties.spotRestorePolicy

SpotRestorePolicy

指定虚拟机规模集的现成还原属性。

properties.timeCreated

string

指定创建虚拟机规模集资源的时间。 最低 API 版本:2021-11-01。

properties.uniqueId

string

指定唯一标识虚拟机规模集的 ID。

properties.upgradePolicy

UpgradePolicy

升级策略。

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

虚拟机配置文件。

properties.zoneBalance

boolean

在发生区域中断时,是否强制在 x 区域间严格均匀地进行虚拟机分发。 仅当规模集的 zone 属性包含多个区域时,才能设置 zoneBalance 属性。 如果没有指定区域或仅指定了一个区域,则不应设置 zoneBalance 属性。

sku

Sku

虚拟机规模集 SKU。

tags

object

资源标记

type

string

资源类型

zones

string[]

虚拟机规模集区域。 注意:只能在创建规模集时设置可用性区域

VirtualMachineScaleSetDataDisk

介绍虚拟机规模集数据磁盘。

名称 类型 说明
caching

CachingTypes

指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 对于标准存储,默认值为: None。高级存储的 ReadOnly。

createOption

DiskCreateOptionTypes

创建选项。

deleteOption

DiskDeleteOptionTypes

指定在 VMSS 灵活删除时是应删除还是分离数据磁盘 (此功能仅适用于具有灵活 OrchestrationMode 的 VMSs) 。

可能的值:

删除 如果使用此值,则删除 VMSS Flex VM 时会删除数据磁盘。

分离 如果使用此值,则删除 VMSS Flex VM 后,数据磁盘将保留。

默认值设置为 Delete

diskIOPSReadWrite

integer

指定托管磁盘 Read-Write IOPS。 应仅在UltraSSD_LRS StorageAccountType 时才使用。 如果未指定,将根据 diskSizeGB 分配默认值。

diskMBpsReadWrite

integer

指定托管磁盘的带宽(以 MB/秒为单位)。 应仅在UltraSSD_LRS StorageAccountType 时才使用。 如果未指定,将根据 diskSizeGB 分配默认值。

diskSizeGB

integer

指定空数据磁盘的大小(以 GB 为单位)。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性 diskSizeGB 是磁盘的字节数 x 1024^3,该值不能大于 1023。

lun

integer

指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘,因此对于附加到 VM 的每个数据磁盘必须是唯一的。

managedDisk

VirtualMachineScaleSetManagedDiskParameters

托管磁盘参数。

name

string

磁盘名称。

writeAcceleratorEnabled

boolean

指定是在磁盘上启用或禁用 writeAccelerator。

VirtualMachineScaleSetExtension

介绍虚拟机规模集扩展。

名称 类型 说明
id

string

资源 ID

name

string

扩展插件的名称。

properties.autoUpgradeMinorVersion

boolean

指示扩展是否应使用较新的次要版本(如果在部署时可用)。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

properties.enableAutomaticUpgrade

boolean

指示如果有较新版本的可用扩展,平台是否应自动升级扩展。

properties.forceUpdateTag

string

如果提供的值与以前的值不同,则即使扩展配置未更改,也会强制更新扩展处理程序。

properties.protectedSettings

object

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

通过引用传递并从密钥保管库使用的扩展保护设置

properties.provisionAfterExtensions

string[]

扩展名称的集合,之后需要预配此扩展。

properties.provisioningState

string

预配状态,仅显示在响应中。

properties.publisher

string

扩展处理程序发布者的名称。

properties.settings

object

扩展的 Json 格式的公共设置。

properties.suppressFailures

boolean

指示无论此值) 如何,都不会禁止因扩展而引发的故障 (操作故障(如未连接到 VM)。 默认值为 false。

properties.type

string

指定扩展的类型;例如“CustomScriptExtension”。

properties.typeHandlerVersion

string

指定脚本处理程序的版本。

type

string

资源类型

VirtualMachineScaleSetExtensionProfile

描述虚拟机规模集扩展配置文件。

名称 类型 说明
extensions

VirtualMachineScaleSetExtension[]

虚拟机规模集子扩展资源。

extensionsTimeBudget

string

指定为所有扩展分配的启动时间。 持续时间应介于 15 分钟到 120 分钟之间, (包括) ,并且应以 ISO 8601 格式指定。 默认值为 90 分钟 (PT1H30M) 。 最低 API 版本:2020-06-01。

VirtualMachineScaleSetHardwareProfile

指定虚拟机规模集的硬件设置。

名称 类型 说明
vmSizeProperties

VMSizeProperties

指定用于自定义虚拟机大小的属性。 最低 API 版本:2021-11-01。 有关更多详细信息,请按照 VM 自定义 中的说明进行操作。

VirtualMachineScaleSetIdentity

虚拟机规模集的标识。

名称 类型 说明
principalId

string

虚拟机规模集标识的主体 ID。 仅为系统分配的标识提供此属性。

tenantId

string

与虚拟机规模集关联的租户 ID。 仅为系统分配的标识提供此属性。

type

ResourceIdentityType

用于虚拟机规模集的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。

userAssignedIdentities

UserAssignedIdentities

与虚拟机规模集关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

VirtualMachineScaleSetIPConfiguration

介绍虚拟机规模集网络配置文件的 IP 配置。

名称 类型 说明
name

string

IP 配置名称。

properties.applicationGatewayBackendAddressPools

SubResource[]

指定对应用程序网关的后端地址池的引用数组。 规模集可以引用多个应用程序网关的后端地址池。 多个规模集不能使用相同的应用程序网关。

properties.applicationSecurityGroups

SubResource[]

指定对应用程序安全组的引用数组。

properties.loadBalancerBackendAddressPools

SubResource[]

指定对负载均衡器的后端地址池的引用数组。 规模集可以引用一个公共负载均衡器和一个内部负载均衡器的后端地址池。 多个规模集不能使用相同的基本 SKU 负载均衡器。

properties.loadBalancerInboundNatPools

SubResource[]

指定对负载均衡器的入站 Nat 池的引用数组。 规模集可以引用一个公共负载均衡器和一个内部负载均衡器的入站 nat 池。 多个规模集不能使用相同的基本 SKU 负载均衡器。

properties.primary

boolean

指定主网络接口,以防虚拟机具有 1 个以上的网络接口。

properties.privateIPAddressVersion

IPVersion

从 Api-Version 2017-03-30 开始提供,它表示特定的 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 可能的值为:“IPv4”和“IPv6”。

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

publicIPAddressConfiguration。

properties.subnet

ApiEntityReference

指定子网的标识符。

VirtualMachineScaleSetIpTag

包含与公共 IP 地址关联的 IP 标记。

名称 类型 说明
ipTagType

string

IP 标记类型。 示例:FirstPartyUsage。

tag

string

与公共 IP 关联的 IP 标记。 示例:SQL、存储等

VirtualMachineScaleSetListResult

列出虚拟机操作响应。

名称 类型 说明
nextLink

string

用于提取虚拟机规模集下一页的 URI。 调用 ListNext () 以提取 VMSS 的下一页。

value

VirtualMachineScaleSet[]

虚拟机规模集的列表。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 托管磁盘的参数。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

指定托管磁盘的客户托管磁盘加密集资源 ID。

securityProfile

VMDiskSecurityProfile

指定托管磁盘的安全配置文件。

storageAccountType

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,不能与 OS 磁盘一起使用。

VirtualMachineScaleSetNetworkConfiguration

介绍虚拟机规模集网络配置文件的网络配置。

名称 类型 说明
name

string

网络配置名称。

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

指定是否为网络接口资源启用辅助模式。

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

指定是否为网络接口资源启用辅助 SKU。

properties.deleteOption

DeleteOptions

指定删除 VM 时网络接口会发生什么情况

properties.disableTcpStateTracking

boolean

指定是否为 tcp 状态跟踪禁用网络接口。

properties.dnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings

要应用于网络接口的 dns 设置。

properties.enableAcceleratedNetworking

boolean

指定网络接口是否已启用加速网络。

properties.enableFpga

boolean

指定网络接口是否已启用 FPGA 网络。

properties.enableIPForwarding

boolean

是否在此 NIC 上启用了 IP 转发。

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

指定网络接口的 IP 配置。

properties.networkSecurityGroup

SubResource

网络安全组。

properties.primary

boolean

指定主网络接口,以防虚拟机具有 1 个以上的网络接口。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

介绍虚拟机规模集网络配置的 DNS 设置。

名称 类型 说明
dnsServers

string[]

DNS 服务器 IP 地址列表

VirtualMachineScaleSetNetworkProfile

介绍虚拟机规模集网络配置文件。

名称 类型 说明
healthProbe

ApiEntityReference

对负载均衡器探测的引用,用于确定虚拟机规模集中实例的运行状况。 引用的格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}”。

networkApiVersion

NetworkApiVersion

指定在业务流程模式为“灵活”的虚拟机规模集的网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本

networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

网络配置列表。

VirtualMachineScaleSetOSDisk

介绍虚拟机规模集操作系统磁盘。

名称 类型 说明
caching

CachingTypes

指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 对于标准存储,默认值为: None。高级存储的 ReadOnly。

createOption

DiskCreateOptionTypes

指定应如何创建规模集中的虚拟机。 唯一允许的值为: FromImage。 使用映像创建虚拟机时,将使用此值。 如果使用平台映像,则还需要使用上述 imageReference 元素。 如果使用的是市场映像,则还需要使用前面所述的 plan 元素。

deleteOption

DiskDeleteOptionTypes

指定在 VMSS Flex 删除时是应删除还是分离 OS 磁盘, (此功能仅适用于仅) 灵活 OrchestrationMode 的 VMSS。

可能的值:

删除 如果使用此值,则会在删除 VMSS Flex VM 时删除 OS 磁盘。

分离 如果使用此值,则删除 VMSS Flex VM 后,OS 磁盘将保留。

默认值设置为 Delete。 对于临时 OS 磁盘,默认值设置为 Delete。 用户无法更改临时 OS 磁盘的删除选项。

diffDiskSettings

DiffDiskSettings

指定虚拟机规模集使用的操作系统磁盘的临时磁盘设置。

diskSizeGB

integer

指定空数据磁盘的大小(以 GB 为单位)。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性“diskSizeGB”是磁盘的字节数 x 1024^3,该值不能大于 1023。

image

VirtualHardDisk

指定要基于规模集的非托管用户映像的信息。

managedDisk

VirtualMachineScaleSetManagedDiskParameters

托管磁盘参数。

name

string

磁盘名称。

osType

OperatingSystemTypes

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 的类型。 可能的值为: Windows、Linux。

vhdContainers

string[]

指定用于存储规模集操作系统磁盘的容器 URL。

writeAcceleratorEnabled

boolean

指定是在磁盘上启用或禁用 writeAccelerator。

VirtualMachineScaleSetOSProfile

介绍虚拟机规模集 OS 配置文件。

名称 类型 说明
adminPassword

string

指定管理员帐户的密码。

Windows) 最小长度 (: 8 个字符

Linux) 最小长度 (: 6 个字符

最大长度 (Windows) : 123 个字符

Linux) 最大 (长度: 72 个字符

复杂性要求: 需要满足以下 4 个条件中的 3 个
包含较低的字符
包含大写字符
具有数字
具有特殊字符 (正则表达式匹配 [\W_])

不允许的值: “abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password!”、“Password1”、“Password22”、“iloveyou!”

有关重置密码的信息,请参阅 如何在 Windows VM 中重置远程桌面服务或其登录密码

有关重置根密码的信息,请参阅 使用 VMAccess 扩展管理用户、SSH 以及检查或修复 Azure Linux VM 上的磁盘

adminUsername

string

指定管理员帐户的名称。

仅限 Windows 的限制: 不能以“.”结尾

不允许的值: “administrator”、“admin”、“user”、“user1”、“test”、“user2”、“test1”、“user3”、“admin1”、“1”, “123”、“a”、“actuser”、“adm”、“admin2”、“aspnet”、“backup”、“console”、“david”、“guest”、“john”、“owner”、“root”、“server”、“support”、“support_388945a0”、“sys”、“test2”、“test3”、“user4”、“user5”。

Linux) (最小长度: 1 个字符

最大长度 (Linux) : 64 个字符

Windows) 最大 (长度: 20 个字符

allowExtensionOperations

boolean

指定是否应在虚拟机规模集上允许扩展操作。 仅当虚拟机规模集上没有扩展时,才能将其设置为 False。

computerNamePrefix

string

指定规模集中所有虚拟机的计算机名称前缀。 计算机名称前缀的长度必须为 1 到 15 个字符。

customData

string

指定自定义数据的 Base-64 编码的字符串。 Base-64 编码的字符串将解码为一个二元数组并作为一个文件保存在虚拟机上。 该二元数组的最大长度为 65535 字节。 有关对 VM 使用 cloud-init,请参阅 在创建期间使用 cloud-init 自定义 Linux VM

linuxConfiguration

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 分发版的列表,请参阅 Linux on Azure-Endorsed Distributions

requireGuestProvisionSignal

boolean

必须设置为 True 或省略的可选属性。

secrets

VaultSecretGroup[]

指定应安装在规模集中虚拟机上的证书集。 若要在虚拟机上安装证书,建议使用 适用于 Linux 的 Azure Key Vault 虚拟机扩展适用于 Windows 的 Azure Key Vault 虚拟机扩展

windowsConfiguration

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

VirtualMachineScaleSetPublicIPAddressConfiguration

介绍虚拟机规模集 IP 配置的 PublicIPAddress 配置

名称 类型 说明
name

string

publicIP 地址配置名称。

properties.deleteOption

DeleteOptions

指定删除 VM 时公共 IP 会发生什么情况

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

要应用于 publicIP 地址 的 dns 设置。

properties.idleTimeoutInMinutes

integer

公共 IP 地址的空闲超时。

properties.ipTags

VirtualMachineScaleSetIpTag[]

与公共 IP 地址关联的 IP 标记列表。

properties.publicIPAddressVersion

IPVersion

从 Api-Version 2019-07-01 开始提供,它表示特定的 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 可能的值为:“IPv4”和“IPv6”。

properties.publicIPPrefix

SubResource

要从中分配 publicIP 地址的 PublicIPPrefix。

sku

PublicIPAddressSku

介绍公共 IP SKU。 只能将 OrchestrationMode 设置为灵活。

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

介绍虚拟机规模集网络配置的 DNS 设置。

名称 类型 说明
domainNameLabel

string

域名标签。域名标签和 vm 索引的串联将是将创建的 PublicIPAddress 资源的域名标签

domainNameLabelScope

DomainNameLabelScopeTypes

域名标签范围。根据策略从域名标签范围和 vm 索引生成的哈希域名标签是将要创建的 PublicIPAddress 资源的域名标签

VirtualMachineScaleSetScaleInRules

在虚拟机规模集中缩放时要遵循的规则。

可能的值为:

默认 在虚拟机规模集进行缩放时,如果规模集是区域性规模集,则规模集将首先跨区域进行均衡。 然后,它将尽可能跨容错域进行均衡。 在每个容错域中,选择要删除的虚拟机将是不受横向缩减保护的最新虚拟机。

OldestVM 缩小虚拟机规模集时,将选择删除未受到横向缩减保护的最早虚拟机。 对于区域性虚拟机规模集,规模集将首先跨区域均衡。 在每个区域中,将选择删除未受保护的最早虚拟机。

NewestVM 缩小虚拟机规模集时,将选择删除未受到横向缩减保护的最新虚拟机。 对于区域性虚拟机规模集,规模集将首先跨区域均衡。 在每个区域中,将选择删除未受保护的最新虚拟机。

名称 类型 说明
Default

string

NewestVM

string

OldestVM

string

VirtualMachineScaleSetStorageProfile

介绍虚拟机规模集存储配置文件。

名称 类型 说明
dataDisks

VirtualMachineScaleSetDataDisk[]

指定用于将数据磁盘添加到规模集中的虚拟机的参数。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD

diskControllerType

DiskControllerTypes[]

指定为规模集中的虚拟机配置的磁盘控制器类型。 最低 API 版本:2022-08-01

imageReference

ImageReference

指定要使用的映像的相关信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但未在其他创建操作中使用,则此元素是必需的。

osDisk

VirtualMachineScaleSetOSDisk

指定有关规模集中虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD

VirtualMachineScaleSetVMProfile

介绍虚拟机规模集虚拟机配置文件。

名称 类型 说明
applicationProfile

ApplicationProfile

指定应提供给 VM/VMSS 的库应用程序

billingProfile

BillingProfile

指定 Azure 现成 VMSS 的计费相关详细信息。 最低 API 版本:2019-03-01。

capacityReservation

CapacityReservationProfile

指定规模集的容量预留相关详细信息。 最低 API 版本:2021-04-01。

diagnosticsProfile

DiagnosticsProfile

指定启动诊断设置状态。 最低 API 版本:2015-06-15。

evictionPolicy

VirtualMachineEvictionPolicyTypes

指定 Azure 现成虚拟机和 Azure 现成规模集的逐出策略。 对于 Azure 现成虚拟机,支持“Deallocate”和“Delete”,最低 API 版本为 2019-03-01。 对于 Azure 现成规模集,支持“Deallocate”和“Delete”,最低 API 版本为 2017-10-30-preview。

extensionProfile

VirtualMachineScaleSetExtensionProfile

指定规模集中虚拟机上安装的扩展的设置集合。

hardwareProfile

VirtualMachineScaleSetHardwareProfile

指定规模集的硬件配置文件相关详细信息。 最低 API 版本:2021-11-01。

licenseType

string

指定正在使用的映像或磁盘已在本地获得许可。

Windows Server 操作系统的可能值为:

Windows_Client

Windows_Server

Linux Server 操作系统的可能值为:

RHEL) 的RHEL_BYOS (

SUSE) SLES_BYOS (

有关详细信息,请参阅 适用于 Windows Server 的 Azure 混合使用权益

适用于 Linux Server 的 Azure 混合使用权益

最低 API 版本:2015-06-15

networkProfile

VirtualMachineScaleSetNetworkProfile

指定规模集中虚拟机网络接口的属性。

osProfile

VirtualMachineScaleSetOSProfile

指定规模集中虚拟机的操作系统设置。

priority

VirtualMachinePriorityTypes

指定规模集中虚拟机的优先级。 最低 API 版本:2017-10-30-preview。

scheduledEventsProfile

ScheduledEventsProfile

指定与计划事件相关的配置。

securityPostureReference

SecurityPostureReference

指定要在规模集中使用的安全状况。 最低 API 版本:2023-03-01

securityProfile

SecurityProfile

指定规模集中虚拟机的安全相关配置文件设置。

serviceArtifactReference

ServiceArtifactReference

指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 最低 API 版本:2022-11-01

storageProfile

VirtualMachineScaleSetStorageProfile

指定虚拟机磁盘的存储设置。

timeCreated

string

指定创建虚拟机规模集的此 VM 配置文件的时间。 此属性的最低 API 版本为 2024-03-01。 使用最低 API 版本 2024-03-01 创建/更新 VMSS VM 配置文件时,此值将添加到 VMSS Flex VM 标记。

userData

string

规模集中虚拟机的 UserData,必须采用 base-64 编码。 客户不应在此处传递任何机密。 最低 API 版本:2021-03-01。

VMDiskSecurityProfile

指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

指定用于客户托管密钥加密的机密 VM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。

securityEncryptionType

securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

VMGalleryApplication

指定引用计算库应用程序版本所需的信息

名称 类型 说明
configurationReference

string

可选,指定 Azure Blob 的 URI,该 URI 将替换包的默认配置(如果提供)

enableAutomaticUpgrade

boolean

如果设置为 true,则当 PIR/SIG 中提供了新的库应用程序版本时,它将针对 VM/VMSS 自动更新

order

integer

可选,指定包的安装顺序

packageReferenceId

string

指定 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} 格式的 GalleryApplicationVersion 资源 ID

tags

string

可选,指定用于更多泛型上下文的传递值。

treatFailureAsDeploymentFailure

boolean

可选,如果为 true,则 VmApplication 中任何操作的任何失败都将使部署失败

VMSizeProperties

指定虚拟机上的 VM 大小属性设置。

名称 类型 说明
vCPUsAvailable

integer

指定可用于 VM 的 vCPU 数。 如果未在请求正文中指定此属性,则默认行为是将其设置为可用于该 VM 大小的 vCPU 值,该值在 列出区域中所有可用的虚拟机大小的 API 响应中公开。

vCPUsPerCore

integer

指定 vCPU 与物理核心的比率。 如果未在请求正文中指定此属性,则对于 列出区域中所有可用虚拟机大小的 API 响应中公开的 VM 大小,默认行为设置为 vCPUsPerCore 的值。 将此属性设置为 1 还意味着禁用超线程。

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

名称 类型 说明
additionalUnattendContent

AdditionalUnattendContent[]

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 Base-64 编码 XML 格式信息。

enableAutomaticUpdates

boolean

指示是否为 Windows 虚拟机启用自动更新。 默认值为 true。 对于虚拟机规模集,可以更新此属性,更新将在 OS 重新预配时生效。

enableVMAgentPlatformUpdates

boolean

指示是否为 Windows 虚拟机启用了 VMAgent 平台更新。 默认值为 false。

patchSettings

PatchSettings

[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。

provisionVMAgent

boolean

指示是否应在虚拟机上设置虚拟机代理。 如果未在请求正文中指定此属性,则默认设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。

timeZone

string

指定虚拟机的时区。 例如“太平洋标准时间”。 可能的值可以是 TimeZoneInfo.GetSystemTimeZones 返回的时区 TimeZoneInfo.Id 值。

winRM

WinRMConfiguration

指定 Windows 远程管理侦听器。 这将启用远程 Windows PowerShell。

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

名称 类型 说明
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

指定在 Windows 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

名称 类型 说明
bypassPlatformSafetyChecksOnUserSchedule

boolean

使客户能够在不意外升级的情况下计划修补

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,业务流程模式为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,请在 VM 中手动应用修补程序。 在此模式下,自动更新被禁用;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

名称 类型 说明
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

介绍 VM 的 Windows 远程管理配置

名称 类型 说明
listeners

WinRMListener[]

Windows 远程管理侦听器的列表

WinRMListener

介绍 Windows 远程管理侦听器的协议和指纹

名称 类型 说明
certificateUrl

string

这是已作为机密上传到 Key Vault 的证书的 URL。 若要将机密添加到 Key Vault,请参阅 将密钥或机密添加到密钥保管库。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象以 UTF-8 编码:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虚拟机上安装证书,建议使用 适用于 Linux 的 Azure Key Vault 虚拟机扩展适用于 Windows 的 Azure Key Vault 虚拟机扩展

protocol

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。