通过

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

Virtual Machines - List All

  • 参考
服务:
Compute
API 版本:
2019-07-01

列出指定订阅中的所有虚拟机。 使用响应中的 nextLink 属性获取虚拟机的下一页。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2019-07-01
具有可选参数: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2019-07-01&statusOnly={statusOnly}

URI 参数

名称 在 必需 类型 说明
subscriptionId
 path True

string

唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version
 query True

string

客户端 API 版本。
statusOnly
 query

string

statusOnly=true 支持提取订阅中所有虚拟机的运行时状态。

响应

名称 类型 说明
200 OK

VirtualMachineListResult

还行

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

定义

名称 说明
AdditionalCapabilities

指定在虚拟机上启用或禁用的其他功能。
AdditionalUnattendContent

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

指定 Azure 现成虚拟机的计费相关详细信息。

最低 API 版本：2019-03-01。
BootDiagnostics

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

可以轻松查看控制台日志的输出。

通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
BootDiagnosticsInstanceView

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

可以轻松查看控制台日志的输出。

通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
CachingTypes

指定缓存要求。

可能的值包括：

无

ReadOnly

ReadWrite

默认值：标准存储 None。高级存储的 ReadOnly
ComponentNames

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

指定用于向虚拟机添加数据磁盘的参数。

有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。
DiagnosticsProfile

指定启动诊断设置状态。

最低 API 版本：2015-06-15。
DiffDiskOptions

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

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

指定应如何创建虚拟机。

可能的值包括：

附加 \u2013 使用专用磁盘创建虚拟机时，将使用此值。

FromImage \u2013 使用映像创建虚拟机时使用此值。 如果使用平台映像，则还使用上述 imageReference 元素。 如果使用市场映像，则还会使用前面所述的计划元素。
DiskEncryptionSetParameters

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

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15
DiskInstanceView

虚拟机磁盘信息。
HardwareProfile

指定虚拟机的硬件设置。
HyperVGenerationType

指定与资源关联的 HyperVGeneration 类型
ImageReference

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

实例视图状态。
KeyVaultKeyReference

指定 Key Vault 中密钥加密密钥的位置。
KeyVaultSecretReference

指定磁盘加密密钥的位置，该密钥是 Key Vault 机密。
LinuxConfiguration

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

有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux

有关运行非认可的分发版，请参阅 有关非认可分发的信息。
MaintenanceOperationResultCodeTypes

上次维护作结果代码。
MaintenanceRedeployStatus

虚拟机上的维护作状态。
ManagedDiskParameters

托管磁盘参数。
NetworkInterfaceReference

指定与虚拟机关联的网络接口的资源 ID 列表。
NetworkProfile

指定虚拟机的网络接口。
OperatingSystemTypes

作系统类型。
OSDisk

指定有关虚拟机使用的操作系统磁盘的信息。

有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。
OSProfile

指定创建虚拟机时使用的操作系统设置。 预配 VM 后，无法更改某些设置。
PassNames

传递名称。 目前，唯一允许的值是 OobeSystem。
Plan

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

指定 WinRM 侦听器的协议。

可能的值包括：
http

https
ResourceIdentityType

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

指定内容应用到的设置的名称。 可能的值包括：FirstLogonCommands 和 AutoLogon。
SshConfiguration

指定 Linux OS 的 ssh 密钥配置。
SshPublicKey

用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。
StatusLevelTypes

级别代码。
StorageAccountTypes

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

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

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

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

指定应安装在虚拟机上的证书集。
VirtualHardDisk

虚拟硬盘。
VirtualMachine

虚拟机列表。
VirtualMachineAgentInstanceView

在虚拟机上运行的 VM 代理。
VirtualMachineEvictionPolicyTypes

指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。

对于 Azure Spot 虚拟机，唯一支持的值是“解除分配”，最低 API 版本为 2019-03-01。

对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。
VirtualMachineExtension

虚拟机子扩展资源。
VirtualMachineExtensionHandlerInstanceView

虚拟机扩展处理程序实例视图。
VirtualMachineExtensionInstanceView

虚拟机扩展实例视图。
VirtualMachineIdentity

虚拟机的标识（如果已配置）。
VirtualMachineInstanceView

