Virtual Machine Scale Set VMs - Update
更新 VM 规模集的虚拟机。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}?api-version=2025-04-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
instance
|
path | True |
string |
虚拟机的实例 ID。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
vm
|
path | True |
string |
VM 规模集的名称。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| If-Match |
string |
转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值,以防止意外覆盖并发更改。 |
|
| If-None-Match |
string |
设置为“*”以允许创建新记录集,但要防止更新现有记录集。 其他值将导致服务器出错,因为它们不受支持。 |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| location | True |
string |
资源所在的地理位置 |
| identity |
虚拟机的标识(如果已配置)。 |
||
| plan |
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击 想要以编程方式部署,开始使用 ->。 输入任何必需的信息,然后单击“保存 |
||
| properties.additionalCapabilities |
指定在规模集中的虚拟机上启用或禁用的其他功能。 例如:虚拟机是否能够支持使用UltraSSD_LRS存储帐户类型附加托管数据磁盘。 |
||
| properties.availabilitySet |
指定应将虚拟机分配到的可用性集的相关信息。 在同一可用性集中指定的虚拟机分配给不同的节点,以最大程度地提高可用性。 有关可用性集的详细信息,请参阅 可用性集概述。 有关 Azure 计划内维护的详细信息,请参阅 Azure中虚拟机的 |
||
| properties.diagnosticsProfile |
指定启动诊断设置状态。 最低 API 版本:2015-06-15。 |
||
| properties.hardwareProfile |
指定虚拟机的硬件设置。 |
||
| properties.licenseType |
string |
指定正在使用的映像或磁盘在本地获得许可。 |
|
| properties.networkProfile |
指定虚拟机的网络接口。 |
||
| properties.networkProfileConfiguration |
指定虚拟机的网络配置文件配置。 |
||
| properties.osProfile |
指定虚拟机的操作系统设置。 |
||
| properties.protectionPolicy |
指定虚拟机的保护策略。 |
||
| properties.resilientVMDeletionStatus |
指定虚拟机的弹性 VM 删除状态。 |
||
| properties.securityProfile |
指定虚拟机的安全相关配置文件设置。 |
||
| properties.storageProfile |
指定虚拟机磁盘的存储设置。 |
||
| properties.userData |
string |
VM 的 UserData(必须进行 base-64 编码)。 客户不应在此处传递任何机密。 最低 API 版本:2021-03-01 |
|
| tags |
object |
资源标记。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
资源“VirtualMachineScaleSetVM”更新作成功 |
|
| 202 Accepted |
已接受请求进行处理,但尚未完成处理。 标头
|
|
| Other Status Codes |
意外错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
|
Virtual |
|
Virtual |
VirtualMachineScaleSetVM_Update_MaximumSet_Gen
示例请求
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaa/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa?api-version=2025-04-01
{
"location": "westus",
"tags": {},
"properties": {
"networkProfileConfiguration": {
"networkInterfaceConfigurations": [
{
"name": "vmsstestnetconfig5415",
"properties": {
"primary": true,
"enableAcceleratedNetworking": true,
"dnsSettings": {
"dnsServers": []
},
"enableIPForwarding": true,
"ipConfigurations": [
{
"name": "vmsstestnetconfig9693",
"properties": {
"subnet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
},
"privateIPAddressVersion": "IPv4",
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 18,
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"deleteOption": "Delete"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerInboundNatPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"enableFpga": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"deleteOption": "Delete"
}
}
]
},
"hardwareProfile": {
"vmSize": "Basic_A0",
"vmSizeProperties": {
"vCPUsAvailable": 9,
"vCPUsPerCore": 12
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20180315",
"sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
"id": "a"
},
"osDisk": {
"osType": "Windows",
"name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"createOption": "FromImage",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"deleteOption": "Delete"
},
"dataDisks": [
{
"lun": 1,
"name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"createOption": "Empty",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 128,
"toBeDetached": true,
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"detachOption": "ForceDetach",
"deleteOption": "Delete"
}
]
},
"osProfile": {
"computerName": "test000000",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"requireGuestProvisionSignal": true,
"adminPassword": "aaaaaaaaaaaaaaaa",
"customData": "aaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaa",
"keyData": "aaaaaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
}
},
"userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2020-11-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaa"
]
},
"ipConfigurations": [
{
"name": "aa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 2,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"publicIPAllocationMethod": "Dynamic"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"dscpConfiguration": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
}
}
]
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaa"
}
},
"instanceView": {
"platformUpdateDomain": 23,
"platformFaultDomain": 14,
"rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"vmAgent": {
"vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
"extensionHandlers": [
{
"type": "aaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaa",
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
},
"maintenanceRedeployStatus": {
"isCustomerInitiatedMaintenanceAllowed": true,
"preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"lastOperationResultCode": "None",
"lastOperationMessage": "aaaaaa"
},
"disks": [
{
"name": "aaaaaaaaaaa",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"extensions": [
{
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"vmHealth": {
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"bootDiagnostics": {
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"placementGroupId": "aaa"
},
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaa",
"protectionPolicy": {
"protectFromScaleIn": true,
"protectFromScaleSetActions": true
}
},
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaa",
"capacity": 29
},
"plan": {
"name": "aaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaaaaaaaa"
}
}
示例响应
{
"name": "{vmss-vm-name}",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
"type": "Microsoft.Compute/virtualMachines",
"location": "westus",
"tags": {},
"properties": {
"latestModelApplied": true,
"modelDefinitionApplied": "VirtualMachineScaleSet",
"networkProfileConfiguration": {
"networkInterfaceConfigurations": [
{
"name": "vmsstestnetconfig5415",
"properties": {
"primary": true,
"enableAcceleratedNetworking": true,
"dnsSettings": {
"dnsServers": []
},
"enableIPForwarding": true,
"ipConfigurations": [
{
"name": "vmsstestnetconfig9693",
"properties": {
"subnet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
},
"privateIPAddressVersion": "IPv4",
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 18,
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"deleteOption": "Delete"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerInboundNatPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"enableFpga": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"deleteOption": "Delete"
}
}
]
},
"vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
"hardwareProfile": {
"vmSize": "Basic_A0",
"vmSizeProperties": {
"vCPUsAvailable": 9,
"vCPUsPerCore": 12
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20180315",
"exactVersion": "4.127.20180315",
"sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
"id": "a"
},
"osDisk": {
"osType": "Windows",
"name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"createOption": "FromImage",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"deleteOption": "Delete"
},
"dataDisks": [
{
"lun": 1,
"name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"createOption": "Empty",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 128,
"toBeDetached": true,
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diskIOPSReadWrite": 18,
"diskMBpsReadWrite": 29,
"detachOption": "ForceDetach",
"deleteOption": "Delete"
}
]
},
"osProfile": {
"computerName": "test000000",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"requireGuestProvisionSignal": true,
"customData": "aaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaa",
"keyData": "aaaaaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
}
},
"userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2020-11-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaa"
]
},
"ipConfigurations": [
{
"name": "aa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 2,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"publicIPAllocationMethod": "Dynamic"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"dscpConfiguration": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
}
}
]
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaa"
}
},
"provisioningState": "Succeeded",
"instanceView": {
"platformUpdateDomain": 23,
"platformFaultDomain": 14,
"rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"vmAgent": {
"vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
"extensionHandlers": [
{
"type": "aaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaa",
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
},
"maintenanceRedeployStatus": {
"isCustomerInitiatedMaintenanceAllowed": true,
"preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"lastOperationResultCode": "None",
"lastOperationMessage": "aaaaaa"
},
"disks": [
{
"name": "aaaaaaaaaaa",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"extensions": [
{
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"vmHealth": {
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"bootDiagnostics": {
"consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"serialConsoleLogBlobUri": "aaaaaaaa",
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"assignedHost": "aaaaaaa",
"placementGroupId": "aaa"
},
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaa",
"protectionPolicy": {
"protectFromScaleIn": true,
"protectFromScaleSetActions": true
}
},
"resources": [
{
"name": "CustomScriptExtension-DSC",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
"type": "Microsoft.Compute/virtualMachines/extensions",
"location": "westus",
"tags": {},
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Succeeded",
"publisher": "Microsoft.Compute",
"type": "CustomScriptExtension",
"typeHandlerVersion": "1.9",
"settings": {},
"forceUpdateTag": "aaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
},
"suppressFailures": true
}
}
],
"instanceId": "aaaaaaaaaaaa",
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaa",
"capacity": 29
},
"plan": {
"name": "aaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaaaaaaaa"
},
"zones": [
"a"
]
}
location: https://foo.com/operationstatus
{
"name": "{vmss-vm-name}",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
"type": "Microsoft.Compute/virtualMachines",
"location": "westus",
"tags": {},
"properties": {
"latestModelApplied": true,
"modelDefinitionApplied": "VirtualMachineScaleSet",
"networkProfileConfiguration": {
"networkInterfaceConfigurations": [
{
"name": "vmsstestnetconfig5415",
"properties": {
"primary": true,
"enableAcceleratedNetworking": true,
"dnsSettings": {
"dnsServers": []
},
"enableIPForwarding": true,
"ipConfigurations": [
{
"name": "vmsstestnetconfig9693",
"properties": {
"subnet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
},
"privateIPAddressVersion": "IPv4",
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 18,
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"deleteOption": "Delete"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerInboundNatPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"enableFpga": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"deleteOption": "Delete"
}
}
]
},
"vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
"hardwareProfile": {
"vmSize": "Basic_A0",
"vmSizeProperties": {
"vCPUsAvailable": 9,
"vCPUsPerCore": 12
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20180315",
"exactVersion": "4.127.20180315",
"sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
"id": "a"
},
"osDisk": {
"osType": "Windows",
"name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"createOption": "FromImage",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"deleteOption": "Delete"
},
"dataDisks": [
{
"lun": 1,
"name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"createOption": "Empty",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskSizeGB": 128,
"toBeDetached": true,
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diskIOPSReadWrite": 18,
"diskMBpsReadWrite": 29,
"detachOption": "ForceDetach",
"deleteOption": "Delete"
}
]
},
"osProfile": {
"computerName": "test000000",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"requireGuestProvisionSignal": true,
"customData": "aaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaa",
"keyData": "aaaaaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
}
},
"userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2020-11-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaa"
]
},
"ipConfigurations": [
{
"name": "aa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 2,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"publicIPAllocationMethod": "Dynamic"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"dscpConfiguration": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
}
}
]
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaa"
}
},
"provisioningState": "Succeeded",
"instanceView": {
"platformUpdateDomain": 23,
"platformFaultDomain": 14,
"rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"vmAgent": {
"vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
"extensionHandlers": [
{
"type": "aaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaa",
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
},
"maintenanceRedeployStatus": {
"isCustomerInitiatedMaintenanceAllowed": true,
"preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
"maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
"lastOperationResultCode": "None",
"lastOperationMessage": "aaaaaa"
},
"disks": [
{
"name": "aaaaaaaaaaa",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "aaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"extensions": [
{
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
],
"vmHealth": {
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"bootDiagnostics": {
"consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"serialConsoleLogBlobUri": "aaaaaaaa",
"status": {
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"assignedHost": "aaaaaaa",
"placementGroupId": "aaa"
},
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaa",
"protectionPolicy": {
"protectFromScaleIn": true,
"protectFromScaleSetActions": true
}
},
"resources": [
{
"name": "CustomScriptExtension-DSC",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
"type": "Microsoft.Compute/virtualMachines/extensions",
"location": "westus",
"tags": {},
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Succeeded",
"publisher": "Microsoft.Compute",
"type": "CustomScriptExtension",
"typeHandlerVersion": "1.9",
"settings": {},
"forceUpdateTag": "aaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
},
"suppressFailures": true
}
}
],
"instanceId": "aaaaaaaaaaaa",
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaa",
"capacity": 29
},
"plan": {
"name": "aaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaaaaaaaa"
},
"zones": [
"a"
]
}
VirtualMachineScaleSetVM_Update_MinimumSet_Gen
示例请求
示例响应
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"
}
location: https://foo.com/operationstatus
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"
}
定义
| 名称 | 说明 |
|---|---|
|
Additional |
启用或禁用虚拟机或虚拟机规模集上的功能。 |
|
Additional |
指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。 内容通过设置名称、组件名称和应用内容的传递来定义。 |
|
Api |
API 实体引用。 |
|
Api |
API 错误。 |
|
Api |
Api 错误库。 |
|
Boot |
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。 |
|
Boot |
虚拟机启动诊断的实例视图。 |
|
Caching |
指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 默认值为: 标准存储的无。高级存储的只读 |
|
Cloud |
来自计算服务的错误响应。 |
|
Component |
|
|
created |
创建资源的标识的类型。 |
|
Data |
描述数据磁盘。 |
|
Delete |
指定删除 VM 时网络接口发生的情况 |
|
Diagnostics |
指定启动诊断设置状态。 最低 API 版本:2015-06-15。 |
|
Diff |
指定作系统磁盘的临时磁盘选项。 |
|
Diff |
指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择位置,即缓存磁盘、资源磁盘或 nvme 磁盘空间,以进行临时 OS 磁盘配置。 有关临时 OS 磁盘大小要求的详细信息,请参阅 上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本:2024-03-01。 |
|
Diff |
描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意: 临时磁盘设置只能为托管磁盘指定。 |
|
Disk |
指定为 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。 |
|
Disk |
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。 FromImage: 使用映像创建虚拟机时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。 空: 创建空数据磁盘时使用此值。 复制: 此值用于从快照或其他磁盘创建数据磁盘。 还原: 此值用于从磁盘还原点创建数据磁盘。 |
|
Disk |
指定删除 VM 时托管磁盘的行为,例如,是删除托管磁盘还是分离托管磁盘。 支持的值为: 删除。 如果使用此值,则在删除 VM 时删除托管磁盘。 分离。 如果使用此值,则在删除 VM 后将保留托管磁盘。 最低 API 版本:2021-03-01。 |
|
Disk |
指定要在分离磁盘时使用的分离行为,或者已在从虚拟机分离过程中使用。 支持的值为: ForceDetach。 detachOption: ForceDetach 仅适用于托管数据磁盘。 如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试,并且磁盘仍未释放,则使用强制分离作为最后手段选项从 VM 强行分离磁盘。 使用此分离行为时,可能不会刷新所有写入。 此功能仍处于预览阶段。 若要强制分离数据磁盘更新到BeDetached 到“true”,以及设置 detachOption:“ForceDetach”。 |
|
Disk |
描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview。 |
|
Disk |
描述磁盘的加密设置 |
|
Disk |
磁盘的实例视图。 |
|
Domain |
域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签 |
|
Encryption |
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。 |
|
Hardware |
指定虚拟机的硬件设置。 |
|
Host |
指定特定的主机终结点设置。 |
|
Hyper |
虚拟机的虚拟机监控程序生成 [V1, V2] |
|
Image |
指定要使用的图像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但不在其他创建操作中使用,则需要此元素。 注意:只能在创建规模集时设置映像引用发布者和产品/服务。 |
|
Inner |
内部错误详细信息。 |
|
Instance |
实例视图状态。 |
| IPVersion |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
| IPVersions |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
|
Key |
描述对 Key Vault 密钥的引用 |
|
Key |
描述对 Key Vault 机密的引用 |
|
Linux |
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。 |
|
Linux |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 |
|
Linux |
指定与 Linux 上的 VM 来宾修补相关的设置。 |
|
Linux |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
|
Linux |
指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。 |
|
Linux |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
|
Maintenance |
上次维护作结果代码。 |
|
Maintenance |
维护作状态。 |
|
Managed |
托管磁盘的参数。 |
| Mode |
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。 |
| Modes |
指定执行模式。 在审核模式下,系统就像强制实施访问控制策略一样,包括在日志中发出访问拒绝条目,但它实际上不会拒绝对主机终结点的任何请求。 在“强制”模式下,系统将强制实施访问控制,这是建议的作模式。 |
|
Network |
指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本 |
|
Network |
指定是否为网络接口资源启用辅助模式。 |
|
Network |
指定是否为网络接口资源启用辅助 SKU。 |
|
Network |
描述网络接口引用。 |
|
Network |
指定虚拟机的网络接口或网络配置。 |
|
Operating |
此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括:Windows、Linux。 |
| OSDisk |
指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
| OSProfile |
指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。 |
|
Pass |
|
|
Patch |
指定与 Windows 上的 VM 来宾修补相关的设置。 |
| Plan |
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击 想要以编程方式部署,开始使用 ->。 输入任何必需的信息,然后单击“保存 |
|
Protocol |
指定 WinRM 侦听器的协议。 可能的值为:http、https。 |
|
Proxy |
指定虚拟机或虚拟机规模集的 ProxyAgent 设置。 最低 API 版本:2023-09-01。 |
|
Public |
描述公共 IP Sku。 只能将 OrchestrationMode 设置为灵活。 |
|
Public |
指定公共 IP SKU 名称 |
|
Public |
指定公共 IP SKU 层 |
|
Public |
指定公共 IP 分配类型 |
|
Resilient |
指定虚拟机的弹性 VM 删除状态。 |
|
Resource |
用于虚拟机规模集的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。 |
|
Security |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。 |
|
Security |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
|
Security |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。 |
|
Setting |
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。 |
| Sku |
描述虚拟机规模集 SKU。 注意:如果规模集当前在硬件上不支持新的 VM SKU,则需要在修改 SKU 名称之前解除分配规模集中的 VM。 |
|
Ssh |
Azure 上运行的基于 Linux 的 VM 的 SSH 配置 |
|
Ssh |
包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。 |
|
Status |
级别代码。 |
|
Storage |
指定托管磁盘的存储帐户类型。 只能在创建规模集时设置托管 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 |
|
Storage |
指定虚拟机磁盘的存储设置。 |
|
Sub |
|
|
system |
与创建和上次修改资源相关的元数据。 |
|
Uefi |
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 api 版本:2020-12-01。 |
|
User |
|
|
Vault |
介绍 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。 |
|
Vault |
描述一组证书,这些证书都位于同一 Key Vault 中。 |
|
Virtual |
描述磁盘的 URI。 |
|
Virtual |
虚拟机上运行的虚拟机代理的实例视图。 |
|
Virtual |
描述虚拟机扩展。 |
|
Virtual |
虚拟机扩展处理程序的实例视图。 |
|
Virtual |
虚拟机扩展的实例视图。 |
|
Virtual |
VM 的运行状况。 |
|
Virtual |
虚拟机的标识。 |
|
Virtual |
包含与公共 IP 地址关联的 IP 标记。 |
|
Virtual |
描述虚拟机网络接口配置。 |
|
Virtual |
描述虚拟机网络配置的 DNS 设置。 |
|
Virtual |
描述虚拟机网络配置文件的 IP 配置。 |
|
Virtual |
介绍虚拟机 IP 配置的公共 IPAddress 配置 |
|
Virtual |
描述虚拟机网络配置的 DNS 设置。 |
|
Virtual |
介绍虚拟机规模集网络配置文件的 IP 配置。 |
|
Virtual |
包含与公共 IP 地址关联的 IP 标记。 |
|
Virtual |
介绍虚拟机规模集网络配置文件的网络配置。 |
|
Virtual |
描述虚拟机规模集网络配置的 DNS 设置。 |
|
Virtual |
介绍虚拟机规模集 IP 配置的公共 IPAddress 配置 |
|
Virtual |
描述虚拟机规模集网络配置的 DNS 设置。 |
|
Virtual |
描述虚拟机规模集虚拟机。 |
|
Virtual |
虚拟机规模集 VM 的实例视图。 |
|
Virtual |
描述虚拟机规模集 VM 网络配置文件。 |
|
Virtual |
虚拟机规模集 VM 的保护策略。 |
|
Virtual |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 |
|
VMDisk |
指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。 |
|
VMSize |
指定虚拟机上的 VM 大小属性设置。 |
|
Windows |
指定虚拟机上的 Windows 操作系统设置。 |
|
Windows |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 |
|
Windows |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
|
Windows |
指定在 Windows 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。 |
|
Windows |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
|
Win |
介绍 VM 的 Windows 远程管理配置 |
|
Win |
介绍 Windows 远程管理侦听器的协议和指纹 |
AdditionalCapabilities
启用或禁用虚拟机或虚拟机规模集上的功能。
| 名称 | 类型 | 说明 |
|---|---|---|
| enableFips1403Encryption |
boolean |
该标志允许在扩展的 protectedSettings 上使用符合 FIPS 140-3 的加密技术。 有关详细信息,请访问:https://aka.ms/linuxagentfipssupport。 |
| hibernationEnabled |
boolean |
在 VM 上启用或禁用休眠功能的标志。 |
| ultraSSDEnabled |
boolean |
启用或禁用在 VM 或 VMSS 上具有一个或多个具有UltraSSD_LRS存储帐户类型的托管数据磁盘的功能的标志。 仅当此属性已启用时,才能将存储帐户类型UltraSSD_LRS的托管磁盘添加到虚拟机或虚拟机规模集。 |
AdditionalUnattendContent
指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。 内容通过设置名称、组件名称和应用内容的传递来定义。
| 名称 | 类型 | 说明 |
|---|---|---|
| componentName |
组件名称。 目前,唯一允许的值是Microsoft-Windows-Shell-Setup。 |
|
| content |
string |
指定为指定路径和组件添加到unattend.xml文件的 XML 格式化内容。 XML 必须小于 4KB,并且必须包含要插入的设置或功能的根元素。 |
| passName |
传递名称。 目前,唯一允许的值是 OobeSystem。 |
|
| settingName |
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。 |
ApiEntityReference
API 实体引用。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 形式的 ARM 资源 ID |
ApiError
API 错误。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误代码。 |
| details |
Api 错误详细信息 |
|
| innererror |
Api 内部错误 |
|
| message |
string |
错误消息。 |
| target |
string |
特定错误的目标。 |
ApiErrorBase
Api 错误库。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误代码。 |
| message |
string |
错误消息。 |
| target |
string |
特定错误的目标。 |
BootDiagnostics
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。
| 名称 | 类型 | 说明 |
|---|---|---|
| enabled |
boolean |
是否应在虚拟机上启用启动诊断。 |
| storageUri |
string |
用于放置控制台输出和屏幕截图的存储帐户的 URI。 如果在启用启动诊断时未指定 storageUri,则会使用托管存储。 |
BootDiagnosticsInstanceView
虚拟机启动诊断的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| consoleScreenshotBlobUri |
string |
控制台屏幕截图 blob URI。 注意: 如果当前使用托管存储启用了启动诊断,则 不会 设置此设置。 |
| serialConsoleLogBlobUri |
string |
串行控制台日志 blob Uri。 注意: 如果当前使用托管存储启用了启动诊断,则 不会 设置此设置。 |
| status |
VM 的启动诊断状态信息。 注意: 仅当在启用启动诊断时遇到错误时,才会设置它。 |
CachingTypes
指定缓存要求。 可能的值为: None、ReadOnly、ReadWrite。 默认值为: 标准存储的无。高级存储的只读
| 值 | 说明 |
|---|---|
| None | |
| ReadOnly | |
| ReadWrite |
CloudError
来自计算服务的错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
API 错误。 |
ComponentNames
| 值 | 说明 |
|---|---|
| Microsoft-Windows-Shell-Setup |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataDisk
描述数据磁盘。
| 名称 | 类型 | 说明 |
|---|---|---|
| caching |
指定缓存要求。 可能的值为:None、ReadOnly、ReadWrite。 默认行为为:标准存储 None。高级存储的 ReadOnly。 |
|
| createOption |
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。 FromImage: 使用映像创建虚拟机数据磁盘时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。 空: 创建空数据磁盘时使用此值。 复制: 此值用于从快照或其他磁盘创建数据磁盘。 还原: 此值用于从磁盘还原点创建数据磁盘。 |
|
| deleteOption |
指定在删除 VM 时是否应删除或分离数据磁盘。 可能的值为:Delete。 如果使用此值,则会在删除 VM 时删除数据磁盘。 分离。 如果使用此值,则在删除 VM 后保留数据磁盘。 默认值设置为 Detach。 |
|
| detachOption |
指定要在分离磁盘时使用的分离行为,或者已在从虚拟机分离过程中使用。 支持的值:ForceDetach。 detachOption:ForceDetach 仅适用于托管数据磁盘。 如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试,并且磁盘仍未释放,则使用强制分离作为最后手段选项从 VM 强行分离磁盘。 使用此分离行为时,可能不会刷新所有写入。 此功能仍处于预览阶段。 若要强制分离数据磁盘更新到BeDetached 到“true”,以及设置 detachOption:“ForceDetach”。 |
|
| diskIOPSReadWrite |
integer (int64) |
指定 StorageAccountType UltraSSD_LRS时托管磁盘的 Read-Write IOPS。 |
| diskMBpsReadWrite |
integer (int64) |
指定 StorageAccountType 为UltraSSD_LRS时托管磁盘的带宽(以 MB/秒为单位)。 |
| diskSizeGB |
integer (int32) |
指定空数据磁盘的大小(以 GB 为单位)。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性“diskSizeGB”是磁盘的字节数 x 1024^3,该值不能大于 1023。 |
| image |
源用户映像虚拟硬盘。 在附加到虚拟机之前,将复制虚拟硬盘。 如果提供了 SourceImage,则目标虚拟硬盘驱动器不得存在。 |
|
| lun |
integer (int32) |
指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘,因此对于附加到 VM 的每个数据磁盘必须是唯一的。 |
| managedDisk |
托管磁盘参数。 |
|
| name |
string |
磁盘名称。 |
| sourceResource |
源资源标识符。 它可以是用于创建磁盘的快照或磁盘还原点。 |
|
| toBeDetached |
boolean |
指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离 |
| vhd |
虚拟硬盘。 |
|
| writeAcceleratorEnabled |
boolean |
指定是应在磁盘上启用或禁用 writeAccelerator。 |
DeleteOptions
指定删除 VM 时网络接口发生的情况
| 值 | 说明 |
|---|---|
| Delete | |
| Detach |
DiagnosticsProfile
指定启动诊断设置状态。 最低 API 版本:2015-06-15。
| 名称 | 类型 | 说明 |
|---|---|---|
| bootDiagnostics |
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 注意:如果指定 storageUri,请确保存储帐户与 VM 位于同一区域和订阅中。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。 |
DiffDiskOptions
指定作系统磁盘的临时磁盘选项。
| 值 | 说明 |
|---|---|
| Local |
DiffDiskPlacement
指定操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择位置,即缓存磁盘、资源磁盘或 nvme 磁盘空间,以进行临时 OS 磁盘配置。 有关临时 OS 磁盘大小要求的详细信息,请参阅 上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本:2024-03-01。
| 值 | 说明 |
|---|---|
| CacheDisk | |
| ResourceDisk | |
| NvmeDisk |
DiffDiskSettings
描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意: 临时磁盘设置只能为托管磁盘指定。
| 名称 | 类型 | 说明 |
|---|---|---|
| option |
指定操作系统磁盘的临时磁盘设置。 |
|
| placement |
指定操作系统磁盘的临时磁盘放置。 可能的值为:CacheDisk、ResourceDisk、NvmeDisk。 默认行为为:如果为 VM 大小配置了一个,则 CacheDisk;否则,ResourceDisk 或使用 NvmeDisk。 请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/sizeshttps://docs.microsoft.com/azure/virtual-machines/linux/sizes 上的 Windows VM 和 Linux VM 的 VM 大小文档,以检查哪些 VM 大小公开了缓存磁盘。 NvmeDisk 的最低 API 版本:2024-03-01。 |
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 | |
| NVMe |
DiskCreateOptionTypes
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。 FromImage: 使用映像创建虚拟机时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。 空: 创建空数据磁盘时使用此值。 复制: 此值用于从快照或其他磁盘创建数据磁盘。 还原: 此值用于从磁盘还原点创建数据磁盘。
| 值 | 说明 |
|---|---|
| FromImage | |
| Empty | |
| Attach | |
| Copy | |
| Restore |
DiskDeleteOptionTypes
指定删除 VM 时托管磁盘的行为,例如,是删除托管磁盘还是分离托管磁盘。 支持的值为: 删除。 如果使用此值,则在删除 VM 时删除托管磁盘。 分离。 如果使用此值,则在删除 VM 后将保留托管磁盘。 最低 API 版本:2021-03-01。
| 值 | 说明 |
|---|---|
| Delete | |
| Detach |
DiskDetachOptionTypes
指定要在分离磁盘时使用的分离行为,或者已在从虚拟机分离过程中使用。 支持的值为: ForceDetach。 detachOption: ForceDetach 仅适用于托管数据磁盘。 如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试,并且磁盘仍未释放,则使用强制分离作为最后手段选项从 VM 强行分离磁盘。 使用此分离行为时,可能不会刷新所有写入。 此功能仍处于预览阶段。 若要强制分离数据磁盘更新到BeDetached 到“true”,以及设置 detachOption:“ForceDetach”。
| 值 | 说明 |
|---|---|
| ForceDetach |
DiskEncryptionSetParameters
描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID |
DiskEncryptionSettings
描述磁盘的加密设置
| 名称 | 类型 | 说明 |
|---|---|---|
| diskEncryptionKey |
指定磁盘加密密钥的位置,该密钥是 Key Vault 机密。 |
|
| enabled |
boolean |
指定是否应在虚拟机上启用磁盘加密。 |
| keyEncryptionKey |
指定 Key Vault 中密钥加密密钥的位置。 |
DiskInstanceView
磁盘的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| encryptionSettings |
指定 OS 磁盘的加密设置。 |
|
| name |
string |
磁盘名称。 |
| statuses |
资源状态信息。 |
DomainNameLabelScopeTypes
域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签
| 值 | 说明 |
|---|---|
| TenantReuse | |
| SubscriptionReuse | |
| ResourceGroupReuse | |
| NoReuse |
EncryptionIdentity
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| userAssignedIdentityResourceId |
string |
指定与 VM 关联的用户标识之一的 ARM 资源 ID。 |
HardwareProfile
指定虚拟机的硬件设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| vmSize |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 |
|
| vmSizeProperties |
指定用于自定义虚拟机大小的属性。 最低 API 版本:2021-07-01。 此功能仍处于预览模式,VirtualMachineScaleSet 不支持此功能。 有关详细信息,请按照 VM 自定义 中的说明进行操作。 |
HostEndpointSettings
指定特定的主机终结点设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| inVMAccessControlProfileReferenceId |
string |
以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} 格式指定 InVMAccessControlProfileVersion 资源 ID |
| mode |
指定执行模式。 在审核模式下,系统就像强制实施访问控制策略一样,包括在日志中发出访问拒绝条目,但它实际上不会拒绝对主机终结点的任何请求。 在“强制”模式下,系统将强制实施访问控制,这是建议的作模式。 |
HyperVGeneration
虚拟机的虚拟机监控程序生成 [V1, V2]
| 值 | 说明 |
|---|---|
| V1 | |
| V2 |
ImageReference
指定要使用的图像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但不在其他创建操作中使用,则需要此元素。 注意:只能在创建规模集时设置映像引用发布者和产品/服务。
| 名称 | 类型 | 说明 |
|---|---|---|
| communityGalleryImageId |
string |
为 vm 部署指定社区库映像唯一 ID。 这可以从社区库映像 GET 调用中提取。 |
| exactVersion |
string |
以十进制数指定用于创建虚拟机的平台映像或市场映像的版本。 此只读字段与“version”不同,仅当“version”字段中指定的值为“latest”时。 |
| 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”字段进行部署,若要使用库映像的“latest”版本,只需在“id”字段中设置“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}”,而不输入版本。 |
InnerError
内部错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errordetail |
string |
内部错误消息或异常转储。 |
| exceptiontype |
string |
异常类型。 |
InstanceViewStatus
实例视图状态。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
状态代码。 |
| displayStatus |
string |
状态的简短可本地化标签。 |
| level |
级别代码。 |
|
| message |
string |
详细状态消息,包括警报和错误消息。 |
| time |
string (date-time) |
状态的时间。 |
IPVersion
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。
| 值 | 说明 |
|---|---|
| IPv4 | |
| IPv6 |
IPVersions
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。
| 值 | 说明 |
|---|---|
| IPv4 | |
| IPv6 |
KeyVaultKeyReference
描述对 Key Vault 密钥的引用
| 名称 | 类型 | 说明 |
|---|---|---|
| keyUrl |
string |
引用 Key Vault 中的密钥加密密钥的 URL。 |
| sourceVault |
包含密钥的 Key Vault 的相对 URL。 |
KeyVaultSecretReference
描述对 Key Vault 机密的引用
| 名称 | 类型 | 说明 |
|---|---|---|
| secretUrl |
string |
引用 Key Vault 中的机密的 URL。 |
| sourceVault |
包含机密的 Key Vault 的相对 URL。 |
LinuxConfiguration
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。
| 名称 | 类型 | 说明 |
|---|---|---|
| disablePasswordAuthentication |
boolean |
指定是否应禁用密码身份验证。 |
| enableVMAgentPlatformUpdates |
boolean |
指示是否为 Linux 虚拟机启用了 VMAgent 平台更新。 默认值为 false。 |
| patchSettings |
[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。 |
|
| provisionVMAgent |
boolean |
指示是否应在虚拟机上预配虚拟机代理。 如果未在请求正文中指定此属性,则默认行为是将其设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。 |
| ssh |
指定 Linux OS 的 ssh 密钥配置。 |
LinuxPatchAssessmentMode
指定 IaaS 虚拟机的 VM 来宾修补评估模式。
可能的值为:
ImageDefault - 控制虚拟机上的修补程序评估的时间。
AutomaticByPlatform - 平台将触发定期修补评估。 属性 provisionVMAgent 必须为 true。
| 值 | 说明 |
|---|---|
| ImageDefault | |
| AutomaticByPlatform |
LinuxPatchSettings
指定与 Linux 上的 VM 来宾修补相关的设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| assessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 |
|
| automaticByPlatformSettings |
指定 Linux 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。 |
|
| patchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
| 值 | 说明 |
|---|---|
| Unknown | |
| IfRequired | |
| Never | |
| Always |
LinuxVMGuestPatchAutomaticByPlatformSettings
指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
使客户能够在不意外升级的情况下计划修补 |
| rebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
LinuxVMGuestPatchMode
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。
可能的值为:
ImageDefault - 使用虚拟机的默认修补配置。
AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true
| 值 | 说明 |
|---|---|
| ImageDefault | |
| AutomaticByPlatform |
MaintenanceOperationResultCodeTypes
上次维护作结果代码。
| 值 | 说明 |
|---|---|
| None | |
| RetryLater | |
| MaintenanceAborted | |
| MaintenanceCompleted |
MaintenanceRedeployStatus
维护作状态。
| 名称 | 类型 | 说明 |
|---|---|---|
| isCustomerInitiatedMaintenanceAllowed |
boolean |
True,如果允许客户执行维护。 |
| lastOperationMessage |
string |
为上次维护作返回的消息。 |
| lastOperationResultCode |
上次维护作结果代码。 |
|
| maintenanceWindowEndTime |
string (date-time) |
维护时段的结束时间。 |
| maintenanceWindowStartTime |
string (date-time) |
维护时段的开始时间。 |
| preMaintenanceWindowEndTime |
string (date-time) |
维护前时段的结束时间。 |
| preMaintenanceWindowStartTime |
string (date-time) |
预维护时段的开始时间。 |
ManagedDiskParameters
托管磁盘的参数。
| 名称 | 类型 | 说明 |
|---|---|---|
| diskEncryptionSet |
指定托管磁盘的客户托管磁盘加密集资源 ID。 |
|
| id |
string |
资源 ID |
| securityProfile |
指定托管磁盘的安全配置文件。 |
|
| storageAccountType |
指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。 |
Mode
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。
| 值 | 说明 |
|---|---|
| Audit | |
| Enforce |
Modes
指定执行模式。 在审核模式下,系统就像强制实施访问控制策略一样,包括在日志中发出访问拒绝条目,但它实际上不会拒绝对主机终结点的任何请求。 在“强制”模式下,系统将强制实施访问控制,这是建议的作模式。
| 值 | 说明 |
|---|---|
| Audit | |
| Enforce | |
| Disabled |
NetworkApiVersion
指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本
| 值 | 说明 |
|---|---|
| 2020-11-01 | |
| 2022-11-01 |
NetworkInterfaceAuxiliaryMode
指定是否为网络接口资源启用辅助模式。
| 值 | 说明 |
|---|---|
| None | |
| AcceleratedConnections | |
| Floating |
NetworkInterfaceAuxiliarySku
指定是否为网络接口资源启用辅助 SKU。
| 值 | 说明 |
|---|---|
| None | |
| A1 | |
| A2 | |
| A4 | |
| A8 |
NetworkInterfaceReference
描述网络接口引用。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID |
| properties.deleteOption |
指定删除 VM 时网络接口发生的情况 |
|
| properties.primary |
boolean |
指定主网络接口,以防虚拟机具有 1 个以上的网络接口。 |
NetworkProfile
指定虚拟机的网络接口或网络配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| networkApiVersion |
指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本 |
|
| networkInterfaceConfigurations |
指定将用于创建虚拟机网络资源的网络配置。 |
|
| networkInterfaces |
指定与虚拟机关联的网络接口的资源 ID 列表。 |
OperatingSystemTypes
此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括:Windows、Linux。
| 值 | 说明 |
|---|---|
| Windows | |
| Linux |
OSDisk
指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD。
| 名称 | 类型 | 说明 |
|---|---|---|
| caching |
指定缓存要求。 可能的值为:None、ReadOnly、ReadWrite。 默认行为为:标准存储 None。高级存储的 ReadOnly。 |
|
| createOption |
指定应如何创建虚拟机磁盘。 可能的值是 附加: 使用专用磁盘创建虚拟机时,将使用此值。 FromImage: 使用映像创建虚拟机时使用此值。 如果使用平台映像,还应使用上述 imageReference 元素。 如果使用市场映像,还应使用前面所述的计划元素。 |
|
| deleteOption |
指定在删除 VM 时是否应删除或分离 OS 磁盘。 可能的值为:Delete。 如果使用此值,则删除 VM 时会删除 OS 磁盘。 分离。 如果使用此值,则会在删除 VM 后保留 os 磁盘。 默认值设置为 Detach。 对于临时 OS 磁盘,默认值设置为 删除。 用户无法更改临时 OS 磁盘的删除选项。 |
|
| diffDiskSettings |
指定虚拟机使用的操作系统磁盘的临时磁盘设置。 |
|
| diskSizeGB |
integer (int32) |
指定空数据磁盘的大小(以 GB 为单位)。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性“diskSizeGB”是磁盘的字节数 x 1024^3,该值不能大于 1023。 |
| encryptionSettings |
指定 OS 磁盘的加密设置。 最低 API 版本:2015-06-15。 |
|
| image |
源用户映像虚拟硬盘。 在附加到虚拟机之前,将复制虚拟硬盘。 如果提供了 SourceImage,则目标虚拟硬盘驱动器不得存在。 |
|
| managedDisk |
托管磁盘参数。 |
|
| name |
string |
磁盘名称。 |
| osType |
此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。 可能的值包括:Windows、Linux。 |
|
| vhd |
虚拟硬盘。 |
|
| writeAcceleratorEnabled |
boolean |
指定是应在磁盘上启用或禁用 writeAccelerator。 |
OSProfile
指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| adminPassword |
string (password) |
指定管理员帐户的密码。 |
| adminUsername |
string |
指定管理员帐户的名称。 |
| 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 |
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。 |
|
| requireGuestProvisionSignal |
boolean |
必须设置为 True 或省略的可选属性。 |
| secrets |
指定应安装在虚拟机上的证书集。 若要在虚拟机上安装证书,建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows 的Azure Key Vault 虚拟机扩展。 |
|
| windowsConfiguration |
指定虚拟机上的 Windows 操作系统设置。 |
PassNames
| 值 | 说明 |
|---|---|
| OobeSystem |
PatchSettings
指定与 Windows 上的 VM 来宾修补相关的设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| assessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 |
|
| automaticByPlatformSettings |
指定 Windows 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。 |
|
| enableHotpatching |
boolean |
使客户无需重新启动即可修补其 Azure VM。 对于 enableHotpatching,必须将“provisionVMAgent”设置为 true,并且“patchMode”必须设置为“AutomaticByPlatform”。 |
| patchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
Plan
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击 想要以编程方式部署,开始使用 ->。 输入任何必需的信息,然后单击“保存
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
计划 ID。 |
| product |
string |
指定来自市场的映像的产品。 此值与 imageReference 元素下的 Offer 相同。 |
| promotionCode |
string |
促销代码。 |
| publisher |
string |
发布者 ID。 |
ProtocolTypes
指定 WinRM 侦听器的协议。 可能的值为:http、https。
| 值 | 说明 |
|---|---|
| Http | |
| Https |
ProxyAgentSettings
指定虚拟机或虚拟机规模集的 ProxyAgent 设置。 最低 API 版本:2023-09-01。
| 名称 | 类型 | 说明 |
|---|---|---|
| addProxyAgentExtension |
boolean |
指定是否隐式安装 ProxyAgent 扩展。 此选项目前仅适用于 Linux作系统。 |
| enabled |
boolean |
指定是否应在虚拟机或虚拟机规模集上启用 ProxyAgent 功能。 |
| imds |
在创建虚拟机或虚拟机规模集时指定 IMDS 终结点设置。 最低 api 版本:2024-03-01。 |
|
| keyIncarnationId |
integer (int32) |
增加此属性的值允许用户重置用于保护来宾和主机之间的通信通道的密钥。 |
| mode |
指定 ProxyAgent 将执行的模式。 警告:此属性已弃用,请在特定的 hostendpoint 设置下指定“mode”。 |
|
| wireServer |
在创建虚拟机或虚拟机规模集时指定 Wire Server 终结点设置。 最低 api 版本:2024-03-01。 |
PublicIPAddressSku
描述公共 IP Sku。 只能将 OrchestrationMode 设置为灵活。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
指定公共 IP SKU 名称 |
|
| tier |
指定公共 IP SKU 层 |
PublicIPAddressSkuName
指定公共 IP SKU 名称
| 值 | 说明 |
|---|---|
| Basic | |
| Standard |
PublicIPAddressSkuTier
指定公共 IP SKU 层
| 值 | 说明 |
|---|---|
| Regional | |
| Global |
PublicIPAllocationMethod
指定公共 IP 分配类型
| 值 | 说明 |
|---|---|
| Dynamic | |
| Static |
ResilientVMDeletionStatus
指定虚拟机的弹性 VM 删除状态。
| 值 | 说明 |
|---|---|
| Enabled | |
| Disabled | |
| InProgress | |
| Failed |
ResourceIdentityType
用于虚拟机规模集的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机规模集中删除任何标识。
| 值 | 说明 |
|---|---|
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned | |
| None |
SecurityEncryptionTypes
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。
| 值 | 说明 |
|---|---|
| VMGuestStateOnly | |
| DiskWithVMGuestState | |
| NonPersistedTPM |
SecurityProfile
指定虚拟机或虚拟机规模集的安全配置文件设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| encryptionAtHost |
boolean |
用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密,包括主机本身的资源/临时磁盘。 默认行为为:除非将此属性设置为 true,否则将禁用主机上的加密。 |
| encryptionIdentity |
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。 |
|
| proxyAgentSettings |
在创建虚拟机时指定 ProxyAgent 设置。 最低 API 版本:2023-09-01。 |
|
| securityType |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。 |
|
| uefiSettings |
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 api 版本:2020-12-01。 |
SecurityTypes
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。
| 值 | 说明 |
|---|---|
| TrustedLaunch | |
| ConfidentialVM |
SettingNames
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。
| 值 | 说明 |
|---|---|
| AutoLogon | |
| FirstLogonCommands |
Sku
描述虚拟机规模集 SKU。 注意:如果规模集当前在硬件上不支持新的 VM SKU,则需要在修改 SKU 名称之前解除分配规模集中的 VM。
| 名称 | 类型 | 说明 |
|---|---|---|
| capacity |
integer (int64) |
指定规模集中的虚拟机数。 |
| name |
string |
SKU 名称。 |
| tier |
string |
指定规模集中的虚拟机层。 |
SshConfiguration
Azure 上运行的基于 Linux 的 VM 的 SSH 配置
| 名称 | 类型 | 说明 |
|---|---|---|
| publicKeys |
用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。 |
SshPublicKey
包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。
| 名称 | 类型 | 说明 |
|---|---|---|
| keyData |
string |
用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥必须至少为 2048 位且采用 ssh-rsa 格式。 有关创建 ssh 密钥,请参阅 [在 Azure 中的 Linux 和 Mac 上为 Linux VM 创建 SSH 密钥]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
| path |
string |
指定存储 ssh 公钥的已创建 VM 上的完整路径。 如果文件已存在,则指定的键将追加到该文件中。 示例:/home/user/.ssh/authorized_keys |
StatusLevelTypes
级别代码。
| 值 | 说明 |
|---|---|
| Info | |
| Warning | |
| Error |
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 | |
| Premium_LRS | |
| StandardSSD_LRS | |
| UltraSSD_LRS | |
| Premium_ZRS | |
| StandardSSD_ZRS | |
| PremiumV2_LRS |
StorageProfile
指定虚拟机磁盘的存储设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| alignRegionalDisksToVMZone |
boolean |
指定区域磁盘是否应对齐/移动到 VM 区域。 这仅适用于放置属性集的 VM。 请注意,此更改不可逆。 最低 api 版本:2024-11-01。 |
| dataDisks |
Data |
指定用于向虚拟机添加数据磁盘的参数。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
| diskControllerType |
指定为 VM 配置的磁盘控制器类型。 注意: 如果未指定提供的虚拟机,则会根据指定的最低 API 版本中的操作系统磁盘和 VM 大小的功能,使用“hyperVGeneration”设置为 V2,此属性将设置为默认磁盘控制器类型。 在更新 VM 控制器类型之前,需要解除分配 VM,除非在 VM 配置中更新 VM 大小,该配置隐式解除分配并重新分配 VM。 最低 API 版本:2022-08-01。 |
|
| imageReference |
指定要使用的图像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像,但不在其他创建操作中使用,则需要此元素。 |
|
| osDisk |
指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息,请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
SubResource
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |
UefiSettings
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 api 版本:2020-12-01。
| 名称 | 类型 | 说明 |
|---|---|---|
| secureBootEnabled |
boolean |
指定是否应在虚拟机上启用安全启动。 最低 api 版本:2020-12-01。 |
| vTpmEnabled |
boolean |
指定是否应在虚拟机上启用 vTPM。 最低 api 版本:2020-12-01。 |
UserAssignedIdentitiesValue
| 名称 | 类型 | 说明 |
|---|---|---|
| clientId |
string |
用户分配标识的客户端 ID。 |
| principalId |
string |
用户分配标识的主体 ID。 |
VaultCertificate
介绍 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。
| 名称 | 类型 | 说明 |
|---|---|---|
| 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 中编码: |
VaultSecretGroup
描述一组证书,这些证书都位于同一 Key Vault 中。
| 名称 | 类型 | 说明 |
|---|---|---|
| sourceVault |
Key Vault 的相对 URL,其中包含 VaultCertificates 中的所有证书。 |
|
| vaultCertificates |
SourceVault 中包含证书的密钥保管库引用列表。 |
VirtualHardDisk
描述磁盘的 URI。
| 名称 | 类型 | 说明 |
|---|---|---|
| uri |
string |
指定虚拟硬盘的 URI。 |
VirtualMachineAgentInstanceView
虚拟机上运行的虚拟机代理的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| extensionHandlers |
虚拟机扩展处理程序实例视图。 |
|
| statuses |
资源状态信息。 |
|
| vmAgentVersion |
string |
VM 代理完整版。 |
VirtualMachineExtension
描述虚拟机扩展。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
资源所在的地理位置 |
| name |
string |
资源的名称 |
| properties.autoUpgradeMinorVersion |
boolean |
指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 |
| properties.enableAutomaticUpgrade |
boolean |
指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 |
| properties.forceUpdateTag |
string |
即使扩展配置未更改,扩展处理程序也应强制更新。 |
| properties.instanceView |
虚拟机扩展实例视图。 |
|
| properties.protectedSettings |
该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 |
|
| properties.protectedSettingsFromKeyVault |
由引用传递的扩展保护的设置,并从密钥保管库使用 |
|
| properties.provisionAfterExtensions |
string[] |
需要预配此扩展的扩展名称的集合。 |
| properties.provisioningState |
string |
预配状态,仅出现在响应中。 |
| properties.publisher |
string |
扩展处理程序发布者的名称。 |
| properties.settings |
扩展的 Json 格式公共设置。 |
|
| properties.suppressFailures |
boolean |
指示是否取消来自扩展的故障(不连接到 VM 等作故障不会取消,而不管此值如何)。 默认值为 false。 |
| properties.type |
string |
指定扩展的类型;例如“CustomScriptExtension”。 |
| properties.typeHandlerVersion |
string |
指定脚本处理程序的版本。 |
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
| tags |
object |
资源标记。 |
| type |
string |
资源类型。 例如,“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
VirtualMachineExtensionHandlerInstanceView
虚拟机扩展处理程序的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| status |
扩展处理程序状态。 |
|
| type |
string |
指定扩展的类型;例如“CustomScriptExtension”。 |
| typeHandlerVersion |
string |
指定脚本处理程序的版本。 |
VirtualMachineExtensionInstanceView
虚拟机扩展的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
虚拟机扩展名称。 |
| statuses |
资源状态信息。 |
|
| substatuses |
资源状态信息。 |
|
| type |
string |
指定扩展的类型;例如“CustomScriptExtension”。 |
| typeHandlerVersion |
string |
指定脚本处理程序的版本。 |
VirtualMachineHealthStatus
VM 的运行状况。
| 名称 | 类型 | 说明 |
|---|---|---|
| status |
VM 的运行状况信息。 |
VirtualMachineIdentity
虚拟机的标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| principalId |
string |
虚拟机标识的主体 ID。 此属性仅针对系统分配的标识提供。 |
| tenantId |
string |
与虚拟机关联的租户 ID。 此属性仅针对系统分配的标识提供。 |
| type |
用于虚拟机的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 |
|
| userAssignedIdentities |
<string,
User |
与虚拟机关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
VirtualMachineIpTag
包含与公共 IP 地址关联的 IP 标记。
| 名称 | 类型 | 说明 |
|---|---|---|
| ipTagType |
string |
IP 标记类型。 示例:FirstPartyUsage。 |
| tag |
string |
与公共 IP 关联的 IP 标记。 示例:SQL、存储等。 |
VirtualMachineNetworkInterfaceConfiguration
描述虚拟机网络接口配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
网络接口配置名称。 |
| properties.auxiliaryMode |
指定是否为网络接口资源启用辅助模式。 |
|
| properties.auxiliarySku |
指定是否为网络接口资源启用辅助 SKU。 |
|
| properties.deleteOption |
指定删除 VM 时网络接口发生的情况 |
|
| properties.disableTcpStateTracking |
boolean |
指定是否为 tcp 状态跟踪禁用网络接口。 |
| properties.dnsSettings |
要应用于网络接口的 dns 设置。 |
|
| properties.dscpConfiguration | ||
| properties.enableAcceleratedNetworking |
boolean |
指定网络接口是否已启用加速网络。 |
| properties.enableFpga |
boolean |
指定网络接口是否已启用 FPGA 网络。 |
| properties.enableIPForwarding |
boolean |
是否在此 NIC 上启用了 IP 转发。 |
| properties.ipConfigurations |
指定网络接口的 IP 配置。 |
|
| properties.networkSecurityGroup |
网络安全组。 |
|
| properties.primary |
boolean |
指定主网络接口,以防虚拟机具有 1 个以上的网络接口。 |
| tags |
object |
应用于此 NetworkInterfaceConfiguration 创建的 networkInterface 地址的资源标记 |
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
描述虚拟机网络配置的 DNS 设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| dnsServers |
string[] |
DNS 服务器 IP 地址列表 |
VirtualMachineNetworkInterfaceIPConfiguration
描述虚拟机网络配置文件的 IP 配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
IP 配置名称。 |
| properties.applicationGatewayBackendAddressPools |
指定对应用程序网关后端地址池的引用数组。 虚拟机可以引用多个应用程序网关的后端地址池。 多个虚拟机不能使用相同的应用程序网关。 |
|
| properties.applicationSecurityGroups |
指定对应用程序安全组的引用数组。 |
|
| properties.loadBalancerBackendAddressPools |
指定对负载均衡器后端地址池的引用数组。 虚拟机可以引用一个公共负载均衡器和一个内部负载均衡器的后端地址池。 [多个虚拟机不能使用相同的基本 SKU 负载均衡器]。 |
|
| properties.primary |
boolean |
指定主网络接口,以防虚拟机具有 1 个以上的网络接口。 |
| properties.privateIPAddressVersion |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
|
| properties.publicIPAddressConfiguration |
publicIPAddressConfiguration。 |
|
| properties.subnet |
指定子网的标识符。 |
VirtualMachinePublicIPAddressConfiguration
介绍虚拟机 IP 配置的公共 IPAddress 配置
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
publicIP 地址配置名称。 |
| properties.deleteOption |
指定删除 VM 时公共 IP 地址发生的情况 |
|
| properties.dnsSettings |
要应用于 publicIP 地址的 dns 设置。 |
|
| properties.idleTimeoutInMinutes |
integer (int32) |
公共 IP 地址的空闲超时。 |
| properties.ipTags |
与公共 IP 地址关联的 IP 标记列表。 |
|
| properties.publicIPAddressVersion |
从 Api-Version 2019-07-01 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
|
| properties.publicIPAllocationMethod |
指定公共 IP 分配类型 |
|
| properties.publicIPPrefix |
要从中分配 publicIP 地址的 PublicIPPrefix。 |
|
| sku |
描述公共 IP Sku。 只能将 OrchestrationMode 设置为灵活。 |
|
| tags |
object |
应用于此 PublicIPAddressConfiguration 创建的 publicIP 地址的资源标记 |
VirtualMachinePublicIPAddressDnsSettingsConfiguration
描述虚拟机网络配置的 DNS 设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| domainNameLabel |
string |
将创建的 PublicIPAddress 资源的域名标签前缀。 生成的名称标签是域名标签和 vm 网络配置文件唯一 ID 的串联。 |
| domainNameLabelScope |
将创建的 PublicIPAddress 资源的域名标签范围。 生成的名称标签是哈希域名标签与策略的串联,根据域名标签范围和 vm 网络配置文件唯一 ID。 |
VirtualMachineScaleSetIPConfiguration
介绍虚拟机规模集网络配置文件的 IP 配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
IP 配置名称。 |
| properties.applicationGatewayBackendAddressPools |
指定对应用程序网关后端地址池的引用数组。 规模集可以引用多个应用程序网关的后端地址池。 多个规模集不能使用相同的应用程序网关。 |
|
| properties.applicationSecurityGroups |
指定对应用程序安全组的引用数组。 |
|
| properties.loadBalancerBackendAddressPools |
指定对负载均衡器后端地址池的引用数组。 规模集可以引用一个公共负载均衡器和一个内部负载均衡器的后端地址池。 多个规模集不能使用相同的基本 SKU 负载均衡器。 |
|
| properties.loadBalancerInboundNatPools |
指定对负载均衡器的入站 Nat 池的引用数组。 规模集可以引用一个公共负载均衡器和一个内部负载均衡器的入站 NAT 池。 多个规模集不能使用相同的基本 SKU 负载均衡器。 |
|
| properties.primary |
boolean |
指定主网络接口,以防虚拟机具有 1 个以上的网络接口。 |
| properties.privateIPAddressVersion |
从 Api-Version 2017-03-30 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
|
| properties.publicIPAddressConfiguration |
publicIPAddressConfiguration。 |
|
| properties.subnet |
指定子网的标识符。 |
VirtualMachineScaleSetIpTag
包含与公共 IP 地址关联的 IP 标记。
| 名称 | 类型 | 说明 |
|---|---|---|
| ipTagType |
string |
IP 标记类型。 示例:FirstPartyUsage。 |
| tag |
string |
与公共 IP 关联的 IP 标记。 示例:SQL、存储等。 |
VirtualMachineScaleSetNetworkConfiguration
介绍虚拟机规模集网络配置文件的网络配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
网络配置名称。 |
| properties.auxiliaryMode |
指定是否为网络接口资源启用辅助模式。 |
|
| properties.auxiliarySku |
指定是否为网络接口资源启用辅助 SKU。 |
|
| properties.deleteOption |
指定删除 VM 时网络接口发生的情况 |
|
| properties.disableTcpStateTracking |
boolean |
指定是否为 tcp 状态跟踪禁用网络接口。 |
| properties.dnsSettings |
要应用于网络接口的 dns 设置。 |
|
| properties.enableAcceleratedNetworking |
boolean |
指定网络接口是否已启用加速网络。 |
| properties.enableFpga |
boolean |
指定网络接口是否已启用 FPGA 网络。 |
| properties.enableIPForwarding |
boolean |
是否在此 NIC 上启用了 IP 转发。 |
| properties.ipConfigurations |
指定网络接口的 IP 配置。 |
|
| properties.networkSecurityGroup |
网络安全组。 |
|
| properties.primary |
boolean |
指定主网络接口,以防虚拟机具有 1 个以上的网络接口。 |
| tags |
object |
应用于此 NetworkInterfaceConfiguration 创建的 networkInterface 地址的资源标记 |
VirtualMachineScaleSetNetworkConfigurationDnsSettings
描述虚拟机规模集网络配置的 DNS 设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| dnsServers |
string[] |
DNS 服务器 IP 地址列表 |
VirtualMachineScaleSetPublicIPAddressConfiguration
介绍虚拟机规模集 IP 配置的公共 IPAddress 配置
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
publicIP 地址配置名称。 |
| properties.deleteOption |
指定删除 VM 时公共 IP 会发生什么情况 |
|
| properties.dnsSettings |
Virtual |
要应用于 publicIP 地址的 dns 设置。 |
| properties.idleTimeoutInMinutes |
integer (int32) |
公共 IP 地址的空闲超时。 |
| properties.ipTags |
与公共 IP 地址关联的 IP 标记列表。 |
|
| properties.publicIPAddressVersion |
从 Api-Version 2019-07-01 开始提供,它表示特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。 可能的值为:“IPv4”和“IPv6”。 |
|
| properties.publicIPPrefix |
要从中分配 publicIP 地址的 PublicIPPrefix。 |
|
| sku |
描述公共 IP Sku。 只能将 OrchestrationMode 设置为灵活。 |
|
| tags |
object |
应用于此 PublicIPAddressConfiguration 创建的 publicIP 地址的资源标记 |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
描述虚拟机规模集网络配置的 DNS 设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| domainNameLabel |
string |
域名标签。域名标签和 vm 索引的串联将是将创建的 PublicIPAddress 资源的域名标签 |
| domainNameLabelScope |
域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签 |
VirtualMachineScaleSetVM
描述虚拟机规模集虚拟机。
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
Etag 是在 VMSS VM 的 Update/Get 响应中返回的属性,以便客户可以在标头中提供它以确保乐观更新。 |
| id |
string |
资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
虚拟机的标识(如果已配置)。 |
|
| instanceId |
string |
虚拟机实例 ID。 |
| location |
string |
资源所在的地理位置 |
| name |
string |
资源的名称 |
| plan |
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像,然后才能从 API 使用市场映像。 在 Azure 门户中,找到要使用的市场映像,然后单击 想要以编程方式部署,开始使用 ->。 输入任何必需的信息,然后单击“保存 |
|
| properties.additionalCapabilities |
指定在规模集中的虚拟机上启用或禁用的其他功能。 例如:虚拟机是否能够支持使用UltraSSD_LRS存储帐户类型附加托管数据磁盘。 |
|
| properties.availabilitySet |
指定应将虚拟机分配到的可用性集的相关信息。 在同一可用性集中指定的虚拟机分配给不同的节点,以最大程度地提高可用性。 有关可用性集的详细信息,请参阅 可用性集概述。 有关 Azure 计划内维护的详细信息,请参阅 Azure中虚拟机的 |
|
| properties.diagnosticsProfile |
指定启动诊断设置状态。 最低 API 版本:2015-06-15。 |
|
| properties.hardwareProfile |
指定虚拟机的硬件设置。 |
|
| properties.instanceView |
虚拟机实例视图。 |
|
| properties.latestModelApplied |
boolean |
指定是否已将最新型号应用于虚拟机。 |
| properties.licenseType |
string |
指定正在使用的映像或磁盘在本地获得许可。 |
| properties.modelDefinitionApplied |
string |
指定应用于虚拟机的模型是虚拟机规模集的模型还是虚拟机的自定义模型。 |
| properties.networkProfile |
指定虚拟机的网络接口。 |
|
| properties.networkProfileConfiguration |
指定虚拟机的网络配置文件配置。 |
|
| properties.osProfile |
指定虚拟机的操作系统设置。 |
|
| properties.protectionPolicy |
指定虚拟机的保护策略。 |
|
| properties.provisioningState |
string |
预配状态,仅出现在响应中。 |
| properties.resilientVMDeletionStatus |
指定虚拟机的弹性 VM 删除状态。 |
|
| properties.securityProfile |
指定虚拟机的安全相关配置文件设置。 |
|
| properties.storageProfile |
指定虚拟机磁盘的存储设置。 |
|
| properties.timeCreated |
string (date-time) |
指定创建虚拟机资源的时间。 最低 api 版本:2021-11-01。 |
| properties.userData |
string |
VM 的 UserData(必须进行 base-64 编码)。 客户不应在此处传递任何机密。 最低 API 版本:2021-03-01 |
| properties.vmId |
string |
Azure VM 唯一 ID。 |
| resources |
虚拟机子扩展资源。 |
|
| sku |
虚拟机 SKU。 |
|
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
| tags |
object |
资源标记。 |
| type |
string |
资源类型。 例如,“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
| zones |
string[] |
虚拟机区域。 |
VirtualMachineScaleSetVMInstanceView
虚拟机规模集 VM 的实例视图。
| 名称 | 类型 | 说明 |
|---|---|---|
| assignedHost |
string |
当虚拟机与启用了自动放置的专用主机组相关联时,通过自动放置分配虚拟机的专用主机的资源 ID。 最低 API 版本:2020-06-01。 |
| bootDiagnostics |
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。 |
|
| computerName |
string |
指定虚拟机的主机 OS 名称。 |
| disks |
磁盘信息。 |
|
| extensions |
扩展信息。 |
|
| hyperVGeneration |
虚拟机的虚拟机监控程序生成 [V1, V2] |
|
| maintenanceRedeployStatus |
虚拟机上的维护作状态。 |
|
| osName |
string |
在混合计算机上运行的作系统。 |
| osVersion |
string |
在混合计算机上运行的作系统版本。 |
| placementGroupId |
string |
运行虚拟机的放置组。 如果 VM 已解除分配,则它将没有 placementGroupId。 |
| platformFaultDomain |
integer (int32) |
容错域计数。 |
| platformUpdateDomain |
integer (int32) |
更新域计数。 |
| rdpThumbPrint |
string |
远程桌面证书指纹。 |
| statuses |
资源状态信息。 |
|
| vmAgent |
虚拟机上运行的虚拟机代理。 |
|
| vmHealth |
VM 的运行状况。 |
VirtualMachineScaleSetVMNetworkProfileConfiguration
描述虚拟机规模集 VM 网络配置文件。
| 名称 | 类型 | 说明 |
|---|---|---|
| networkInterfaceConfigurations |
网络配置列表。 |
VirtualMachineScaleSetVMProtectionPolicy
虚拟机规模集 VM 的保护策略。
| 名称 | 类型 | 说明 |
|---|---|---|
| protectFromScaleIn |
boolean |
指示不应将虚拟机规模集 VM 视为在进行缩减操作期间删除。 |
| protectFromScaleSetActions |
boolean |
指示不应将虚拟机规模集上启动的模型更新或操作(包括缩减)应用于虚拟机规模集 VM。 |
VirtualMachineSizeTypes
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机
| 值 | 说明 |
|---|---|
| Basic_A0 | |
| Basic_A1 | |
| Basic_A2 | |
| Basic_A3 | |
| Basic_A4 | |
| Standard_A0 | |
| Standard_A1 | |
| Standard_A2 | |
| Standard_A3 | |
| Standard_A4 | |
| Standard_A5 | |
| Standard_A6 | |
| Standard_A7 | |
| Standard_A8 | |
| Standard_A9 | |
| Standard_A10 | |
| Standard_A11 | |
| Standard_A1_v2 | |
| Standard_A2_v2 | |
| Standard_A4_v2 | |
| Standard_A8_v2 | |
| Standard_A2m_v2 | |
| Standard_A4m_v2 | |
| Standard_A8m_v2 | |
| Standard_B1s | |
| Standard_B1ms | |
| Standard_B2s | |
| Standard_B2ms | |
| Standard_B4ms | |
| Standard_B8ms | |
| Standard_D1 | |
| Standard_D2 | |
| Standard_D3 | |
| Standard_D4 | |
| Standard_D11 | |
| Standard_D12 | |
| Standard_D13 | |
| Standard_D14 | |
| Standard_D1_v2 | |
| Standard_D2_v2 | |
| Standard_D3_v2 | |
| Standard_D4_v2 | |
| Standard_D5_v2 | |
| Standard_D2_v3 | |
| Standard_D4_v3 | |
| Standard_D8_v3 | |
| Standard_D16_v3 | |
| Standard_D32_v3 | |
| Standard_D64_v3 | |
| Standard_D2s_v3 | |
| Standard_D4s_v3 | |
| Standard_D8s_v3 | |
| Standard_D16s_v3 | |
| Standard_D32s_v3 | |
| Standard_D64s_v3 | |
| Standard_D11_v2 | |
| Standard_D12_v2 | |
| Standard_D13_v2 | |
| Standard_D14_v2 | |
| Standard_D15_v2 | |
| Standard_DS1 | |
| Standard_DS2 | |
| Standard_DS3 | |
| Standard_DS4 | |
| Standard_DS11 | |
| Standard_DS12 | |
| Standard_DS13 | |
| Standard_DS14 | |
| Standard_DS1_v2 | |
| Standard_DS2_v2 | |
| Standard_DS3_v2 | |
| Standard_DS4_v2 | |
| Standard_DS5_v2 | |
| Standard_DS11_v2 | |
| Standard_DS12_v2 | |
| Standard_DS13_v2 | |
| Standard_DS14_v2 | |
| Standard_DS15_v2 | |
| Standard_DS13-4_v2 | |
| Standard_DS13-2_v2 | |
| Standard_DS14-8_v2 | |
| Standard_DS14-4_v2 | |
| Standard_E2_v3 | |
| Standard_E4_v3 | |
| Standard_E8_v3 | |
| Standard_E16_v3 | |
| Standard_E32_v3 | |
| Standard_E64_v3 | |
| Standard_E2s_v3 | |
| Standard_E4s_v3 | |
| Standard_E8s_v3 | |
| Standard_E16s_v3 | |
| Standard_E32s_v3 | |
| Standard_E64s_v3 | |
| Standard_E32-16_v3 | |
| Standard_E32-8s_v3 | |
| Standard_E64-32s_v3 | |
| Standard_E64-16s_v3 | |
| Standard_F1 | |
| Standard_F2 | |
| Standard_F4 | |
| Standard_F8 | |
| Standard_F16 | |
| Standard_F1s | |
| Standard_F2s | |
| Standard_F4s | |
| Standard_F8s | |
| Standard_F16s | |
| Standard_F2s_v2 | |
| Standard_F4s_v2 | |
| Standard_F8s_v2 | |
| Standard_F16s_v2 | |
| Standard_F32s_v2 | |
| Standard_F64s_v2 | |
| Standard_F72s_v2 | |
| Standard_G1 | |
| Standard_G2 | |
| Standard_G3 | |
| Standard_G4 | |
| Standard_G5 | |
| Standard_GS1 | |
| Standard_GS2 | |
| Standard_GS3 | |
| Standard_GS4 | |
| Standard_GS5 | |
| Standard_GS4-8 | |
| Standard_GS4-4 | |
| Standard_GS5-16 | |
| Standard_GS5-8 | |
| Standard_H8 | |
| Standard_H16 | |
| Standard_H8m | |
| Standard_H16m | |
| Standard_H16r | |
| Standard_H16mr | |
| Standard_L4s | |
| Standard_L8s | |
| Standard_L16s | |
| Standard_L32s | |
| Standard_M64s | |
| Standard_M64ms | |
| Standard_M128s | |
| Standard_M128ms | |
| Standard_M64-32ms | |
| Standard_M64-16ms | |
| Standard_M128-64ms | |
| Standard_M128-32ms | |
| Standard_NC6 | |
| Standard_NC12 | |
| Standard_NC24 | |
| Standard_NC24r | |
| Standard_NC6s_v2 | |
| Standard_NC12s_v2 | |
| Standard_NC24s_v2 | |
| Standard_NC24rs_v2 | |
| Standard_NC6s_v3 | |
| Standard_NC12s_v3 | |
| Standard_NC24s_v3 | |
| Standard_NC24rs_v3 | |
| Standard_ND6s | |
| Standard_ND12s | |
| Standard_ND24s | |
| Standard_ND24rs | |
| Standard_NV6 | |
| Standard_NV12 | |
| Standard_NV24 |
VMDiskSecurityProfile
指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。
| 名称 | 类型 | 说明 |
|---|---|---|
| diskEncryptionSet |
指定用于客户托管密钥加密的 ConfidentialVM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。 |
|
| securityEncryptionType |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。 |
VMSizeProperties
指定虚拟机上的 VM 大小属性设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| vCPUsAvailable |
integer (int32) |
指定可用于 VM 的 vCPU 数。 如果未在请求正文中指定此属性,则默认行为是将其设置为 api 响应中公开的 vCPU 的值,列出区域中所有可用的虚拟机大小。 |
| vCPUsPerCore |
integer (int32) |
指定 vCPU 与物理核心比率。 如果未在请求正文中指定此属性,则默认行为设置为 api 响应中公开的 vm 大小的 vCPUUsPerCore 值,列出区域中的所有可用虚拟机大小。 将此属性设置为 1 也意味着禁用了超线程处理。 |
WindowsConfiguration
指定虚拟机上的 Windows 操作系统设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalUnattendContent |
指定其他 base-64 编码的 XML 格式信息,这些信息可以包含在 Windows 安装程序使用的 Unattend.xml 文件中。 |
|
| enableAutomaticUpdates |
boolean |
指示是否为 Windows 虚拟机启用自动更新。 默认值为 true。 对于虚拟机规模集,可以更新此属性,更新将对 OS 重新预配生效。 |
| enableVMAgentPlatformUpdates |
boolean |
指示是否为 Windows 虚拟机启用了 VMAgent 平台更新。 |
| patchSettings |
[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。 |
|
| provisionVMAgent |
boolean |
指示是否应在虚拟机上预配虚拟机代理。 如果未在请求正文中指定此属性,则默认情况下此属性设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。 |
| timeZone |
string |
指定虚拟机的时区。 例如“太平洋标准时间”。 可能的值可以从 TimeZoneInfo.GetSystemTimeZones返回的时区 TimeZoneInfo.Id 值。 |
| winRM |
指定 Windows 远程管理侦听器。 这将启用远程 Windows PowerShell。 |
WindowsPatchAssessmentMode
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。
可能的值为:
ImageDefault - 控制虚拟机上的修补程序评估的时间。
AutomaticByPlatform - 平台将触发定期修补评估。 属性 provisionVMAgent 必须为 true。
| 值 | 说明 |
|---|---|
| ImageDefault | |
| AutomaticByPlatform |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
| 值 | 说明 |
|---|---|
| Unknown | |
| IfRequired | |
| Never | |
| Always |
WindowsVMGuestPatchAutomaticByPlatformSettings
指定在 Windows 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
使客户能够在不意外升级的情况下计划修补 |
| rebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
WindowsVMGuestPatchMode
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。
可能的值为:
手动 - 可以控制将修补程序应用到虚拟机。 为此,请在 VM 中手动应用修补程序。 在此模式下,自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false
AutomaticByOS - 虚拟机将由 OS 自动更新。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。
AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true
| 值 | 说明 |
|---|---|
| Manual | |
| AutomaticByOS | |
| AutomaticByPlatform |
WinRMConfiguration
介绍 VM 的 Windows 远程管理配置
| 名称 | 类型 | 说明 |
|---|---|---|
| listeners |
Windows 远程管理侦听器列表 |
WinRMListener
介绍 Windows 远程管理侦听器的协议和指纹
| 名称 | 类型 | 说明 |
|---|---|---|
| certificateUrl |
string |
这是已作为机密上传到 Key Vault 的证书的 URL。 若要将机密添加到 Key Vault,请参阅 向密钥保管库添加密钥或机密。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象在 UTF-8 中编码: |
| protocol |
指定 WinRM 侦听器的协议。 可能的值为:http、https。 |