Virtual Machines - List All
列出指定訂用帳戶中的所有虛擬機。 在回應中使用 nextLink 屬性來取得虛擬機的下一頁。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2024-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2024-07-01&statusOnly={statusOnly}&$filter={$filter}&$expand=instanceView
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
$expand
|
query |
要套用至作業的展開表達式。 'instanceView' 會啟用擷取所有虛擬機的運行時間狀態,只有在指定有效的$filter選項時,才能指定此狀態 |
||
$filter
|
query |
string |
用來篩選回應中傳回的 VM 的系統查詢選項。 允許的值是 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' |
|
status
|
query |
string |
statusOnly=true 會啟用訂用帳戶中所有虛擬機的擷取運行時間狀態。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Virtual |
Virtual |
VirtualMachine_ListAll_MaximumSet_Gen
範例要求
範例回覆
{
"value": [
{
"properties": {
"vmId": "{vmId}",
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hardwareProfile": {
"vmSize": "Standard_A0",
"vmSizeProperties": {
"vCPUsAvailable": 7,
"vCPUsPerCore": 14
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20170406",
"exactVersion": "aaaaaaaaaaaaa",
"sharedGalleryImageId": "aaaaaaaaaaaaaaa",
"communityGalleryImageId": "aaaa",
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"osDisk": {
"osType": "Windows",
"name": "test",
"createOption": "FromImage",
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"caching": "None",
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"securityProfile": {
"securityEncryptionType": "VMGuestStateOnly",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
},
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
},
"deleteOption": "Delete"
},
"dataDisks": []
},
"osProfile": {
"computerName": "Test",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"customData": "aaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaaaaaaaaaaaaaaaaaaaaa",
"keyData": "aaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"requireGuestProvisionSignal": true
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2022-05-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"disableTcpStateTracking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaaaaaaaaaaaaaa"
]
},
"ipConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 23,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaa",
"domainNameLabelScope": "TenantReuse"
},
"ipTags": [
{
"ipTagType": "aaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"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}"
}
}
}
]
},
"provisioningState": "Succeeded",
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaaaaaaaaaa"
}
},
"virtualMachineScaleSet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"priority": "Regular",
"evictionPolicy": "Deallocate",
"billingProfile": {
"maxPrice": 26
},
"host": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hostGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaaaaaaa",
"extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"platformFaultDomain": 8,
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
},
"osImageNotificationProfile": {
"notBeforeTimeout": "PT15M",
"enable": true
}
},
"userData": "aaa",
"capacityReservation": {
"capacityReservationGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"applicationProfile": {
"galleryApplications": [
{
"tags": "aaaaa",
"order": 4,
"packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
"configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
},
"timeCreated": "2022-01-14T16:43:41.683Z"
},
"type": "Microsoft.Compute/virtualMachines",
"location": "eastus",
"tags": {},
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
"name": "{virtualMachineName}",
"plan": {
"name": "aaaaaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaa"
},
"resources": [
{
"properties": {
"forceUpdateTag": "aaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaa",
"type": "aaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaa",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {},
"protectedSettings": {},
"provisioningState": "aaa",
"suppressFailures": true,
"protectedSettingsFromKeyVault": {
"sourceVault": {
"id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
},
"secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
}
},
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"name": "aaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"location": "aaaaaaaaaaaaaaaa",
"tags": {
"key9428": "aaaaaaa"
}
}
],
"identity": {
"principalId": "aaaaaaaaaaaaaaaa",
"tenantId": "aaaaa",
"type": "SystemAssigned",
"userAssignedIdentities": {
"key5688": {
"principalId": "aaaaaaaaaaaaaaa",
"clientId": "aaaaaaaaaaa"
}
}
},
"zones": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaa"
],
"extendedLocation": {
"name": "aaaa",
"type": "EdgeZone"
}
},
{
"properties": {
"vmId": "{vmId}",
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hardwareProfile": {
"vmSize": "Standard_A0",
"vmSizeProperties": {
"vCPUsAvailable": 7,
"vCPUsPerCore": 14
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20170406",
"exactVersion": "aa",
"sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
},
"osDisk": {
"osType": "Windows",
"name": "test",
"createOption": "FromImage",
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"caching": "None",
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"securityProfile": {
"securityEncryptionType": "VMGuestStateOnly",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
},
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
},
"deleteOption": "Delete"
},
"dataDisks": []
},
"osProfile": {
"computerName": "Test",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"customData": "aaaaaaaaaaaaaaaaaaaaaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaaaaaaaaaaaaaaaaaaaaa",
"keyData": "aaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"requireGuestProvisionSignal": true
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2022-05-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"disableTcpStateTracking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaaaaaaaaaaaaaa"
]
},
"ipConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 23,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaa",
"domainNameLabelScope": "SubscriptionReuse"
},
"ipTags": [
{
"ipTagType": "aaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"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}"
}
}
}
]
},
"provisioningState": "Succeeded",
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaaaaaaaaaa"
}
},
"virtualMachineScaleSet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"priority": "Regular",
"evictionPolicy": "Deallocate",
"billingProfile": {
"maxPrice": 26
},
"host": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hostGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaaaaaa",
"extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa",
"platformFaultDomain": 11,
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
},
"osImageNotificationProfile": {
"notBeforeTimeout": "PT15M",
"enable": true
}
},
"userData": "aaaaaaaaaaaaaaaaaaa",
"capacityReservation": {
"capacityReservationGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"applicationProfile": {
"galleryApplications": [
{
"tags": "aaaaa",
"order": 4,
"packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
"configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
},
"timeCreated": "2022-01-14T16:43:41.685Z"
},
"type": "Microsoft.Compute/virtualMachines",
"location": "eastus",
"tags": {},
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
"name": "{virtualMachineName}",
"plan": {
"name": "aaaaaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaa"
},
"resources": [
{
"properties": {
"forceUpdateTag": "aaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaa",
"type": "aaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaa",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {},
"protectedSettings": {},
"provisioningState": "aaa",
"suppressFailures": true,
"protectedSettingsFromKeyVault": {
"sourceVault": {
"id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
},
"secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
}
},
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"name": "aaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"location": "aaaaaaaaaaaaaaaa",
"tags": {
"key9428": "aaaaaaa"
}
}
],
"identity": {
"principalId": "aaaaaaaaaaaaaaaa",
"tenantId": "aaaaa",
"type": "SystemAssigned",
"userAssignedIdentities": {
"key5688": {
"principalId": "aaaaaaaaaaaaaaa",
"clientId": "aaaaaaaaaaa"
}
}
},
"zones": [
"aaaaaa"
],
"extendedLocation": {
"name": "aaaa",
"type": "EdgeZone"
}
}
],
"nextLink": "a"
}
VirtualMachine_ListAll_MinimumSet_Gen
範例要求
範例回覆
{
"value": [
{
"location": "eastus",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}"
},
{
"location": "eastus",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}"
}
]
}
定義
名稱 | Description |
---|---|
Additional |
指定在虛擬機上啟用或停用的其他功能。 |
Additional |
指定其他base-64編碼的 XML 格式資訊,這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 |
Api |
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。 |
Api |
Api 錯誤。 |
Api |
API 錯誤基底。 |
Application |
指定應該提供給 VM/VMSS 使用的資源庫應用程式。 |
Available |
虛擬機最新評估作業的可用修補程式摘要。 |
Billing |
指定 Azure Spot 虛擬機的計費相關詳細數據。 API 版本下限:2019-03-01。 |
Boot |
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 NOTE:如果指定 storageUri,請確定記憶體帳戶位於與 VM 相同的區域和訂用帳戶中。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。 |
Boot |
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。 |
Caching |
指定快取需求。 可能的值為:None、ReadOnly、ReadWrite。 預設行為為:標準記憶體的 None。進階記憶體的 ReadOnly。 |
Capacity |
指定用來配置虛擬機之容量保留區的相關信息。 API 版本下限:2021-04-01。 |
Cloud |
來自計算服務的錯誤回應。 |
Component |
元件名稱。 目前,唯一允許的值是 Microsoft-Windows-Shell-Setup。 |
Data |
指定用來將數據磁碟新增至虛擬機的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。 |
Delete |
指定刪除 VM 時網路介面會發生什麼事 |
Diagnostics |
指定開機診斷設定狀態。 API 版本下限:2015-06-15。 |
Diff |
指定作業系統磁碟的暫時磁碟設定。 |
Diff |
指定作業系統磁碟的暫時磁碟位置。 可能的值為:CacheDisk、ResourceDisk、NvmeDisk。 預設行為為:如果已針對 VM 大小設定,CacheDisk,否則會使用 ResourceDisk 或 NvmeDisk。 請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔,以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。 |
Diff |
指定虛擬機所用作業系統磁碟的暫時磁碟設定。 |
Disk |
指定為 VM 設定的磁碟控制器類型。 |
Disk |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映射建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用市集映射,則也應該使用先前所述的 plan 元素。 |
Disk |
指定 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為:Delete。 如果使用這個值,刪除 VM 時會刪除 OS 磁碟。 分離。 如果使用這個值,則會在刪除 VM 之後保留 os 磁碟。 預設值設定為 Detach。 針對暫時的 OS 磁碟,預設值會設定為 [刪除]。 使用者無法變更暫時 OS 磁碟的刪除選項。 |
Disk |
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值:ForceDetach。 detachOption:ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成,因為虛擬機發生非預期的失敗,磁碟仍未釋放,則請使用強制卸離作為最後手段選項,強制中斷連結磁碟與 VM。 使用這個卸離行為時,所有寫入可能都沒有排清。 若要強制將數據磁碟更新強制卸離至 『true』,以及設定 detachOption: 'ForceDetach'。 |
Disk |
指定受控磁碟的客戶受控磁碟加密集資源標識符。 |
Disk |
指定 OS 磁碟的加密設定。 API 版本下限:2015-06-15。 |
Disk |
虛擬機磁碟資訊。 |
Domain |
將要建立之 PublicIPAddress 資源的功能變數名稱標籤範圍。 產生的名稱標籤是根據功能變數名稱標籤範圍和 vm 網路配置檔唯一識別碼,與原則串連哈希功能變數名稱標籤。 |
Encryption |
指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。 |
Event |
建立 eventGridAndResourceGraph Scheduled Event 設定時所使用的組態參數。 |
Expand |
要套用至作業的展開表達式。 'instanceView' 會啟用擷取所有虛擬機的運行時間狀態,只有在指定有效的$filter選項時,才能指定此狀態 |
Extended |
虛擬機的擴充位置。 |
Extended |
擴充位置的類型。 |
Hardware |
指定虛擬機的硬體設定。 |
Hyper |
指定與資源相關聯的 HyperVGeneration 類型 |
Image |
指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但未用於其他建立作業時,則需要此元素。 |
Inner |
內部錯誤詳細數據。 |
Instance |
實例檢視狀態。 |
IPVersions |
從 Api-Version 2019-07-01 起提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。 |
Key |
指定 Key Vault 中金鑰加密金鑰的位置。 |
Key |
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用 |
Last |
虛擬機最新安裝作業的安裝摘要。 |
Linux |
指定虛擬機上的Linux作業系統設定。 如需支援的 Linux 發行版清單,請參閱 Azure-Endorsed 發行版上的 Linux。 |
Linux |
指定 IaaS 虛擬機的 VM 客體修補評估模式。 |
Linux |
[預覽功能]指定與Linux上的VM客體修補相關的設定。 |
Linux |
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。 |
Linux |
在 Linux 上的 VM 客體修補中,指定修補程式模式 AutomaticByPlatform 的其他設定。 |
Linux |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 |
Maintenance |
上次維護作業結果碼。 |
Maintenance |
虛擬機上的維護作業狀態。 |
Managed |
受控磁碟參數。 |
Mode |
指定如果啟用此功能,ProxyAgent 將會在 上執行的模式。 ProxyAgent 會開始稽核或監視,但不會在稽核模式中對主機端點的要求強制執行訪問控制,而在 [強制執行模式] 中,則會強制執行訪問控制。 默認值為 [強制] 模式。 |
Network |
指定在網路介面組態中建立網路資源時所使用的 Microsoft.Network API 版本 |
Network |
指定是否為網路介面資源啟用輔助模式。 |
Network |
指定是否為網路介面資源啟用輔助 SKU。 |
Network |
指定與虛擬機相關聯之網路介面的資源標識符清單。 |
Network |
指定虛擬機的網路介面。 |
Operating |
操作系統類型。 |
OSDisk |
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。 |
OSImage |
指定OS映像排程事件相關組態。 |
OSProfile |
指定建立虛擬機時所使用的作業系統設定。 布建 VM 之後,就無法變更某些設定。 |
Pass |
傳遞名稱。 目前唯一允許的值是 OobeSystem。 |
Patch |
作業的整體成功或失敗狀態。 在作業完成之前,它會維持 「InProgress」。 屆時,它將會變成「未知」、「失敗」、「成功」或「CompletedWithWarnings」。 |
Patch |
[預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。 |
Plan |
指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站中,尋找您想要使用的市集映像,然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊,然後按下 [儲存] |
Protocol |
指定 WinRM 接聽程式的通訊協定。 可能的值為:HTTP、https。 |
Proxy |
在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限:2023-09-01。 |
Public |
描述公用IP Sku。 它只能將 OrchestrationMode 設定為彈性。 |
Public |
指定公用IP SKU 名稱 |
Public |
指定公用IP SKU層 |
Public |
指定公用IP配置類型 |
Resource |
用於虛擬機的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。 |
Scheduled |
發佈 scheduledEventsAdditionalPublishingTargets 時所使用的組態參數。 |
Scheduled |
指定虛擬機的重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。 |
Scheduled |
指定排程的事件相關組態。 |
security |
指定受控磁碟的 EncryptionType。 它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly,以便只加密 VMGuestState Blob,以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。 注意: 只能設定機密 VM。 |
Security |
指定虛擬機的安全性相關配置檔設定。 |
Security |
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。 默認行為為:除非設定此屬性,否則不會啟用 UefiSettings。 |
Setting |
指定套用內容之設定的名稱。 可能的值為:FirstLogonCommands 和 AutoLogon。 |
Ssh |
指定 Linux OS 的 SSH 金鑰組態。 |
Ssh |
用來向Linux型VM進行驗證的SSH公鑰清單。 |
Status |
層級程序代碼。 |
Storage |
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。 |
Storage |
指定虛擬機磁碟的記憶體設定。 |
Sub |
包含秘密之 Key Vault 的相對 URL。 |
Terminate |
指定終止已排程的事件相關組態。 |
Uefi |
指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限:2020-12-01。 |
User |
與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
User |
建立 userInitiatedReboot 排程事件設定建立時所使用的組態參數。 |
User |
建立 userInitiatedRedeploy 排程事件設定建立時所使用的組態參數。 |
Vault |
SourceVault 中包含憑證的金鑰保存庫參考清單。 |
Vault |
指定應該安裝在虛擬機上的憑證集。 若要在虛擬機上安裝憑證,建議使用適用於Linux 的 |
Virtual |
虛擬硬碟。 |
Virtual |
虛擬機的清單。 |
Virtual |
在虛擬機上執行的 VM 代理程式。 |
Virtual |
指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。 針對 Azure Spot 虛擬機,支援「解除分配」和「刪除」,且最低 API 版本為 2019-03-01。 針對 Azure Spot 擴展集,支援「解除分配」和「刪除」,且最低 API 版本為 2017-10-30-preview。 |
Virtual |
虛擬機子延伸模組資源。 |
Virtual |
虛擬機擴充處理程序實例檢視。 |
Virtual |
虛擬機擴充實例檢視。 |
Virtual |
VM 的健康情況狀態。 |
Virtual |
如果已設定,則為虛擬機的身分識別。 |
Virtual |
虛擬機實例檢視。 |
Virtual |
與公用IP位址相關聯的IP標籤清單。 |
Virtual |
列出虛擬機作業回應。 |
Virtual |
指定將用來建立虛擬機網路資源的網路設定。 |
Virtual |
要套用在網路介面上的 DNS 設定。 |
Virtual |
指定網路介面的IP組態。 |
Virtual |
[預覽功能]虛擬機修補作業的狀態。 |
Virtual |
指定虛擬機的優先順序。 API 版本下限:2019-03-01 |
Virtual |
publicIPAddressConfiguration。 |
Virtual |
要套用至 publicIP 位址的 DNS 設定。 |
Virtual |
指定虛擬機的大小。 列舉數據類型目前已被取代,將於 2023 年 12 月 23 日移除。 取得可用大小清單的建議方式是使用這些 API:列出可用性設定組中的所有可用虛擬機大小、列出區域中所有可用的虛擬機大小、列出所有可用的虛擬機大小以重設大小。 如需虛擬機器大小的詳細資訊,請參閱 虛擬機的大小。 可用的 VM 大小取決於區域和可用性設定組。 |
VMDisk |
指定受控磁碟的安全性配置檔。 |
VMGallery |
指定應該提供給 VM/VMSS 的資源庫應用程式 |
VMSize |
指定自定義虛擬機大小的屬性。 API 版本下限:2021-07-01。 此功能仍處於預覽模式,VirtualMachineScaleSet 不支援此功能。 如需詳細資訊,請遵循 VM 自定義 中的指示。 |
Windows |
指定虛擬機上的 Windows 作業系統設定。 |
Windows |
指定 IaaS 虛擬機的 VM 客體修補評估模式。 |
Windows |
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。 |
Windows |
指定 Windows 上 VM 客體修補中的 Patch 模式 AutomaticByPlatform 的其他設定。 |
Windows |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 |
Win |
指定 Windows 遠端管理接聽程式。 這可啟用遠端 Windows PowerShell。 |
Win |
Windows 遠端管理接聽程式清單 |
AdditionalCapabilities
指定在虛擬機上啟用或停用的其他功能。
名稱 | 類型 | Description |
---|---|---|
hibernationEnabled |
boolean |
啟用或停用 VM 上休眠功能的旗標。 |
ultraSSDEnabled |
boolean |
旗標,可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。 只有啟用此屬性,才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。 |
AdditionalUnattendContent
指定其他base-64編碼的 XML 格式資訊,這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。
名稱 | 類型 | Description |
---|---|---|
componentName |
元件名稱。 目前,唯一允許的值是 Microsoft-Windows-Shell-Setup。 |
|
content |
string |
指定新增至指定路徑和元件之 unattend.xml 檔案的 XML 格式化內容。 XML 必須小於 4KB,而且必須包含要插入之設定或功能的根元素。 |
passName |
傳遞名稱。 目前唯一允許的值是 OobeSystem。 |
|
settingName |
指定套用內容之設定的名稱。 可能的值為:FirstLogonCommands 和 AutoLogon。 |
ApiEntityReference
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。
名稱 | 類型 | Description |
---|---|---|
id |
string |
以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符 |
ApiError
Api 錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
Api 錯誤詳細數據 |
|
innererror |
Api 內部錯誤 |
|
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApiErrorBase
API 錯誤基底。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApplicationProfile
指定應該提供給 VM/VMSS 使用的資源庫應用程式。
名稱 | 類型 | Description |
---|---|---|
galleryApplications |
指定應該提供給 VM/VMSS 的資源庫應用程式 |
AvailablePatchSummary
虛擬機最新評估作業的可用修補程式摘要。
名稱 | 類型 | Description |
---|---|---|
assessmentActivityId |
string |
產生此結果之作業的活動標識碼。 它用來跨CRP和擴充功能記錄相互關聯。 |
criticalAndSecurityPatchCount |
integer |
偵測到為可用且尚未安裝的重要或安全性修補程式數目。 |
error |
作業執行期間遇到的錯誤。 詳細數據陣列包含它們的清單。 |
|
lastModifiedTime |
string |
作業開始時的 UTC 時間戳。 |
otherPatchCount |
integer |
排除重大和安全性的所有可用修補程式數目。 |
rebootPending |
boolean |
VM 的整體重新啟動狀態。 部分安裝的修補程式需要重新啟動才能完成安裝,但尚未發生重新啟動時,就會是事實。 |
startTime |
string |
作業開始時的 UTC 時間戳。 |
status |
作業的整體成功或失敗狀態。 在作業完成之前,它會維持 「InProgress」。 屆時,它將會變成「未知」、「失敗」、「成功」或「CompletedWithWarnings」。 |
BillingProfile
指定 Azure Spot 虛擬機的計費相關詳細數據。 API 版本下限:2019-03-01。
名稱 | 類型 | Description |
---|---|---|
maxPrice |
number |
指定您願意為 Azure Spot VM/VMSS 付費的最高價格。 這個價格以美元為單位。 |
BootDiagnostics
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 NOTE:如果指定 storageUri,請確定記憶體帳戶位於與 VM 相同的區域和訂用帳戶中。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
名稱 | 類型 | Description |
---|---|---|
enabled |
boolean |
是否應在虛擬機上啟用開機診斷。 |
storageUri |
string |
用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。 如果在啟用開機診斷時未指定 storageUri,則會使用受控記憶體。 |
BootDiagnosticsInstanceView
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
名稱 | 類型 | Description |
---|---|---|
consoleScreenshotBlobUri |
string |
控制台螢幕快照 Blob URI。 注意: 如果目前已啟用受控記憶體的開機診斷,不會 設定。 |
serialConsoleLogBlobUri |
string |
序列主控台記錄 Blob Uri。 注意: 如果目前已啟用受控記憶體的開機診斷,不會 設定。 |
status |
VM 的開機診斷狀態資訊。 注意: 只有在啟用開機診斷時發生錯誤時,才會設定它。 |
CachingTypes
指定快取需求。 可能的值為:None、ReadOnly、ReadWrite。 預設行為為:標準記憶體的 None。進階記憶體的 ReadOnly。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
CapacityReservationProfile
指定用來配置虛擬機之容量保留區的相關信息。 API 版本下限:2021-04-01。
名稱 | 類型 | Description |
---|---|---|
capacityReservationGroup |
指定容量保留群組資源標識符,該標識元應該用於配置已保留足夠容量的虛擬機或擴展集 VM 實例。 如需詳細資訊,請參閱 https://aka.ms/CapacityReservation。 |
CloudError
來自計算服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
Api 錯誤。 |
ComponentNames
元件名稱。 目前,唯一允許的值是 Microsoft-Windows-Shell-Setup。
名稱 | 類型 | Description |
---|---|---|
Microsoft-Windows-Shell-Setup |
string |
DataDisk
指定用來將數據磁碟新增至虛擬機的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為:None、ReadOnly、ReadWrite。 預設行為為:標準記憶體的 None。進階記憶體的 ReadOnly。 |
|
createOption |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage:當您使用映像建立虛擬機數據磁碟時,會使用此值 此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用市集映射,則也應該使用先前所述的 plan 元素。 空白: 建立空白數據磁碟時會使用此值。 複製: 此值可用來從快照集或其他磁碟建立數據磁碟。 還原: 此值可用來從磁碟還原點建立數據磁碟。 |
|
deleteOption |
指定在 VM 刪除時應該刪除或中斷連結資料磁碟。 可能的值為:Delete。 如果使用此值,刪除 VM 時會刪除資料磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留資料磁碟。 預設值設定為 Detach。 |
|
detachOption |
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值:ForceDetach。 detachOption:ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成,因為虛擬機發生非預期的失敗,磁碟仍未釋放,則請使用強制卸離作為最後手段選項,強制中斷連結磁碟與 VM。 使用這個卸離行為時,所有寫入可能都沒有排清。 若要強制將數據磁碟更新強制卸離至 『true』,以及設定 detachOption: 'ForceDetach'。 |
|
diskIOPSReadWrite |
integer |
指定 StorageAccountType UltraSSD_LRS時受控磁碟的 Read-Write IOPS。 僅針對 VirtualMachine ScaleSet VM 磁碟傳回。 只能透過 VirtualMachine 擴展集的更新來更新。 |
diskMBpsReadWrite |
integer |
指定 StorageAccountType UltraSSD_LRS時,受控磁碟每秒 MB 的頻寬。 僅針對 VirtualMachine ScaleSet VM 磁碟傳回。 只能透過 VirtualMachine 擴展集的更新來更新。 |
diskSizeGB |
integer |
指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。 屬性 'diskSizeGB' 是磁碟的位元組 x 1024^3,值不能大於 1023。 |
image |
來源使用者映像虛擬硬碟。 在連接至虛擬機之前,將會先複製虛擬硬碟。 如果提供SourceImage,則目的地虛擬硬碟不得存在。 |
|
lun |
integer |
指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟,因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。 |
managedDisk |
受控磁碟參數。 |
|
name |
string |
磁碟名稱。 |
sourceResource |
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。 |
|
toBeDetached |
boolean |
指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結 |
vhd |
虛擬硬碟。 |
|
writeAcceleratorEnabled |
boolean |
指定是否應該在磁碟上啟用或停用 writeAccelerator。 |
DeleteOptions
指定刪除 VM 時網路介面會發生什麼事
名稱 | 類型 | Description |
---|---|---|
Delete |
string |
|
Detach |
string |
DiagnosticsProfile
指定開機診斷設定狀態。 API 版本下限:2015-06-15。
名稱 | 類型 | Description |
---|---|---|
bootDiagnostics |
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 NOTE:如果指定 storageUri,請確定記憶體帳戶位於與 VM 相同的區域和訂用帳戶中。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。 |
DiffDiskOptions
指定作業系統磁碟的暫時磁碟設定。
名稱 | 類型 | Description |
---|---|---|
Local |
string |
DiffDiskPlacement
指定作業系統磁碟的暫時磁碟位置。 可能的值為:CacheDisk、ResourceDisk、NvmeDisk。 預設行為為:如果已針對 VM 大小設定,CacheDisk,否則會使用 ResourceDisk 或 NvmeDisk。 請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔,以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。
名稱 | 類型 | Description |
---|---|---|
CacheDisk |
string |
|
NvmeDisk |
string |
|
ResourceDisk |
string |
DiffDiskSettings
指定虛擬機所用作業系統磁碟的暫時磁碟設定。
名稱 | 類型 | Description |
---|---|---|
option |
指定作業系統磁碟的暫時磁碟設定。 |
|
placement |
指定作業系統磁碟的暫時磁碟位置。 可能的值為:CacheDisk、ResourceDisk、NvmeDisk。 預設行為為:如果已針對 VM 大小設定,CacheDisk,否則會使用 ResourceDisk 或 NvmeDisk。 請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔,以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。 |
DiskControllerTypes
指定為 VM 設定的磁碟控制器類型。
名稱 | 類型 | Description |
---|---|---|
NVMe |
string |
|
SCSI |
string |
DiskCreateOptionTypes
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映射建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用市集映射,則也應該使用先前所述的 plan 元素。
名稱 | 類型 | Description |
---|---|---|
Attach |
string |
|
Copy |
string |
|
Empty |
string |
|
FromImage |
string |
|
Restore |
string |
DiskDeleteOptionTypes
指定 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為:Delete。 如果使用這個值,刪除 VM 時會刪除 OS 磁碟。 分離。 如果使用這個值,則會在刪除 VM 之後保留 os 磁碟。 預設值設定為 Detach。 針對暫時的 OS 磁碟,預設值會設定為 [刪除]。 使用者無法變更暫時 OS 磁碟的刪除選項。
名稱 | 類型 | Description |
---|---|---|
Delete |
string |
|
Detach |
string |
DiskDetachOptionTypes
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值:ForceDetach。 detachOption:ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成,因為虛擬機發生非預期的失敗,磁碟仍未釋放,則請使用強制卸離作為最後手段選項,強制中斷連結磁碟與 VM。 使用這個卸離行為時,所有寫入可能都沒有排清。 若要強制將數據磁碟更新強制卸離至 『true』,以及設定 detachOption: 'ForceDetach'。
名稱 | 類型 | Description |
---|---|---|
ForceDetach |
string |
DiskEncryptionSetParameters
指定受控磁碟的客戶受控磁碟加密集資源標識符。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
DiskEncryptionSettings
指定 OS 磁碟的加密設定。 API 版本下限:2015-06-15。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionKey |
指定磁碟加密密鑰的位置,也就是 Key Vault 秘密。 |
|
enabled |
boolean |
指定是否應在虛擬機上啟用磁碟加密。 |
keyEncryptionKey |
指定 Key Vault 中金鑰加密金鑰的位置。 |
DiskInstanceView
虛擬機磁碟資訊。
名稱 | 類型 | Description |
---|---|---|
encryptionSettings |
指定 OS 磁碟的加密設定。 |
|
name |
string |
磁碟名稱。 |
statuses |
資源狀態資訊。 |
DomainNameLabelScopeTypes
將要建立之 PublicIPAddress 資源的功能變數名稱標籤範圍。 產生的名稱標籤是根據功能變數名稱標籤範圍和 vm 網路配置檔唯一識別碼,與原則串連哈希功能變數名稱標籤。
名稱 | 類型 | Description |
---|---|---|
NoReuse |
string |
|
ResourceGroupReuse |
string |
|
SubscriptionReuse |
string |
|
TenantReuse |
string |
EncryptionIdentity
指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。
名稱 | 類型 | Description |
---|---|---|
userAssignedIdentityResourceId |
string |
指定與 VM 相關聯的其中一個使用者身分識別的 ARM 資源識別碼。 |
EventGridAndResourceGraph
建立 eventGridAndResourceGraph Scheduled Event 設定時所使用的組態參數。
名稱 | 類型 | Description |
---|---|---|
enable |
boolean |
指定已排程事件相關組態的事件方格和資源圖表是否已啟用。 |
ExpandTypesForListVMs
要套用至作業的展開表達式。 'instanceView' 會啟用擷取所有虛擬機的運行時間狀態,只有在指定有效的$filter選項時,才能指定此狀態
名稱 | 類型 | Description |
---|---|---|
instanceView |
string |
ExtendedLocation
虛擬機的擴充位置。
名稱 | 類型 | Description |
---|---|---|
name |
string |
擴充位置的名稱。 |
type |
擴充位置的類型。 |
ExtendedLocationTypes
擴充位置的類型。
名稱 | 類型 | Description |
---|---|---|
EdgeZone |
string |
HardwareProfile
指定虛擬機的硬體設定。
名稱 | 類型 | Description |
---|---|---|
vmSize |
指定虛擬機的大小。 列舉數據類型目前已被取代,將於 2023 年 12 月 23 日移除。 取得可用大小清單的建議方式是使用這些 API:列出可用性設定組中的所有可用虛擬機大小、列出區域中所有可用的虛擬機大小、列出所有可用的虛擬機大小以重設大小。 如需虛擬機器大小的詳細資訊,請參閱 虛擬機的大小。 可用的 VM 大小取決於區域和可用性設定組。 |
|
vmSizeProperties |
指定自定義虛擬機大小的屬性。 API 版本下限:2021-07-01。 此功能仍處於預覽模式,VirtualMachineScaleSet 不支援此功能。 如需詳細資訊,請遵循 VM 自定義 中的指示。 |
HyperVGenerationType
指定與資源相關聯的 HyperVGeneration 類型
名稱 | 類型 | Description |
---|---|---|
V1 |
string |
|
V2 |
string |
ImageReference
指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但未用於其他建立作業時,則需要此元素。
名稱 | 類型 | Description |
---|---|---|
communityGalleryImageId |
string |
指定 vm 部署的社群資源庫映像唯一標識碼。 這可以從社群資源庫映像 GET 呼叫擷取。 |
exactVersion |
string |
以十進位數指定用來建立虛擬機的平臺映像或市集映像版本。 這個只讀欄位與 'version' 不同,只有在 'version' 字段中指定的值為 'latest' 時。 |
id |
string |
資源標識碼 |
offer |
string |
指定用來建立虛擬機的平臺映像或市集映像供應專案。 |
publisher |
string |
映像發行者。 |
sharedGalleryImageId |
string |
指定 vm 部署的共享資源庫映像唯一標識碼。 這可以從共用資源庫映像 GET 呼叫擷取。 |
sku |
string |
映像 SKU。 |
version |
string |
指定用來建立虛擬機的平臺映像或市集映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建是十進位數。 指定 'latest' 以在部署時間使用可用映像的最新版本。 即使您使用「最新」,即使有新版本可用,VM 映像也不會在部署時間之後自動更新。 請勿使用欄位 'version' 進行資源庫映射部署,資源庫映射應一律使用 'id' 字段進行部署,若要使用資源庫映射的 'latest' 版本,只要設定 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}' 字段,即可不使用版本輸入。 |
InnerError
內部錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
errordetail |
string |
內部錯誤訊息或例外狀況傾印。 |
exceptiontype |
string |
例外狀況類型。 |
InstanceViewStatus
實例檢視狀態。
名稱 | 類型 | Description |
---|---|---|
code |
string |
狀態代碼。 |
displayStatus |
string |
狀態的簡短可當地語系化標籤。 |
level |
層級程序代碼。 |
|
message |
string |
詳細的狀態消息,包括警示和錯誤訊息。 |
time |
string |
狀態的時間。 |
IPVersions
從 Api-Version 2019-07-01 起提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。
名稱 | 類型 | Description |
---|---|---|
IPv4 |
string |
|
IPv6 |
string |
KeyVaultKeyReference
指定 Key Vault 中金鑰加密金鑰的位置。
名稱 | 類型 | Description |
---|---|---|
keyUrl |
string |
參考 Key Vault 中金鑰加密金鑰的 URL。 |
sourceVault |
包含金鑰之 Key Vault 的相對 URL。 |
KeyVaultSecretReference
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用
名稱 | 類型 | Description |
---|---|---|
secretUrl |
string |
參考 Key Vault 中秘密的 URL。 |
sourceVault |
包含秘密之 Key Vault 的相對 URL。 |
LastPatchInstallationSummary
虛擬機最新安裝作業的安裝摘要。
名稱 | 類型 | Description |
---|---|---|
error |
作業執行期間遇到的錯誤。 詳細數據陣列包含它們的清單。 |
|
excludedPatchCount |
integer |
所有可用的修補程式數目,但由客戶指定的排除清單相符項目明確排除。 |
failedPatchCount |
integer |
安裝失敗的修補程式計數。 |
installationActivityId |
string |
產生此結果之作業的活動標識碼。 它用來跨CRP和擴充功能記錄相互關聯。 |
installedPatchCount |
integer |
已成功安裝的修補程式計數。 |
lastModifiedTime |
string |
作業開始時的 UTC 時間戳。 |
maintenanceWindowExceeded |
boolean |
描述作業是否在完成所有預定動作之前已用盡時間 |
notSelectedPatchCount |
integer |
所有可用的修補程式數目,但不會安裝,因為它不符合分類或包含清單專案。 |
pendingPatchCount |
integer |
在修補程式安裝作業過程中,預期要安裝的所有可用修補程式數目。 |
startTime |
string |
作業開始時的 UTC 時間戳。 |
status |
作業的整體成功或失敗狀態。 在作業完成之前,它會維持 「InProgress」。 屆時,它將會變成「未知」、「失敗」、「成功」或「CompletedWithWarnings」。 |
LinuxConfiguration
指定虛擬機上的Linux作業系統設定。 如需支援的 Linux 發行版清單,請參閱 Azure-Endorsed 發行版上的 Linux。
名稱 | 類型 | Description |
---|---|---|
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。
名稱 | 類型 | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
LinuxPatchSettings
[預覽功能]指定與Linux上的VM客體修補相關的設定。
名稱 | 類型 | Description |
---|---|---|
assessmentMode |
指定 IaaS 虛擬機的 VM 客體修補評估模式。 |
|
automaticByPlatformSettings |
在 Linux 上的 VM 客體修補中,指定修補程式模式 AutomaticByPlatform 的其他設定。 |
|
patchMode |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。
名稱 | 類型 | Description |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
|
Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
在 Linux 上的 VM 客體修補中,指定修補程式模式 AutomaticByPlatform 的其他設定。
名稱 | 類型 | Description |
---|---|---|
bypassPlatformSafetyChecksOnUserSchedule |
boolean |
讓客戶在不意外升級的情況下排程修補 |
rebootSetting |
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。 |
LinuxVMGuestPatchMode
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。
可能的值為:
ImageDefault - 會使用虛擬機的預設修補組態。
AutomaticByPlatform - 虛擬機將由平台自動更新。 屬性 provisionVMAgent 必須為 true
名稱 | 類型 | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
MaintenanceOperationResultCodeTypes
上次維護作業結果碼。
名稱 | 類型 | Description |
---|---|---|
MaintenanceAborted |
string |
|
MaintenanceCompleted |
string |
|
None |
string |
|
RetryLater |
string |
MaintenanceRedeployStatus
虛擬機上的維護作業狀態。
名稱 | 類型 | Description |
---|---|---|
isCustomerInitiatedMaintenanceAllowed |
boolean |
如果允許客戶執行維護,則為 True。 |
lastOperationMessage |
string |
針對上次維護作業傳回的訊息。 |
lastOperationResultCode |
上次維護作業結果碼。 |
|
maintenanceWindowEndTime |
string |
維護時段的結束時間。 |
maintenanceWindowStartTime |
string |
維護時段的開始時間。 |
preMaintenanceWindowEndTime |
string |
維護前時段的結束時間。 |
preMaintenanceWindowStartTime |
string |
維護前時段的開始時間。 |
ManagedDiskParameters
受控磁碟參數。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionSet |
指定受控磁碟的客戶受控磁碟加密集資源標識符。 |
|
id |
string |
資源標識碼 |
securityProfile |
指定受控磁碟的安全性配置檔。 |
|
storageAccountType |
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。 |
Mode
指定如果啟用此功能,ProxyAgent 將會在 上執行的模式。 ProxyAgent 會開始稽核或監視,但不會在稽核模式中對主機端點的要求強制執行訪問控制,而在 [強制執行模式] 中,則會強制執行訪問控制。 默認值為 [強制] 模式。
名稱 | 類型 | Description |
---|---|---|
Audit |
string |
|
Enforce |
string |
NetworkApiVersion
指定在網路介面組態中建立網路資源時所使用的 Microsoft.Network API 版本
名稱 | 類型 | Description |
---|---|---|
2020-11-01 |
string |
NetworkInterfaceAuxiliaryMode
指定是否為網路介面資源啟用輔助模式。
名稱 | 類型 | Description |
---|---|---|
AcceleratedConnections |
string |
|
Floating |
string |
|
None |
string |
NetworkInterfaceAuxiliarySku
指定是否為網路介面資源啟用輔助 SKU。
名稱 | 類型 | Description |
---|---|---|
A1 |
string |
|
A2 |
string |
|
A4 |
string |
|
A8 |
string |
|
None |
string |
NetworkInterfaceReference
指定與虛擬機相關聯之網路介面的資源標識符清單。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
properties.deleteOption |
指定刪除 VM 時網路介面會發生什麼事 |
|
properties.primary |
boolean |
指定虛擬機有1個以上的網路介面時的主要網路介面。 |
NetworkProfile
指定虛擬機的網路介面。
名稱 | 類型 | Description |
---|---|---|
networkApiVersion |
指定在網路介面組態中建立網路資源時所使用的 Microsoft.Network API 版本 |
|
networkInterfaceConfigurations |
指定將用來建立虛擬機網路資源的網路設定。 |
|
networkInterfaces |
指定與虛擬機相關聯之網路介面的資源標識符清單。 |
OperatingSystemTypes
操作系統類型。
名稱 | 類型 | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDisk
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為:None、ReadOnly、ReadWrite。 預設行為為:標準記憶體的 None。進階記憶體的 ReadOnly。 |
|
createOption |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映射建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用市集映射,則也應該使用先前所述的 plan 元素。 |
|
deleteOption |
指定 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為:Delete。 如果使用這個值,刪除 VM 時會刪除 OS 磁碟。 分離。 如果使用這個值,則會在刪除 VM 之後保留 os 磁碟。 預設值設定為 Detach。 針對暫時的 OS 磁碟,預設值會設定為 [刪除]。 使用者無法變更暫時 OS 磁碟的刪除選項。 |
|
diffDiskSettings |
指定虛擬機所用作業系統磁碟的暫時磁碟設定。 |
|
diskSizeGB |
integer |
指定以 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。 |
OSImageNotificationProfile
指定OS映像排程事件相關組態。
名稱 | 類型 | Description |
---|---|---|
enable |
boolean |
指定是否啟用或停用OS映像排程事件。 |
notBeforeTimeout |
string |
虛擬機重新映像或升級其操作系統的時間長度,在事件自動核准之前,必須核准OS映射排程事件(逾時)。 設定是以 ISO 8601 格式指定,且值必須是 15 分鐘(PT15M) |
OSProfile
指定建立虛擬機時所使用的作業系統設定。 布建 VM 之後,就無法變更某些設定。
名稱 | 類型 | Description |
---|---|---|
adminPassword |
string |
指定系統管理員帳戶的密碼。 |
adminUsername |
string |
指定系統管理員帳戶的名稱。 |
allowExtensionOperations |
boolean |
指定虛擬機上是否應該允許擴充功能作業。 只有在虛擬機上沒有擴充功能時,才會將此選項設定為 False。 |
computerName |
string |
指定虛擬機的主機OS名稱。 建立 VM 之後,無法更新此名稱。
最大長度 (Windows): 15 個字元。
長度上限(Linux): 64 個字元。 如需命名慣例和限制,請參閱 |
customData |
string |
指定自訂數據的base-64編碼字串。 base-64 編碼字串會譯碼為儲存為虛擬機上檔案的二進位數組。 二進位陣列的最大長度為65535個字節。 注意:請勿在 customData 屬性中傳遞任何秘密或密碼。 建立 VM 之後,就無法更新此屬性。 屬性 'customData' 會傳遞至要儲存為檔案的 VM,如需詳細資訊,請參閱 Azure VM 上的自定義數據。 如需針對 Linux VM 使用 cloud-init,請參閱 在建立期間使用 cloud-init 自定義 Linux VM。 |
linuxConfiguration |
指定虛擬機上的Linux作業系統設定。 如需支援的 Linux 發行版清單,請參閱 Azure-Endorsed 發行版上的 Linux。 |
|
requireGuestProvisionSignal |
boolean |
必須設定為 True 或省略的選擇性屬性。 |
secrets |
指定應該安裝在虛擬機上的憑證集。 若要在虛擬機上安裝憑證,建議使用適用於Linux 的 |
|
windowsConfiguration |
指定虛擬機上的 Windows 作業系統設定。 |
PassNames
傳遞名稱。 目前唯一允許的值是 OobeSystem。
名稱 | 類型 | Description |
---|---|---|
OobeSystem |
string |
PatchOperationStatus
作業的整體成功或失敗狀態。 在作業完成之前,它會維持 「InProgress」。 屆時,它將會變成「未知」、「失敗」、「成功」或「CompletedWithWarnings」。
名稱 | 類型 | Description |
---|---|---|
CompletedWithWarnings |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
|
Unknown |
string |
PatchSettings
[預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。
名稱 | 類型 | Description |
---|---|---|
assessmentMode |
指定 IaaS 虛擬機的 VM 客體修補評估模式。 |
|
automaticByPlatformSettings |
指定 Windows 上 VM 客體修補中的 Patch 模式 AutomaticByPlatform 的其他設定。 |
|
enableHotpatching |
boolean |
可讓客戶修補其 Azure VM,而不需要重新啟動。 針對 enableHotpatching,'provisionVMAgent' 必須設定為 true,且 'patchMode' 必須設定為 'AutomaticByPlatform'。 |
patchMode |
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。 |
Plan
指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站中,尋找您想要使用的市集映像,然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊,然後按下 [儲存]
名稱 | 類型 | Description |
---|---|---|
name |
string |
方案標識碼。 |
product |
string |
指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 |
promotionCode |
string |
促銷碼。 |
publisher |
string |
發行者標識碼。 |
ProtocolTypes
指定 WinRM 接聽程式的通訊協定。 可能的值為:HTTP、https。
名稱 | 類型 | Description |
---|---|---|
Http |
string |
|
Https |
string |
ProxyAgentSettings
在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限:2023-09-01。
名稱 | 類型 | Description |
---|---|---|
enabled |
boolean |
指定是否應在虛擬機或虛擬機擴展集上啟用 ProxyAgent 功能。 |
keyIncarnationId |
integer |
增加此屬性的值可讓使用者重設用來保護客體與主機之間通道的密鑰。 |
mode |
指定如果啟用此功能,ProxyAgent 將會在 上執行的模式。 ProxyAgent 會開始稽核或監視,但不會在稽核模式中對主機端點的要求強制執行訪問控制,而在 [強制執行模式] 中,則會強制執行訪問控制。 默認值為 [強制] 模式。 |
PublicIPAddressSku
描述公用IP Sku。 它只能將 OrchestrationMode 設定為彈性。
名稱 | 類型 | Description |
---|---|---|
name |
指定公用IP SKU 名稱 |
|
tier |
指定公用IP SKU層 |
PublicIPAddressSkuName
指定公用IP SKU 名稱
名稱 | 類型 | Description |
---|---|---|
Basic |
string |
|
Standard |
string |
PublicIPAddressSkuTier
指定公用IP SKU層
名稱 | 類型 | Description |
---|---|---|
Global |
string |
|
Regional |
string |
PublicIPAllocationMethod
指定公用IP配置類型
名稱 | 類型 | Description |
---|---|---|
Dynamic |
string |
|
Static |
string |
ResourceIdentityType
用於虛擬機的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ScheduledEventsAdditionalPublishingTargets
發佈 scheduledEventsAdditionalPublishingTargets 時所使用的組態參數。
名稱 | 類型 | Description |
---|---|---|
eventGridAndResourceGraph |
建立 eventGridAndResourceGraph Scheduled Event 設定時所使用的組態參數。 |
ScheduledEventsPolicy
指定虛擬機的重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。
名稱 | 類型 | Description |
---|---|---|
scheduledEventsAdditionalPublishingTargets |
發佈 scheduledEventsAdditionalPublishingTargets 時所使用的組態參數。 |
|
userInitiatedReboot |
建立 userInitiatedReboot 排程事件設定建立時所使用的組態參數。 |
|
userInitiatedRedeploy |
建立 userInitiatedRedeploy 排程事件設定建立時所使用的組態參數。 |
ScheduledEventsProfile
指定排程的事件相關組態。
名稱 | 類型 | Description |
---|---|---|
osImageNotificationProfile |
指定OS映像排程事件相關組態。 |
|
terminateNotificationProfile |
指定終止已排程的事件相關組態。 |
securityEncryptionTypes
指定受控磁碟的 EncryptionType。 它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly,以便只加密 VMGuestState Blob,以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。 注意: 只能設定機密 VM。
名稱 | 類型 | Description |
---|---|---|
DiskWithVMGuestState |
string |
|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
指定虛擬機的安全性相關配置檔設定。
名稱 | 類型 | Description |
---|---|---|
encryptionAtHost |
boolean |
用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密,包括主機本身的資源/暫存磁碟。 默認行為為:除非資源將此屬性設定為 true,否則將會停用主機的加密。 |
encryptionIdentity |
指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。 |
|
proxyAgentSettings |
在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限:2023-09-01。 |
|
securityType |
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。 默認行為為:除非設定此屬性,否則不會啟用 UefiSettings。 |
|
uefiSettings |
指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限:2020-12-01。 |
SecurityTypes
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。 默認行為為:除非設定此屬性,否則不會啟用 UefiSettings。
名稱 | 類型 | Description |
---|---|---|
ConfidentialVM |
string |
|
TrustedLaunch |
string |
SettingNames
指定套用內容之設定的名稱。 可能的值為:FirstLogonCommands 和 AutoLogon。
名稱 | 類型 | Description |
---|---|---|
AutoLogon |
string |
|
FirstLogonCommands |
string |
SshConfiguration
指定 Linux OS 的 SSH 金鑰組態。
名稱 | 類型 | Description |
---|---|---|
publicKeys |
用來向Linux型VM進行驗證的SSH公鑰清單。 |
SshPublicKey
用來向Linux型VM進行驗證的SSH公鑰清單。
名稱 | 類型 | Description |
---|---|---|
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 |
指定已建立 VM 上儲存 SSH 公鑰的完整路徑。 如果檔案已經存在,指定的索引鍵會附加至檔案。 範例:/home/user/.ssh/authorized_keys |
StatusLevelTypes
層級程序代碼。
名稱 | 類型 | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
StorageAccountTypes
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。
名稱 | 類型 | Description |
---|---|---|
PremiumV2_LRS |
string |
|
Premium_LRS |
string |
|
Premium_ZRS |
string |
|
StandardSSD_LRS |
string |
|
StandardSSD_ZRS |
string |
|
Standard_LRS |
string |
|
UltraSSD_LRS |
string |
StorageProfile
指定虛擬機磁碟的記憶體設定。
名稱 | 類型 | Description |
---|---|---|
dataDisks |
Data |
指定用來將數據磁碟新增至虛擬機的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。 |
diskControllerType |
指定為 VM 設定的磁碟控制器類型。 |
|
imageReference |
指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但未用於其他建立作業時,則需要此元素。 |
|
osDisk |
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機器的磁碟和 VHD。 |
SubResource
包含秘密之 Key Vault 的相對 URL。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
TerminateNotificationProfile
指定終止已排程的事件相關組態。
名稱 | 類型 | Description |
---|---|---|
enable |
boolean |
指定是否啟用或停用終止排程事件。 |
notBeforeTimeout |
string |
刪除虛擬機的可設定時間長度,在事件自動核准之前,必須先核准終止排程事件(逾時)。 設定必須以 ISO 8601 格式指定,預設值為 5 分鐘(PT5M) |
UefiSettings
指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限:2020-12-01。
名稱 | 類型 | Description |
---|---|---|
secureBootEnabled |
boolean |
指定是否應在虛擬機上啟用安全開機。 API 版本下限:2020-12-01。 |
vTpmEnabled |
boolean |
指定是否應在虛擬機上啟用 vTPM。 API 版本下限:2020-12-01。 |
UserAssignedIdentities
與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
名稱 | 類型 | Description |
---|---|---|
|
UserInitiatedReboot
建立 userInitiatedReboot 排程事件設定建立時所使用的組態參數。
名稱 | 類型 | Description |
---|---|---|
automaticallyApprove |
boolean |
指定重新啟動排程的事件相關組態。 |
UserInitiatedRedeploy
建立 userInitiatedRedeploy 排程事件設定建立時所使用的組態參數。
名稱 | 類型 | Description |
---|---|---|
automaticallyApprove |
boolean |
指定重新部署排程的事件相關組態。 |
VaultCertificate
SourceVault 中包含憑證的金鑰保存庫參考清單。
名稱 | 類型 | Description |
---|---|---|
certificateStore |
string |
針對 Windows VM,指定應新增憑證之虛擬機上的證書存儲。 指定的證書存儲隱含在 LocalMachine 帳戶中。 針對 Linux VM,憑證檔案會放在 /var/lib/waagent 目錄底下,檔名 <X509 憑證檔案的大寫Thumbprint>.crt,並針對私鑰 <大寫Thumbprint>.prv。 這兩個檔案都是 .pem 格式。 |
certificateUrl |
string |
這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault,請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下,您的憑證必須是下列 JSON 物件的 Base64 編碼,其編碼方式為 UTF-8: |
VaultSecretGroup
指定應該安裝在虛擬機上的憑證集。 若要在虛擬機上安裝憑證,建議使用適用於Linux 的
名稱 | 類型 | Description |
---|---|---|
sourceVault |
Key Vault 的相對 URL,其中包含 VaultCertificates 中的所有憑證。 |
|
vaultCertificates |
SourceVault 中包含憑證的金鑰保存庫參考清單。 |
VirtualHardDisk
虛擬硬碟。
名稱 | 類型 | Description |
---|---|---|
uri |
string |
指定虛擬硬碟的 URI。 |
VirtualMachine
虛擬機的清單。
名稱 | 類型 | Description |
---|---|---|
etag |
string |
Etag 是在 VM 的 Create/Update/Get 回應中傳回的屬性,讓客戶可以在標頭中提供它,以確保開放式更新。 |
extendedLocation |
虛擬機的擴充位置。 |
|
id |
string |
資源標識碼 |
identity |
如果已設定,則為虛擬機的身分識別。 |
|
location |
string |
資源位置 |
managedBy |
string |
如果 VM 是 VMSS 的一部分,ManagedBy 會設定為虛擬機擴展集(VMSS) flex ARM resourceID。 平臺會使用此屬性進行內部資源群組刪除優化。 |
name |
string |
資源名稱 |
plan |
指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站中,尋找您想要使用的市集映像,然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊,然後按下 [儲存] |
|
properties.additionalCapabilities |
指定在虛擬機上啟用或停用的其他功能。 |
|
properties.applicationProfile |
指定應該提供給 VM/VMSS 使用的資源庫應用程式。 |
|
properties.availabilitySet |
指定虛擬機應指派之可用性設定組的相關信息。 相同可用性設定組中指定的虛擬機會配置給不同的節點,以將可用性最大化。 如需可用性設定組的詳細資訊,請參閱 可用性設定組概觀。 如需 Azure 計劃性維護的詳細資訊,請參閱 Azure中虛擬機的維護和更新。 目前,VM 只能在建立時新增至可用性設定組。 要新增 VM 的可用性設定組應該位於與可用性設定組資源相同的資源群組之下。 現有的 VM 無法新增至可用性設定組。 這個屬性不能與非 Null properties.virtualMachineScaleSet 參考一起存在。 |
|
properties.billingProfile |
指定 Azure Spot 虛擬機的計費相關詳細數據。 API 版本下限:2019-03-01。 |
|
properties.capacityReservation |
指定用來配置虛擬機之容量保留區的相關信息。 API 版本下限:2021-04-01。 |
|
properties.diagnosticsProfile |
指定開機診斷設定狀態。 API 版本下限:2015-06-15。 |
|
properties.evictionPolicy |
指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。 針對 Azure Spot 虛擬機,支援「解除分配」和「刪除」,且最低 API 版本為 2019-03-01。 針對 Azure Spot 擴展集,支援「解除分配」和「刪除」,且最低 API 版本為 2017-10-30-preview。 |
|
properties.extensionsTimeBudget |
string |
指定所有延伸模組要啟動的時間。 持續時間應介於 15 分鐘到 120 分鐘之間(含),且應以 ISO 8601 格式指定。 預設值為90分鐘(PT1H30M)。 API 版本下限:2020-06-01。 |
properties.hardwareProfile |
指定虛擬機的硬體設定。 |
|
properties.host |
指定虛擬機所在專用主機的相關信息。 API 版本下限:2018-10-01。 |
|
properties.hostGroup |
指定虛擬機所在專用主機群組的相關信息。 注意: 用戶無法同時指定主機和 hostGroup 屬性。 API 版本下限:2020-06-01。 |
|
properties.instanceView |
虛擬機實例檢視。 |
|
properties.licenseType |
string |
指定所使用的映像或磁碟已獲內部部署授權。 |
properties.networkProfile |
指定虛擬機的網路介面。 |
|
properties.osProfile |
指定建立虛擬機時所使用的作業系統設定。 布建 VM 之後,就無法變更某些設定。 |
|
properties.platformFaultDomain |
integer |
指定要在其中建立虛擬機的擴展集邏輯容錯網域。 根據預設,虛擬機會自動指派給容錯網域,以在可用的容錯網域之間維持平衡。 只有當設定此虛擬機的 'virtualMachineScaleSet' 屬性時,才適用這個屬性。 參考的虛擬機擴展集必須具有大於 1 的 『platformFaultDomainCount』。 建立虛擬機之後,就無法更新這個屬性。 容錯網域指派可以在虛擬機實例檢視中檢視。 最低 api\version:2020\12\01。 |
properties.priority |
指定虛擬機的優先順序。 API 版本下限:2019-03-01 |
|
properties.provisioningState |
string |
只出現在回應中的布建狀態。 |
properties.proximityPlacementGroup |
指定應該指派虛擬機之鄰近放置群組的相關信息。 API 版本下限:2018-04-01。 |
|
properties.scheduledEventsPolicy |
指定虛擬機的重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。 |
|
properties.scheduledEventsProfile |
指定排程的事件相關組態。 |
|
properties.securityProfile |
指定虛擬機的安全性相關配置檔設定。 |
|
properties.storageProfile |
指定虛擬機磁碟的記憶體設定。 |
|
properties.timeCreated |
string |
指定建立虛擬機資源的時間。 API 版本下限:2021-11-01。 |
properties.userData |
string |
VM 的 UserData,其必須是base-64編碼。 客戶不應在此傳遞任何秘密。 API 版本下限:2021-03-01。 |
properties.virtualMachineScaleSet |
指定應該指派虛擬機之虛擬機擴展集的相關信息。 相同虛擬機擴展集中指定的虛擬機會配置給不同的節點,以將可用性最大化。 目前,VM 只能在建立時新增至虛擬機擴展集。 現有的 VM 無法新增至虛擬機擴展集。 這個屬性不能與非 Null properties.availabilitySet 參考一起存在。 最低 api\version:2019\03\01。 |
|
properties.vmId |
string |
指定 VM 唯一識別碼,這是 128 位標識碼,該標識碼會編碼並儲存在所有 Azure IaaS VM SMBIOS 中,而且可以使用平臺 BIOS 命令來讀取。 |
resources |
虛擬機子延伸模組資源。 |
|
tags |
object |
資源標籤 |
type |
string |
資源類型 |
zones |
string[] |
虛擬機區域。 |
VirtualMachineAgentInstanceView
在虛擬機上執行的 VM 代理程式。
名稱 | 類型 | Description |
---|---|---|
extensionHandlers |
虛擬機擴充處理程序實例檢視。 |
|
statuses |
資源狀態資訊。 |
|
vmAgentVersion |
string |
VM 代理程式完整版本。 |
VirtualMachineEvictionPolicyTypes
指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。 針對 Azure Spot 虛擬機,支援「解除分配」和「刪除」,且最低 API 版本為 2019-03-01。 針對 Azure Spot 擴展集,支援「解除分配」和「刪除」,且最低 API 版本為 2017-10-30-preview。
名稱 | 類型 | Description |
---|---|---|
Deallocate |
string |
|
Delete |
string |
VirtualMachineExtension
虛擬機子延伸模組資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
location |
string |
資源位置 |
name |
string |
資源名稱 |
properties.autoUpgradeMinorVersion |
boolean |
指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。 |
properties.enableAutomaticUpgrade |
boolean |
指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。 |
properties.forceUpdateTag |
string |
即使延伸模組組態尚未變更,延伸模組處理程式也應該強制更新。 |
properties.instanceView |
虛擬機擴充實例檢視。 |
|
properties.protectedSettings |
object |
延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 |
properties.protectedSettingsFromKeyVault |
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用 |
|
properties.provisionAfterExtensions |
string[] |
必須布建此延伸模組之後的延伸模組名稱集合。 |
properties.provisioningState |
string |
只出現在回應中的布建狀態。 |
properties.publisher |
string |
擴充處理程序發行者的名稱。 |
properties.settings |
object |
擴充功能的 Json 格式化公用設定。 |
properties.suppressFailures |
boolean |
指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。 |
properties.type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
properties.typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
tags |
object |
資源標籤 |
type |
string |
資源類型 |
VirtualMachineExtensionHandlerInstanceView
虛擬機擴充處理程序實例檢視。
名稱 | 類型 | Description |
---|---|---|
status |
擴充處理程序狀態。 |
|
type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
VirtualMachineExtensionInstanceView
虛擬機擴充實例檢視。
名稱 | 類型 | Description |
---|---|---|
name |
string |
虛擬機擴充功能名稱。 |
statuses |
資源狀態資訊。 |
|
substatuses |
資源狀態資訊。 |
|
type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
VirtualMachineHealthStatus
VM 的健康情況狀態。
名稱 | 類型 | Description |
---|---|---|
status |
VM 的健康情況狀態資訊。 |
VirtualMachineIdentity
如果已設定,則為虛擬機的身分識別。
名稱 | 類型 | Description |
---|---|---|
principalId |
string |
虛擬機身分識別的主體標識碼。 此屬性只會針對系統指派的身分識別提供。 |
tenantId |
string |
與虛擬機相關聯的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。 |
type |
用於虛擬機的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。 |
|
userAssignedIdentities |
與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
VirtualMachineInstanceView
虛擬機實例檢視。
名稱 | 類型 | Description |
---|---|---|
assignedHost |
string |
當虛擬機與已啟用自動放置的專用主機群組相關聯時,虛擬機會透過自動放置配置專用主機的資源標識符。 API 版本下限:2020-06-01。 |
bootDiagnostics |
開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。 |
|
computerName |
string |
指派給虛擬機的計算機名稱。 |
disks |
虛擬機磁碟資訊。 |
|
extensions |
延伸模組資訊。 |
|
hyperVGeneration |
指定與資源相關聯的 HyperVGeneration 類型 |
|
isVMInStandbyPool |
boolean |
[預覽功能]指定 VM 目前在待命集區中或離開。 |
maintenanceRedeployStatus |
虛擬機上的維護作業狀態。 |
|
osName |
string |
在虛擬機上執行的作業系統。 |
osVersion |
string |
在虛擬機上執行的作業系統版本。 |
patchStatus |
[預覽功能]虛擬機修補作業的狀態。 |
|
platformFaultDomain |
integer |
指定虛擬機的容錯網域。 |
platformUpdateDomain |
integer |
指定虛擬機的更新網域。 |
rdpThumbPrint |
string |
遠端桌面憑證指紋。 |
statuses |
資源狀態資訊。 |
|
vmAgent |
在虛擬機上執行的 VM 代理程式。 |
|
vmHealth |
VM 的健康情況狀態。 |
VirtualMachineIpTag
與公用IP位址相關聯的IP標籤清單。
名稱 | 類型 | Description |
---|---|---|
ipTagType |
string |
IP 標籤類型。 範例:FirstPartyUsage。 |
tag |
string |
與公用IP相關聯的IP標籤。 範例:SQL、記憶體等。 |
VirtualMachineListResult
列出虛擬機作業回應。
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
要擷取下一頁 VM 的 URI。 使用此 URI 呼叫 ListNext(),以擷取虛擬機的下一頁。 |
value |
虛擬機的清單。 |
VirtualMachineNetworkInterfaceConfiguration
指定將用來建立虛擬機網路資源的網路設定。
名稱 | 類型 | Description |
---|---|---|
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個以上的網路介面時的主要網路介面。 |
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
要套用在網路介面上的 DNS 設定。
名稱 | 類型 | Description |
---|---|---|
dnsServers |
string[] |
DNS 伺服器 IP 位址清單 |
VirtualMachineNetworkInterfaceIPConfiguration
指定網路介面的IP組態。
名稱 | 類型 | Description |
---|---|---|
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 |
指定子網的識別碼。 |
VirtualMachinePatchStatus
[預覽功能]虛擬機修補作業的狀態。
名稱 | 類型 | Description |
---|---|---|
availablePatchSummary |
虛擬機最新評估作業的可用修補程式摘要。 |
|
configurationStatuses |
指定 patchMode 的啟用狀態 |
|
lastPatchInstallationSummary |
虛擬機最新安裝作業的安裝摘要。 |
VirtualMachinePriorityTypes
指定虛擬機的優先順序。 API 版本下限:2019-03-01
名稱 | 類型 | Description |
---|---|---|
Low |
string |
|
Regular |
string |
|
Spot |
string |
VirtualMachinePublicIPAddressConfiguration
publicIPAddressConfiguration。
名稱 | 類型 | Description |
---|---|---|
name |
string |
publicIP 位址組態名稱。 |
properties.deleteOption |
指定刪除 VM 時,公用 IP 位址會發生什麼事 |
|
properties.dnsSettings |
要套用至 publicIP 位址的 DNS 設定。 |
|
properties.idleTimeoutInMinutes |
integer |
公用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 設定為彈性。 |
VirtualMachinePublicIPAddressDnsSettingsConfiguration
要套用至 publicIP 位址的 DNS 設定。
名稱 | 類型 | Description |
---|---|---|
domainNameLabel |
string |
將要建立之 PublicIPAddress 資源的功能變數名稱標籤前置詞。 產生的名稱標籤是功能變數名稱標籤和 vm 網路設定檔唯一識別碼的串連。 |
domainNameLabelScope |
將要建立之 PublicIPAddress 資源的功能變數名稱標籤範圍。 產生的名稱標籤是根據功能變數名稱標籤範圍和 vm 網路配置檔唯一識別碼,與原則串連哈希功能變數名稱標籤。 |
VirtualMachineSizeTypes
指定虛擬機的大小。 列舉數據類型目前已被取代,將於 2023 年 12 月 23 日移除。 取得可用大小清單的建議方式是使用這些 API:列出可用性設定組中的所有可用虛擬機大小、列出區域中所有可用的虛擬機大小、列出所有可用的虛擬機大小以重設大小。 如需虛擬機器大小的詳細資訊,請參閱 虛擬機的大小。 可用的 VM 大小取決於區域和可用性設定組。
名稱 | 類型 | Description |
---|---|---|
Basic_A0 |
string |
|
Basic_A1 |
string |
|
Basic_A2 |
string |
|
Basic_A3 |
string |
|
Basic_A4 |
string |
|
Standard_A0 |
string |
|
Standard_A1 |
string |
|
Standard_A10 |
string |
|
Standard_A11 |
string |
|
Standard_A1_v2 |
string |
|
Standard_A2 |
string |
|
Standard_A2_v2 |
string |
|
Standard_A2m_v2 |
string |
|
Standard_A3 |
string |
|
Standard_A4 |
string |
|
Standard_A4_v2 |
string |
|
Standard_A4m_v2 |
string |
|
Standard_A5 |
string |
|
Standard_A6 |
string |
|
Standard_A7 |
string |
|
Standard_A8 |
string |
|
Standard_A8_v2 |
string |
|
Standard_A8m_v2 |
string |
|
Standard_A9 |
string |
|
Standard_B1ms |
string |
|
Standard_B1s |
string |
|
Standard_B2ms |
string |
|
Standard_B2s |
string |
|
Standard_B4ms |
string |
|
Standard_B8ms |
string |
|
Standard_D1 |
string |
|
Standard_D11 |
string |
|
Standard_D11_v2 |
string |
|
Standard_D12 |
string |
|
Standard_D12_v2 |
string |
|
Standard_D13 |
string |
|
Standard_D13_v2 |
string |
|
Standard_D14 |
string |
|
Standard_D14_v2 |
string |
|
Standard_D15_v2 |
string |
|
Standard_D16_v3 |
string |
|
Standard_D16s_v3 |
string |
|
Standard_D1_v2 |
string |
|
Standard_D2 |
string |
|
Standard_D2_v2 |
string |
|
Standard_D2_v3 |
string |
|
Standard_D2s_v3 |
string |
|
Standard_D3 |
string |
|
Standard_D32_v3 |
string |
|
Standard_D32s_v3 |
string |
|
Standard_D3_v2 |
string |
|
Standard_D4 |
string |
|
Standard_D4_v2 |
string |
|
Standard_D4_v3 |
string |
|
Standard_D4s_v3 |
string |
|
Standard_D5_v2 |
string |
|
Standard_D64_v3 |
string |
|
Standard_D64s_v3 |
string |
|
Standard_D8_v3 |
string |
|
Standard_D8s_v3 |
string |
|
Standard_DS1 |
string |
|
Standard_DS11 |
string |
|
Standard_DS11_v2 |
string |
|
Standard_DS12 |
string |
|
Standard_DS12_v2 |
string |
|
Standard_DS13 |
string |
|
Standard_DS13-2_v2 |
string |
|
Standard_DS13-4_v2 |
string |
|
Standard_DS13_v2 |
string |
|
Standard_DS14 |
string |
|
Standard_DS14-4_v2 |
string |
|
Standard_DS14-8_v2 |
string |
|
Standard_DS14_v2 |
string |
|
Standard_DS15_v2 |
string |
|
Standard_DS1_v2 |
string |
|
Standard_DS2 |
string |
|
Standard_DS2_v2 |
string |
|
Standard_DS3 |
string |
|
Standard_DS3_v2 |
string |
|
Standard_DS4 |
string |
|
Standard_DS4_v2 |
string |
|
Standard_DS5_v2 |
string |
|
Standard_E16_v3 |
string |
|
Standard_E16s_v3 |
string |
|
Standard_E2_v3 |
string |
|
Standard_E2s_v3 |
string |
|
Standard_E32-16_v3 |
string |
|
Standard_E32-8s_v3 |
string |
|
Standard_E32_v3 |
string |
|
Standard_E32s_v3 |
string |
|
Standard_E4_v3 |
string |
|
Standard_E4s_v3 |
string |
|
Standard_E64-16s_v3 |
string |
|
Standard_E64-32s_v3 |
string |
|
Standard_E64_v3 |
string |
|
Standard_E64s_v3 |
string |
|
Standard_E8_v3 |
string |
|
Standard_E8s_v3 |
string |
|
Standard_F1 |
string |
|
Standard_F16 |
string |
|
Standard_F16s |
string |
|
Standard_F16s_v2 |
string |
|
Standard_F1s |
string |
|
Standard_F2 |
string |
|
Standard_F2s |
string |
|
Standard_F2s_v2 |
string |
|
Standard_F32s_v2 |
string |
|
Standard_F4 |
string |
|
Standard_F4s |
string |
|
Standard_F4s_v2 |
string |
|
Standard_F64s_v2 |
string |
|
Standard_F72s_v2 |
string |
|
Standard_F8 |
string |
|
Standard_F8s |
string |
|
Standard_F8s_v2 |
string |
|
Standard_G1 |
string |
|
Standard_G2 |
string |
|
Standard_G3 |
string |
|
Standard_G4 |
string |
|
Standard_G5 |
string |
|
Standard_GS1 |
string |
|
Standard_GS2 |
string |
|
Standard_GS3 |
string |
|
Standard_GS4 |
string |
|
Standard_GS4-4 |
string |
|
Standard_GS4-8 |
string |
|
Standard_GS5 |
string |
|
Standard_GS5-16 |
string |
|
Standard_GS5-8 |
string |
|
Standard_H16 |
string |
|
Standard_H16m |
string |
|
Standard_H16mr |
string |
|
Standard_H16r |
string |
|
Standard_H8 |
string |
|
Standard_H8m |
string |
|
Standard_L16s |
string |
|
Standard_L32s |
string |
|
Standard_L4s |
string |
|
Standard_L8s |
string |
|
Standard_M128-32ms |
string |
|
Standard_M128-64ms |
string |
|
Standard_M128ms |
string |
|
Standard_M128s |
string |
|
Standard_M64-16ms |
string |
|
Standard_M64-32ms |
string |
|
Standard_M64ms |
string |
|
Standard_M64s |
string |
|
Standard_NC12 |
string |
|
Standard_NC12s_v2 |
string |
|
Standard_NC12s_v3 |
string |
|
Standard_NC24 |
string |
|
Standard_NC24r |
string |
|
Standard_NC24rs_v2 |
string |
|
Standard_NC24rs_v3 |
string |
|
Standard_NC24s_v2 |
string |
|
Standard_NC24s_v3 |
string |
|
Standard_NC6 |
string |
|
Standard_NC6s_v2 |
string |
|
Standard_NC6s_v3 |
string |
|
Standard_ND12s |
string |
|
Standard_ND24rs |
string |
|
Standard_ND24s |
string |
|
Standard_ND6s |
string |
|
Standard_NV12 |
string |
|
Standard_NV24 |
string |
|
Standard_NV6 |
string |
VMDiskSecurityProfile
指定受控磁碟的安全性配置檔。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionSet |
針對客戶受控密鑰加密的機密VM OS 磁碟和 VMGuest Blob 所使用的受控磁碟,指定客戶受控磁碟加密集資源識別碼。 |
|
securityEncryptionType |
指定受控磁碟的 EncryptionType。 它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly,以便只加密 VMGuestState Blob,以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。 注意: 只能設定機密 VM。 |
VMGalleryApplication
指定應該提供給 VM/VMSS 的資源庫應用程式
名稱 | 類型 | Description |
---|---|---|
configurationReference |
string |
選擇性,指定 Azure Blob 的 URI,如果提供的話,將會取代套件的預設組態 |
enableAutomaticUpgrade |
boolean |
如果設定為 true,當 PIR/SIG 中提供新的資源庫應用程式版本時,VM/VMSS 會自動更新它 |
order |
integer |
選擇性,指定必須安裝套件的順序 |
packageReferenceId |
string |
指定 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{version} 形式的 GalleryApplicationVersion 資源標識符 |
tags |
string |
選擇性,指定更多泛型內容的傳遞值。 |
treatFailureAsDeploymentFailure |
boolean |
選擇性,如果為 true,VmApplication 中任何作業的任何失敗都會使部署失敗 |
VMSizeProperties
指定自定義虛擬機大小的屬性。 API 版本下限:2021-07-01。 此功能仍處於預覽模式,VirtualMachineScaleSet 不支援此功能。 如需詳細資訊,請遵循 VM 自定義 中的指示。
名稱 | 類型 | Description |
---|---|---|
vCPUsAvailable |
integer |
指定 VM 可用的 vCPU 數目。 當要求本文中未指定此屬性時,預設行為是將它設定為 api 回應中公開的 vCPU 值,列出區域中所有可用的虛擬機大小。 |
vCPUsPerCore |
integer |
指定 vCPU 與實體核心比率。 當要求本文中未指定此屬性時,預設行為會針對 api 回應中公開的 VM 大小設定為 vCPUUsPerCore 的值,列出區域中所有可用的虛擬機大小,。 將此屬性設定為 1 也表示已停用超線程處理。 |
WindowsConfiguration
指定虛擬機上的 Windows 作業系統設定。
名稱 | 類型 | Description |
---|---|---|
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。
名稱 | 類型 | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。
名稱 | 類型 | Description |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
|
Unknown |
string |
WindowsVMGuestPatchAutomaticByPlatformSettings
指定 Windows 上 VM 客體修補中的 Patch 模式 AutomaticByPlatform 的其他設定。
名稱 | 類型 | Description |
---|---|---|
bypassPlatformSafetyChecksOnUserSchedule |
boolean |
讓客戶在不意外升級的情況下排程修補 |
rebootSetting |
指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。 |
WindowsVMGuestPatchMode
將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。
可能的值為:
手動 - 您可以控制將修補程式的應用程式套用至虛擬機。 您可以手動在 VM 內套用修補程式來執行此動作。 在此模式中,會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false
AutomaticByOS - 作業系統會自動更新虛擬機。 屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。
AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true
名稱 | 類型 | Description |
---|---|---|
AutomaticByOS |
string |
|
AutomaticByPlatform |
string |
|
Manual |
string |
WinRMConfiguration
指定 Windows 遠端管理接聽程式。 這可啟用遠端 Windows PowerShell。
名稱 | 類型 | Description |
---|---|---|
listeners |
Windows 遠端管理接聽程式清單 |
WinRMListener
Windows 遠端管理接聽程式清單
名稱 | 類型 | Description |
---|---|---|
certificateUrl |
string |
這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault,請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下,您的憑證必須是以UTF-8編碼的下列 JSON 物件的Base64編碼: |
protocol |
指定 WinRM 接聽程式的通訊協定。 可能的值為:HTTP、https。 |