虚拟机实例视图。
VirtualMachineListResult

列出虚拟机作响应。
VirtualMachinePriorityTypes

指定虚拟机的优先级。

最低 API 版本：2019-03-01
VirtualMachineSizeTypes

指定虚拟机的大小。 有关虚拟机大小的详细信息，请参阅虚拟机大小。

可用的 VM 大小取决于区域和可用性集。 有关可用大小的列表，请使用以下 API：

列出可用性集中的所有可用虚拟机大小

列出区域中所有可用的虚拟机大小

列出用于调整大小 的所有可用虚拟机大小
WindowsConfiguration

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

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

Windows 远程管理侦听器列表

AdditionalCapabilities

Object

指定在虚拟机上启用或禁用的其他功能。

名称 类型 说明
ultraSSDEnabled

boolean

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

AdditionalUnattendContent

Object

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

名称 类型 说明
componentName

ComponentNames

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

string

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

PassNames

传递名称。 目前，唯一允许的值是 OobeSystem。
settingName

SettingNames

指定内容应用到的设置的名称。 可能的值包括：FirstLogonCommands 和 AutoLogon。

BillingProfile

Object

指定 Azure 现成虚拟机的计费相关详细信息。

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

名称 类型 说明
maxPrice

number (double)

指定愿意为 Azure 现成 VM/VMSS 付费的最高价格。 这个价格是美元。

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

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

可能的值包括：

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

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

可以将 maxPrice 设置为 -1，以指示出于价格原因不应逐出 Azure Spot VM/VMSS。 此外，如果默认的最大价格不是由你提供，则为 -1。

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

BootDiagnostics

Object

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

可以轻松查看控制台日志的输出。

通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。

名称 类型 说明
enabled

boolean

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

string

用于放置控制台输出和屏幕截图的存储帐户的 URI。

BootDiagnosticsInstanceView

Object

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

可以轻松查看控制台日志的输出。

通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。

名称 类型 说明
consoleScreenshotBlobUri

string

控制台屏幕截图 blob URI。
serialConsoleLogBlobUri

string

Linux 串行控制台日志 Blob Uri。
status

InstanceViewStatus

VM 的启动诊断状态信息。

注意：仅当启用启动诊断时遇到错误时，才会设置它。

CachingTypes

枚举

指定缓存要求。

可能的值包括：

无

ReadOnly

ReadWrite

默认值：标准存储 None。高级存储的 ReadOnly

值 说明
None
ReadOnly
ReadWrite

ComponentNames

枚举

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

值 说明
Microsoft-Windows-Shell-Setup

DataDisk

Object

指定用于向虚拟机添加数据磁盘的参数。

有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。

名称 类型 说明
caching

CachingTypes

指定缓存要求。

可能的值包括：

无

ReadOnly

ReadWrite

默认值：标准存储 None。高级存储的 ReadOnly
createOption

DiskCreateOptionTypes

指定应如何创建虚拟机。

可能的值包括：

附加 \u2013 使用专用磁盘创建虚拟机时，将使用此值。

FromImage \u2013 使用映像创建虚拟机时使用此值。 如果使用平台映像，则还使用上述 imageReference 元素。 如果使用市场映像，则还会使用前面所述的计划元素。
diskIOPSReadWrite

integer (int64)

指定存储AccountType UltraSSD_LRS时托管磁盘的 Read-Write IOPS。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。
diskMBpsReadWrite

integer (int64)

UltraSSD_LRS StorageAccountType 时，指定托管磁盘的带宽（以 MB/秒为单位）。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。
diskSizeGB

integer (int32)

指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘大小。

此值不能大于 1023 GB
image

VirtualHardDisk

源用户映像虚拟硬盘。 在附加到虚拟机之前，将复制虚拟硬盘。 如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
lun

integer (int32)

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

ManagedDiskParameters

托管磁盘参数。
name

string

磁盘名称。
toBeDetached

boolean

指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离
vhd

VirtualHardDisk

虚拟硬盘。
writeAcceleratorEnabled

boolean

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

DiagnosticsProfile

Object

指定启动诊断设置状态。

最低 API 版本：2015-06-15。

名称 类型 说明
bootDiagnostics

BootDiagnostics

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

可以轻松查看控制台日志的输出。

通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。

DiffDiskOptions

枚举

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

值 说明
Local

DiffDiskSettings

Object

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

名称 类型 说明
option

DiffDiskOptions

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

DiskCreateOptionTypes

枚举

指定应如何创建虚拟机。

可能的值包括：

附加 \u2013 使用专用磁盘创建虚拟机时，将使用此值。

FromImage \u2013 使用映像创建虚拟机时使用此值。 如果使用平台映像，则还使用上述 imageReference 元素。 如果使用市场映像，则还会使用前面所述的计划元素。

值 说明
Attach
Empty
FromImage

DiskEncryptionSetParameters

Object

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

名称 类型 说明
id

string

资源 ID

DiskEncryptionSettings

Object

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15

名称 类型 说明
diskEncryptionKey

KeyVaultSecretReference

指定磁盘加密密钥的位置，该密钥是 Key Vault 机密。
enabled

boolean

指定是否应在虚拟机上启用磁盘加密。
keyEncryptionKey

KeyVaultKeyReference

指定 Key Vault 中密钥加密密钥的位置。

DiskInstanceView

Object

虚拟机磁盘信息。

名称 类型 说明
encryptionSettings

DiskEncryptionSettings[]

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15
name

string

磁盘名称。
statuses

InstanceViewStatus[]

资源状态信息。

HardwareProfile

Object

指定虚拟机的硬件设置。

名称 类型 说明
vmSize

VirtualMachineSizeTypes

指定虚拟机的大小。 有关虚拟机大小的详细信息，请参阅虚拟机大小。

可用的 VM 大小取决于区域和可用性集。 有关可用大小的列表，请使用以下 API：

列出可用性集中的所有可用虚拟机大小

列出区域中所有可用的虚拟机大小

列出用于调整大小 的所有可用虚拟机大小

HyperVGenerationType

枚举

指定与资源关联的 HyperVGeneration 类型

值 说明
V1
V2

ImageReference

Object

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

名称 类型 说明
exactVersion

string

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

string

资源 ID
offer

string

指定用于创建虚拟机的平台映像或市场映像的产品/服务。
publisher

string

映像发布者。
sku

string

映像 SKU。
version

string

指定用于创建虚拟机的平台映像或市场映像的版本。 允许的格式为 Major.Minor.Build 或“latest”。 主要、次要和生成是十进制数。 指定“latest”以在部署时使用可用映像的最新版本。 即使使用“最新”，即使新版本可用，VM 映像也不会在部署后自动更新。

InstanceViewStatus

Object

实例视图状态。

名称 类型 说明
code

string

状态代码。
displayStatus

string

状态的简短可本地化标签。
level

StatusLevelTypes

级别代码。
message

string

详细状态消息，包括警报和错误消息。
time

string (date-time)

状态的时间。

KeyVaultKeyReference

Object

指定 Key Vault 中密钥加密密钥的位置。

名称 类型 说明
keyUrl

string

引用 Key Vault 中的密钥加密密钥的 URL。
sourceVault

SubResource

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

KeyVaultSecretReference

Object

指定磁盘加密密钥的位置，该密钥是 Key Vault 机密。

名称 类型 说明
secretUrl

string

引用 Key Vault 中的机密的 URL。
sourceVault

SubResource

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

LinuxConfiguration

Object

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

有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux

有关运行非认可的分发版，请参阅 有关非认可分发的信息。

名称 类型 说明
disablePasswordAuthentication

boolean

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

boolean

指示是否应在虚拟机上预配虚拟机代理。

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

SshConfiguration

指定 Linux OS 的 ssh 密钥配置。

MaintenanceOperationResultCodeTypes

枚举

上次维护作结果代码。

值 说明
MaintenanceAborted
MaintenanceCompleted
None
RetryLater

MaintenanceRedeployStatus

Object

虚拟机上的维护作状态。

名称 类型 说明
isCustomerInitiatedMaintenanceAllowed

boolean

如此，如果允许客户执行维护。
lastOperationMessage

string

为上次维护作返回的消息。
lastOperationResultCode

MaintenanceOperationResultCodeTypes

上次维护作结果代码。
maintenanceWindowEndTime

string (date-time)

维护时段的结束时间。
maintenanceWindowStartTime

string (date-time)

维护时段的开始时间。
preMaintenanceWindowEndTime

string (date-time)

预维护时段的结束时间。
preMaintenanceWindowStartTime

string (date-time)

预维护时段的开始时间。

ManagedDiskParameters

Object

托管磁盘参数。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

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

string

资源 ID
storageAccountType

StorageAccountTypes

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

NetworkInterfaceReference

Object

指定与虚拟机关联的网络接口的资源 ID 列表。

名称 类型 说明
id

string

资源 ID
properties.primary

boolean

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

NetworkProfile

Object

指定虚拟机的网络接口。

名称 类型 说明
networkInterfaces

NetworkInterfaceReference[]

指定与虚拟机关联的网络接口的资源 ID 列表。

OperatingSystemTypes

枚举

作系统类型。

值 说明
Linux
Windows

OSDisk

Object

指定有关虚拟机使用的操作系统磁盘的信息。

有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。

名称 类型 说明
caching

CachingTypes

指定缓存要求。

可能的值包括：

无

ReadOnly

ReadWrite

默认值：标准存储 None。高级存储的 ReadOnly
createOption

DiskCreateOptionTypes

指定应如何创建虚拟机。

可能的值包括：

附加 \u2013 使用专用磁盘创建虚拟机时，将使用此值。

FromImage \u2013 使用映像创建虚拟机时使用此值。 如果使用平台映像，则还使用上述 imageReference 元素。 如果使用市场映像，则还会使用前面所述的计划元素。
diffDiskSettings

DiffDiskSettings

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

integer (int32)

指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘大小。

此值不能大于 1023 GB
encryptionSettings

DiskEncryptionSettings

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15
image

VirtualHardDisk

源用户映像虚拟硬盘。 在附加到虚拟机之前，将复制虚拟硬盘。 如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
managedDisk

ManagedDiskParameters

托管磁盘参数。
name

string

磁盘名称。
osType

OperatingSystemTypes

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。

可能的值包括：

Windows

Linux
vhd

VirtualHardDisk

虚拟硬盘。
writeAcceleratorEnabled

boolean

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

OSProfile

Object

指定创建虚拟机时使用的操作系统设置。 预配 VM 后，无法更改某些设置。

名称 类型 说明
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

指定管理员帐户的名称。

创建 VM 后，无法更新此属性。

仅限 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”、“sql”、“support”、“support_388945a0”、“sys”、“test2”、“test3”、“user4”、“user5”。

最小长度（Linux）： 1 个字符

最大长度（Linux）： 64 个字符

最大长度（Windows）： 20 个字符

  • 有关 Linux VM 的根访问权限，请参阅 在 Azure 中的 Linux 虚拟机上使用根权限
  • 有关不应在此字段中使用的 Linux 上的内置系统用户的列表，请参阅 在 Azure 上为 Linux 选择用户名

    		•
    allowExtensionOperations

    boolean

    指定是否应在虚拟机上允许扩展操作。

    仅当虚拟机上没有扩展时，此选项才可能设置为 False。
    computerName

    string

    指定虚拟机的主机 OS 名称。

    创建 VM 后，无法更新此名称。

    最大长度（Windows）： 15 个字符

    最大长度（Linux）： 64 个字符。

    有关命名约定和限制，请参阅 Azure 基础结构服务实现指南。
    customData

    string

    指定自定义数据的 base-64 编码字符串。 base-64 编码字符串将解码为作为虚拟机上的文件保存的二进制数组。 二进制数组的最大长度为 65535 字节。

    注意：不要在 customData 属性中传递任何机密或密码

    创建 VM 后，无法更新此属性。

    customData 将传递给要另存为文件的 VM，有关详细信息，请参阅 Azure VM 上的自定义数据

    有关将 cloud-init 用于 Linux VM，请参阅 使用 cloud-init 在创建期间自定义 Linux VM
    linuxConfiguration

    LinuxConfiguration

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

    有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux

    有关运行非认可的分发版，请参阅 有关非认可分发的信息。
    requireGuestProvisionSignal

    boolean

    指定是否需要来宾预配信号来推断虚拟机的预配成功。
    secrets

    VaultSecretGroup[]

    指定应安装在虚拟机上的证书集。
    windowsConfiguration

    WindowsConfiguration

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

    PassNames

    枚举

    传递名称。 目前，唯一允许的值是 OobeSystem。

    值 说明
    OobeSystem

    Plan

    Object

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

    名称 类型 说明
    name

    string

    计划 ID。
    product

    string

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

    string

    促销代码。
    publisher

    string

    发布者 ID。

    ProtocolTypes

    枚举

    指定 WinRM 侦听器的协议。

    可能的值包括：
    http

    https

    值 说明
    Http
    Https

    ResourceIdentityType

    枚举

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

    值 说明
    None
    SystemAssigned
    SystemAssigned, UserAssigned
    UserAssigned

    SettingNames

    枚举

    指定内容应用到的设置的名称。 可能的值包括：FirstLogonCommands 和 AutoLogon。

    值 说明
    AutoLogon
    FirstLogonCommands

    SshConfiguration

    Object

    指定 Linux OS 的 ssh 密钥配置。

    名称 类型 说明
    publicKeys

    SshPublicKey[]

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

    SshPublicKey

    Object

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

    名称 类型 说明
    keyData

    string

    用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥必须至少为 2048 位且采用 ssh-rsa 格式。

    有关创建 ssh 密钥，请参阅 在 Azure中的 Linux 和 Mac 上为 Linux VM 创建 SSH 密钥。
    path

    string

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

    StatusLevelTypes

    枚举

    级别代码。

    值 说明
    Error
    Info
    Warning

    StorageAccountTypes

    枚举

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

    值 说明
    Premium_LRS
    StandardSSD_LRS
    Standard_LRS
    UltraSSD_LRS

    StorageProfile

    Object

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

    名称 类型 说明
    dataDisks

    DataDisk[]

    指定用于向虚拟机添加数据磁盘的参数。

    有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。
    imageReference

    ImageReference

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

    OSDisk

    指定有关虚拟机使用的操作系统磁盘的信息。

    有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。

    SubResource

    Object
    名称 类型 说明
    id

    string

    资源 ID

    UserAssignedIdentities

    Object

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

    名称 类型 说明

    VaultCertificate

    Object

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

    名称 类型 说明
    certificateStore

    string

    对于 Windows VM，指定应向其添加证书的虚拟机上的证书存储。 指定的证书存储隐式位于 LocalMachine 帐户中。

    对于 Linux VM，证书文件位于 /var/lib/waagent 目录下，文件名为 X509 证书文件 <大写Thumbprint>.crt，<用于私钥的 uppercaseThumbprint>.prv。 这两个文件都是 .pem 格式的。
    certificateUrl

    string

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

    {
    “data”：“，
    “dataType”：“pfx”，
    “password”：“”
    }

    VaultSecretGroup

    Object

    指定应安装在虚拟机上的证书集。

    名称 类型 说明
    sourceVault

    SubResource

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

    VaultCertificate[]

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

    VirtualHardDisk

    Object

    虚拟硬盘。

    名称 类型 说明
    uri

    string

    指定虚拟硬盘的 URI。

    VirtualMachine

    Object

    虚拟机列表。

    名称 类型 说明
    id

    string

    资源 ID
    identity

    VirtualMachineIdentity

    虚拟机的标识（如果已配置）。
    location

    string

    资源位置
    name

    string

    资源名称
    plan

    Plan

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

    AdditionalCapabilities

    指定在虚拟机上启用或禁用的其他功能。
    properties.availabilitySet

    SubResource

    指定应将虚拟机分配到的可用性集的相关信息。 在同一可用性集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 有关可用性集的详细信息，请参阅 管理虚拟机的可用性。

    有关 Azure 计划内维护的详细信息，请参阅 Azure 中虚拟机的计划内维护

    目前，只能在创建时将 VM 添加到可用性集。 要向其添加 VM 的可用性集应与可用性集资源位于同一资源组下。 无法将现有 VM 添加到可用性集。

    此属性不能与非 null properties.virtualMachineScaleSet 引用一起存在。
    properties.billingProfile

    BillingProfile

    指定 Azure 现成虚拟机的计费相关详细信息。

    最低 API 版本：2019-03-01。
    properties.diagnosticsProfile

    DiagnosticsProfile

    指定启动诊断设置状态。

    最低 API 版本：2015-06-15。
    properties.evictionPolicy

    VirtualMachineEvictionPolicyTypes

    指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。

    对于 Azure Spot 虚拟机，唯一支持的值是“解除分配”，最低 API 版本为 2019-03-01。

    对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。
    properties.hardwareProfile

    HardwareProfile

    指定虚拟机的硬件设置。
    properties.host

    SubResource

    指定虚拟机所在的专用主机的相关信息。

    最低 API 版本：2018-10-01。
    properties.instanceView

    VirtualMachineInstanceView

    虚拟机实例视图。
    properties.licenseType

    string

    指定正在使用的映像或磁盘在本地获得许可。 此元素仅用于包含 Windows Server 操作系统的映像。

    可能的值包括：

    Windows_Client

    Windows_Server

    如果此元素包含在更新请求中，则该值必须与初始值匹配。 此值无法更新。

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

    最低 API 版本：2015-06-15
    properties.networkProfile

    NetworkProfile

    指定虚拟机的网络接口。
    properties.osProfile

    OSProfile

    指定创建虚拟机时使用的操作系统设置。 预配 VM 后，无法更改某些设置。
    properties.priority

    VirtualMachinePriorityTypes

    指定虚拟机的优先级。

    最低 API 版本：2019-03-01
    properties.provisioningState

    string

    预配状态，仅出现在响应中。
    properties.proximityPlacementGroup

    SubResource

    指定应将虚拟机分配到的邻近放置组的相关信息。

    最低 api 版本：2018-04-01。
    properties.storageProfile

    StorageProfile

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

    SubResource

    指定应向其分配虚拟机规模集的信息。 在同一虚拟机规模集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 目前，只能在创建时将 VM 添加到虚拟机规模集。 无法将现有 VM 添加到虚拟机规模集。

    此属性不能与非 null properties.availabilitySet 引用一起存在。

    最低 api-version： 2019-03？01
    properties.vmId

    string

    指定 VM 唯一 ID，该 ID 是一个 128 位标识符，该标识符已编码并存储在所有 Azure IaaS VM SMBIOS 中，并且可以使用平台 BIOS 命令进行读取。
    resources

    VirtualMachineExtension[]

    虚拟机子扩展资源。
    tags

    object

    资源标记
    type

    string

    资源类型
    zones

    string[]

    虚拟机区域。

    VirtualMachineAgentInstanceView

    Object

    在虚拟机上运行的 VM 代理。

    名称 类型 说明
    extensionHandlers

    VirtualMachineExtensionHandlerInstanceView[]

    虚拟机扩展处理程序实例视图。
    statuses

    InstanceViewStatus[]

    资源状态信息。
    vmAgentVersion

    string

    VM 代理完整版本。

    VirtualMachineEvictionPolicyTypes

    枚举

    指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。

    对于 Azure Spot 虚拟机，唯一支持的值是“解除分配”，最低 API 版本为 2019-03-01。

    对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。

    值 说明
    Deallocate
    Delete

    VirtualMachineExtension

    Object

    虚拟机子扩展资源。

    名称 类型 说明
    id

    string

    资源 ID
    location

    string

    资源位置
    name

    string

    资源名称
    properties.autoUpgradeMinorVersion

    boolean

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

    string

    即使扩展配置未更改，扩展处理程序也应强制更新。
    properties.instanceView

    VirtualMachineExtensionInstanceView

    虚拟机扩展实例视图。
    properties.protectedSettings

    object

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

    string

    预配状态，仅出现在响应中。
    properties.publisher

    string

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

    object

    扩展的 Json 格式公共设置。
    properties.type

    string

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

    string

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

    object

    资源标记
    type

    string

    资源类型

    VirtualMachineExtensionHandlerInstanceView

    Object

    虚拟机扩展处理程序实例视图。

    名称 类型 说明
    status

    InstanceViewStatus

    扩展处理程序状态。
    type

    string

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

    string

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

    VirtualMachineExtensionInstanceView

    Object

    虚拟机扩展实例视图。

    名称 类型 说明
    name

    string

    虚拟机扩展名称。
    statuses

    InstanceViewStatus[]

    资源状态信息。
    substatuses

    InstanceViewStatus[]

    资源状态信息。
    type

    string

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

    string

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

    VirtualMachineIdentity

    Object

    虚拟机的标识（如果已配置）。

    名称 类型 说明
    principalId

    string

    虚拟机标识的主体 ID。 此属性仅针对系统分配的标识提供。
    tenantId

    string

    与虚拟机关联的租户 ID。 此属性仅针对系统分配的标识提供。
    type

    ResourceIdentityType

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

    UserAssignedIdentities

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

    VirtualMachineInstanceView

    Object

    虚拟机实例视图。

    名称 类型 说明
    bootDiagnostics

    BootDiagnosticsInstanceView

    启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。

    可以轻松查看控制台日志的输出。

    通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
    computerName

    string

    分配给虚拟机的计算机名称。
    disks

    DiskInstanceView[]

    虚拟机磁盘信息。
    extensions

    VirtualMachineExtensionInstanceView[]

    扩展信息。
    hyperVGeneration

    HyperVGenerationType

    指定与资源关联的 HyperVGeneration 类型
    maintenanceRedeployStatus

    MaintenanceRedeployStatus

    虚拟机上的维护作状态。
    osName

    string

    在虚拟机上运行的作系统。
    osVersion

    string

    在虚拟机上运行的作系统版本。
    platformFaultDomain

    integer (int32)

    指定虚拟机的容错域。
    platformUpdateDomain

    integer (int32)

    指定虚拟机的更新域。
    rdpThumbPrint

    string

    远程桌面证书指纹。
    statuses

    InstanceViewStatus[]

    资源状态信息。
    vmAgent

    VirtualMachineAgentInstanceView

    在虚拟机上运行的 VM 代理。

    VirtualMachineListResult

    Object

    列出虚拟机作响应。

    名称 类型 说明
    nextLink

    string

    用于提取下一页 VM 的 URI。 使用此 URI 调用 ListNext（），以提取虚拟机的下一页。
    value

    VirtualMachine[]

    虚拟机列表。

    VirtualMachinePriorityTypes

    枚举

    指定虚拟机的优先级。

    最低 API 版本：2019-03-01

    值 说明
    Low
    Regular
    Spot

    VirtualMachineSizeTypes

    枚举

    指定虚拟机的大小。 有关虚拟机大小的详细信息，请参阅虚拟机大小。

    可用的 VM 大小取决于区域和可用性集。 有关可用大小的列表，请使用以下 API：

    列出可用性集中的所有可用虚拟机大小

    列出区域中所有可用的虚拟机大小

    列出用于调整大小 的所有可用虚拟机大小

    值 说明
    Basic_A0
    Basic_A1
    Basic_A2
    Basic_A3
    Basic_A4
    Standard_A0
    Standard_A1
    Standard_A10
    Standard_A11
    Standard_A1_v2
    Standard_A2
    Standard_A2_v2
    Standard_A2m_v2
    Standard_A3
    Standard_A4
    Standard_A4_v2
    Standard_A4m_v2
    Standard_A5
    Standard_A6
    Standard_A7
    Standard_A8
    Standard_A8_v2
    Standard_A8m_v2
    Standard_A9
    Standard_B1ms
    Standard_B1s
    Standard_B2ms
    Standard_B2s
    Standard_B4ms
    Standard_B8ms
    Standard_D1
    Standard_D11
    Standard_D11_v2
    Standard_D12
    Standard_D12_v2
    Standard_D13
    Standard_D13_v2
    Standard_D14
    Standard_D14_v2
    Standard_D15_v2
    Standard_D16_v3
    Standard_D16s_v3
    Standard_D1_v2
    Standard_D2
    Standard_D2_v2
    Standard_D2_v3
    Standard_D2s_v3
    Standard_D3
    Standard_D32_v3
    Standard_D32s_v3
    Standard_D3_v2
    Standard_D4
    Standard_D4_v2
    Standard_D4_v3
    Standard_D4s_v3
    Standard_D5_v2
    Standard_D64_v3
    Standard_D64s_v3
    Standard_D8_v3
    Standard_D8s_v3
    Standard_DS1
    Standard_DS11
    Standard_DS11_v2
    Standard_DS12
    Standard_DS12_v2
    Standard_DS13
    Standard_DS13-2_v2
    Standard_DS13-4_v2
    Standard_DS13_v2
    Standard_DS14
    Standard_DS14-4_v2
    Standard_DS14-8_v2
    Standard_DS14_v2
    Standard_DS15_v2
    Standard_DS1_v2
    Standard_DS2
    Standard_DS2_v2
    Standard_DS3
    Standard_DS3_v2
    Standard_DS4
    Standard_DS4_v2
    Standard_DS5_v2
    Standard_E16_v3
    Standard_E16s_v3
    Standard_E2_v3
    Standard_E2s_v3
    Standard_E32-16_v3
    Standard_E32-8s_v3
    Standard_E32_v3
    Standard_E32s_v3
    Standard_E4_v3
    Standard_E4s_v3
    Standard_E64-16s_v3
    Standard_E64-32s_v3
    Standard_E64_v3
    Standard_E64s_v3
    Standard_E8_v3
    Standard_E8s_v3
    Standard_F1
    Standard_F16
    Standard_F16s
    Standard_F16s_v2
    Standard_F1s
    Standard_F2
    Standard_F2s
    Standard_F2s_v2
    Standard_F32s_v2
    Standard_F4
    Standard_F4s
    Standard_F4s_v2
    Standard_F64s_v2
    Standard_F72s_v2
    Standard_F8
    Standard_F8s
    Standard_F8s_v2
    Standard_G1
    Standard_G2
    Standard_G3
    Standard_G4
    Standard_G5
    Standard_GS1
    Standard_GS2
    Standard_GS3
    Standard_GS4
    Standard_GS4-4
    Standard_GS4-8
    Standard_GS5
    Standard_GS5-16
    Standard_GS5-8
    Standard_H16
    Standard_H16m
    Standard_H16mr
    Standard_H16r
    Standard_H8
    Standard_H8m
    Standard_L16s
    Standard_L32s
    Standard_L4s
    Standard_L8s
    Standard_M128-32ms
    Standard_M128-64ms
    Standard_M128ms
    Standard_M128s
    Standard_M64-16ms
    Standard_M64-32ms
    Standard_M64ms
    Standard_M64s
    Standard_NC12
    Standard_NC12s_v2
    Standard_NC12s_v3
    Standard_NC24
    Standard_NC24r
    Standard_NC24rs_v2
    Standard_NC24rs_v3
    Standard_NC24s_v2
    Standard_NC24s_v3
    Standard_NC6
    Standard_NC6s_v2
    Standard_NC6s_v3
    Standard_ND12s
    Standard_ND24rs
    Standard_ND24s
    Standard_ND6s
    Standard_NV12
    Standard_NV24
    Standard_NV6

    WindowsConfiguration

    Object

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

    名称 类型 说明
    additionalUnattendContent

    AdditionalUnattendContent[]

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

    boolean

    指示是否为 Windows 虚拟机启用自动更新。 默认值为 true。

    对于虚拟机规模集，可以更新此属性，更新将对 OS 重新预配生效。
    provisionVMAgent

    boolean

    指示是否应在虚拟机上预配虚拟机代理。

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

    string

    指定虚拟机的时区。 例如“太平洋标准时间”。

    可能的值可以从 TimeZoneInfo.GetSystemTimeZones返回的时区 TimeZoneInfo.Id 值。
    winRM

    WinRMConfiguration

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

    WinRMConfiguration

    Object

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

    名称 类型 说明
    listeners

    WinRMListener[]

    Windows 远程管理侦听器列表

    WinRMListener

    Object

    Windows 远程管理侦听器列表

    名称 类型 说明
    certificateUrl

    string

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

    {
    “data”：“，
    “dataType”：“pfx”，
    “password”：“”
    }
    protocol

    ProtocolTypes

    指定 WinRM 侦听器的协议。

    可能的值包括：
    http

    https