Virtual Machine Scale Sets - List

取得資源群組下所有 VM 擴展集的清單。

HTTP
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2021-11-01

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

回應

名稱 類型 Description
200 OK

VirtualMachineScaleSetListResult

確定

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

VirtualMachineScaleSets_List_MaximumSet_Gen

範例要求

HTTP
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2021-11-01

範例回覆

JSON
{
  "value": [
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {},
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": true,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": true,
            "disableAutomaticRollback": true
          },
          "rollingUpgradePolicy": {
            "maxBatchInstancePercent": 49,
            "maxUnhealthyInstancePercent": 81,
            "maxUnhealthyUpgradedInstancePercent": 98,
            "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
            "enableCrossZoneUpgrade": true,
            "prioritizeUnhealthyInstances": true
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 30,
              "name": "aaaaaaaaaaaaaaaaaaaaaaa",
              "writeAcceleratorEnabled": true,
              "diffDiskSettings": {
                "option": "Local",
                "placement": "CacheDisk"
              },
              "osType": "Windows",
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "vhdContainers": [
                "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
              ]
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2",
              "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
              "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa",
              "id": "aaaaaaaaaa"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": true,
              "ssh": {
                "publicKeys": [
                  {
                    "path": "aaa",
                    "keyData": "aaaaaa"
                  }
                ]
              },
              "provisionVMAgent": true,
              "patchSettings": {
                "patchMode": "ImageDefault",
                "assessmentMode": "ImageDefault"
              }
            },
            "customData": "aaaaaaaaaaaaaaaaaa",
            "windowsConfiguration": {
              "provisionVMAgent": true,
              "enableAutomaticUpdates": true,
              "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "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": [
              {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "vaultCertificates": [
                  {
                    "certificateUrl": "aaaaaaa",
                    "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            ]
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        },
                        "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"
                          }
                        },
                        "privateIPAddressVersion": "IPv4",
                        "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}"
                          }
                        ]
                      },
                      "id": "aaaaaaaaaaaaaaa"
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  },
                  "enableAcceleratedNetworking": true,
                  "enableFpga": true,
                  "dnsSettings": {
                    "dnsServers": [
                      "aaaaaaaaaaaa"
                    ]
                  },
                  "enableIPForwarding": true,
                  "deleteOption": "Delete"
                },
                "id": "aa"
              }
            ],
            "healthProbe": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
            },
            "networkApiVersion": "2020-11-01"
          },
          "securityProfile": {
            "uefiSettings": {
              "secureBootEnabled": true,
              "vTpmEnabled": true
            },
            "encryptionAtHost": true,
            "securityType": "TrustedLaunch"
          },
          "diagnosticsProfile": {
            "bootDiagnostics": {
              "enabled": true,
              "storageUri": "aaaaaaaaaaaaaaaaaaa"
            }
          },
          "extensionProfile": {
            "extensions": [
              {
                "name": "aa",
                "type": "aaaaa",
                "properties": {
                  "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "publisher": "aaaaaaaaaaaaa",
                  "type": "aaaaaaaa",
                  "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "autoUpgradeMinorVersion": true,
                  "enableAutomaticUpgrade": true,
                  "settings": {},
                  "protectedSettings": {},
                  "provisioningState": "aaaaaaaaaaaaaa",
                  "provisionAfterExtensions": [
                    "aaaaaaaaaaaaaa"
                  ],
                  "suppressFailures": true
                },
                "id": "aaaaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "licenseType": "aaaa",
          "priority": "Regular",
          "evictionPolicy": "Deallocate",
          "billingProfile": {
            "maxPrice": 4
          },
          "scheduledEventsProfile": {
            "terminateNotificationProfile": {
              "notBeforeTimeout": "aa",
              "enable": true
            }
          },
          "userData": "aaaaaaaaaaaaaaaaaaaaaaaaa",
          "capacityReservation": {
            "capacityReservationGroup": {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
            }
          },
          "applicationProfile": {
            "galleryApplications": [
              {
                "tags": "aaaaaaaaaaa",
                "order": 29,
                "packageReferenceId": "aaaaaaaaaa",
                "configurationReference": "aaaaa"
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": true,
        "doNotRunExtensionsOnOverprovisionedVMs": true,
        "platformFaultDomainCount": 1,
        "automaticRepairsPolicy": {
          "enabled": true,
          "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "uniqueId": "aaaaaaaaaaaaaaaaaaaaaaa",
        "zoneBalance": true,
        "proximityPlacementGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hostGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "scaleInPolicy": {
          "rules": [
            "Default"
          ],
          "forceDeletion": true
        },
        "orchestrationMode": "Uniform",
        "spotRestorePolicy": {
          "enabled": true,
          "restoreTimeout": "aaaaaaaaaa"
        }
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "identity": {
        "principalId": "aaaaaaaaaaaaaaa",
        "tenantId": "aaaaaaaaaaaaaaaa",
        "type": "SystemAssigned",
        "userAssignedIdentities": {
          "key3951": {
            "principalId": "aaaa",
            "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      "zones": [
        "aaaaaaa"
      ],
      "extendedLocation": {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "type": "EdgeZone"
      }
    },
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {},
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": true,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": true,
            "disableAutomaticRollback": true
          },
          "rollingUpgradePolicy": {
            "maxBatchInstancePercent": 49,
            "maxUnhealthyInstancePercent": 81,
            "maxUnhealthyUpgradedInstancePercent": 98,
            "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
            "enableCrossZoneUpgrade": true,
            "prioritizeUnhealthyInstances": true
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 30,
              "name": "a",
              "writeAcceleratorEnabled": true,
              "diffDiskSettings": {
                "option": "Local",
                "placement": "CacheDisk"
              },
              "osType": "Windows",
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "vhdContainers": [
                "aaaaaaaaaaaaaaaa"
              ]
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2",
              "exactVersion": "aa",
              "sharedGalleryImageId": "aaaaaaa",
              "id": "aaa"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": true,
              "ssh": {
                "publicKeys": [
                  {
                    "path": "aaa",
                    "keyData": "aaaaaa"
                  }
                ]
              },
              "provisionVMAgent": true,
              "patchSettings": {
                "patchMode": "ImageDefault",
                "assessmentMode": "ImageDefault"
              }
            },
            "customData": "a",
            "windowsConfiguration": {
              "provisionVMAgent": true,
              "enableAutomaticUpdates": true,
              "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "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": [
              {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "vaultCertificates": [
                  {
                    "certificateUrl": "aaaaaaa",
                    "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            ]
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic1",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        },
                        "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"
                          }
                        },
                        "privateIPAddressVersion": "IPv4",
                        "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}"
                          }
                        ]
                      },
                      "id": "aaaaaaaaaaaaaaaaaaaaaaaa"
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  },
                  "enableAcceleratedNetworking": true,
                  "enableFpga": true,
                  "dnsSettings": {
                    "dnsServers": [
                      "aaaaaaaaaaaa"
                    ]
                  },
                  "enableIPForwarding": true,
                  "deleteOption": "Delete"
                },
                "id": "aaaaaaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "healthProbe": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
            },
            "networkApiVersion": "2020-11-01"
          },
          "securityProfile": {
            "uefiSettings": {
              "secureBootEnabled": true,
              "vTpmEnabled": true
            },
            "encryptionAtHost": true,
            "securityType": "TrustedLaunch"
          },
          "diagnosticsProfile": {
            "bootDiagnostics": {
              "enabled": true,
              "storageUri": "aaaaaaaaaaaaaaaaaaa"
            }
          },
          "extensionProfile": {
            "extensions": [
              {
                "name": "aa",
                "type": "aaaaa",
                "properties": {
                  "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "publisher": "aaaaaaaaaaaaa",
                  "type": "aaaaaaaa",
                  "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "autoUpgradeMinorVersion": true,
                  "enableAutomaticUpgrade": true,
                  "settings": {},
                  "protectedSettings": {},
                  "provisioningState": "aaaaaaaaaaaaaa",
                  "provisionAfterExtensions": [
                    "aaaaaaaaaaaaaa"
                  ],
                  "suppressFailures": true
                },
                "id": "aaaaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "licenseType": "aaaaaaaaaaaaaaaaaaaaaaa",
          "priority": "Regular",
          "evictionPolicy": "Deallocate",
          "billingProfile": {
            "maxPrice": 4
          },
          "scheduledEventsProfile": {
            "terminateNotificationProfile": {
              "notBeforeTimeout": "aa",
              "enable": true
            }
          },
          "userData": "aaaaaaaaaaaaaaaaaaaaaa",
          "capacityReservation": {
            "capacityReservationGroup": {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
            }
          },
          "applicationProfile": {
            "galleryApplications": [
              {
                "tags": "aaaaaaaaaaa",
                "order": 29,
                "packageReferenceId": "aaaaaaaaaa",
                "configurationReference": "aaaaa"
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": true,
        "doNotRunExtensionsOnOverprovisionedVMs": true,
        "platformFaultDomainCount": 1,
        "automaticRepairsPolicy": {
          "enabled": true,
          "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "uniqueId": "aaaaa",
        "zoneBalance": true,
        "proximityPlacementGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hostGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "scaleInPolicy": {
          "rules": [
            "Default"
          ],
          "forceDeletion": true
        },
        "orchestrationMode": "Uniform",
        "spotRestorePolicy": {
          "enabled": true,
          "restoreTimeout": "aaaaaaaaaa"
        }
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "identity": {
        "principalId": "aaaaaaaaaaaaaaa",
        "tenantId": "aaaaaaaaaaaaaaaa",
        "type": "SystemAssigned",
        "userAssignedIdentities": {
          "key3951": {
            "principalId": "aaaa",
            "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      "zones": [
        "aaaaaaaa"
      ],
      "extendedLocation": {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "type": "EdgeZone"
      }
    }
  ],
  "nextLink": "aaaaaaaaaaaaaaaaaaa"
}

VirtualMachineScaleSets_List_MinimumSet_Gen

範例要求

HTTP
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2021-11-01

範例回覆

JSON
{
  "value": [
    {
      "location": "eastus"
    },
    {
      "location": "eastus"
    }
  ]
}

定義

名稱 Description
AdditionalCapabilities

啟用或停用虛擬機或虛擬機擴展集上的功能。

AdditionalUnattendContent

指定其他 XML 格式資訊,這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 內容是藉由設定名稱、元件名稱和套用內容的傳遞來定義。

ApiEntityReference

API 實體參考。

ApiError

Api 錯誤。

ApiErrorBase

API 錯誤基底。

ApplicationProfile

包含應該提供給 VM/VMSS 的資源庫應用程式清單

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

AutomaticRepairsPolicy

指定虛擬機擴展集上自動修復的組態參數。

BillingProfile

指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。

API 版本下限:2019-03-01。

BootDiagnostics

開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

CachingTypes

取得快取類型。

CapacityReservationProfile

容量保留配置文件的參數。

CloudError

計算服務的錯誤回應。

ComponentNames

元件名稱。 目前唯一允許的值是 Microsoft-Windows-Shell-Setup。

DeleteOptions

指定刪除 VM 時網路介面會發生什麼事

DiagnosticsProfile

指定開機診斷設定狀態。

API 版本下限:2015-06-15。

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

DiffDiskPlacement

指定作業系統磁碟的暫時磁碟位置。 用戶可以在要求中使用此屬性來選擇位置,也就是快取磁碟或暫時OS磁碟布建的資源磁碟空間。 如需暫時 OS 磁碟大小需求的詳細資訊,請參閱 Windows VM 的暫時 OS 磁碟大小需求, https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 以及 Linux VM 的 https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiffDiskSettings

描述可針對操作系統磁碟指定之暫時磁碟設定的參數。

注意:暫時磁碟設定只能針對受控磁碟指定。

DiskCreateOptionTypes

指定虛擬機的建立方式。

可能的值包括:

附加 \u2013 當您使用特製化磁碟來建立虛擬機時,會使用此值。

FromImage \u2013 當您使用映射來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也會使用上述的 imageReference 元素。 如果您使用市集映射,您也會使用先前所述的 plan 元素。

DiskEncryptionSetParameters

描述可針對磁碟指定的客戶受控磁碟加密集資源標識符參數。

注意:磁碟加密集資源標識碼只能指定給受控磁碟。 如需詳細資訊,請參閱 https://aka.ms/mdssewithcmkoverview

ExtendedLocation

擴充位置的複雜類型。

ExtendedLocationTypes

擴充位置的類型。

ImageReference

指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。 注意:映像參考發行者和供應專案只能在您建立擴展集時設定。

InnerError

內部錯誤詳細數據。

IPVersion

從 Api-Version 2019-07-01 開始提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會採用為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。

LinuxConfiguration

指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單,請參閱 Azure-Endorsed 發行版上的Linux

LinuxPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補程序評估。 屬性 provisionVMAgent 必須為 true。

LinuxPatchSettings

指定與Linux上的VM客體修補相關的設定。

LinuxVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與具有 OrchestrationMode 的虛擬機擴展集相關聯的虛擬機作為彈性。

可能的值包括:

ImageDefault - 會使用虛擬機的默認修補組態。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 屬性 provisionVMAgent 必須為 true

NetworkApiVersion

指定在網路介面組態中建立網路資源時所使用的 Microsoft.Network API 版本

OperatingSystemTypes

osDiskImage 的操作系統。

OrchestrationMode

指定虛擬機擴展集的協調流程模式。

PassNames

傳遞名稱。 目前唯一允許的值是 OobeSystem。

PatchSettings

指定與 Windows 上的 VM 客體修補相關的設定。

Plan

指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站 中,尋找您想要使用的市集映射,然後按兩下 [想要以程序設計方式部署],[開始使用] -> 。 輸入任何必要資訊,然後按兩下 [ 儲存]。

ProtocolTypes

指定 WinRM 接聽程式的通訊協定。

可能的值包括:
http

https

PublicIPAddressSku

描述公用IP Sku。 它只能以 OrchestrationMode 設定為彈性。

PublicIPAddressSkuName

指定公用IP SKU 名稱

PublicIPAddressSkuTier

指定公用IP SKU層

RepairAction

修復動作的類型 (取代、重新啟動、重新映像) ,用於修復擴展集中狀況不良的虛擬機。 預設值為 replace。

ResourceIdentityType

用於虛擬機的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 將會從虛擬機中移除任何身分識別。

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

ScaleInPolicy

描述虛擬機擴展集的相應縮小原則。

ScheduledEventsProfile
securityEncryptionTypes

指定受控磁碟的 EncryptionType。
它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob,以及只加密 VMGuestState Blob 的 VMGuestStateOnly。

注意:它只能設定為機密 VM。

SecurityProfile

指定虛擬機或虛擬機擴展集的安全性配置檔設定。

SecurityTypes

指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。

默認值:除非設定此屬性,否則不會啟用 UefiSettings。

SettingNames

指定要套用內容之設定的名稱。 可能的值為:FirstLogonCommands 和 AutoLogon。

Sku

描述虛擬機擴展集 SKU。 注意:如果擴展集目前所在的硬體不支援新的 VM SKU,您必須先解除分配擴展集中的 VM,才能修改 SKU 名稱。

SpotRestorePolicy

指定虛擬機擴展集的 Spot-Try-Restore 屬性。

透過此屬性,客戶可以根據容量可用性和定價條件約束,啟用或停用收回的現成 VMSS VM 實例的自動還原。

SshConfiguration

在 Azure 上執行的 Linux 型 VM SSH 設定

SshPublicKey

包含 SSH 憑證公鑰的相關信息,以及放置公鑰之 Linux VM 上的路徑。

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。

SubResource
TerminateNotificationProfile
UefiSettings

指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

API 版本下限:2020-12-01

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值包括:

手動 - 您可以控制擴充集中虛擬機更新的應用程式。 您可以使用 manualUpgrade 宏指令來執行此動作。

自動 -擴展集中的所有虛擬機都會同時自動更新。

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

UserAssignedIdentities

與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

VaultCertificate

描述 金鑰保存庫 中的單一憑證參考,以及憑證應該位於 VM 上的位置。

VaultSecretGroup

描述一組相同 金鑰保存庫 的憑證。

VirtualHardDisk

描述磁碟的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。

針對 Azure Spot 虛擬機,同時支援「解除分配」和「刪除」,且最低 API 版本為 2019-03-01。

針對 Azure Spot 擴展集,同時支援 'Deallocate' 和 'Delete',且最低 api 版本為 2017-10-30-preview。

VirtualMachinePriorityTypes

指定虛擬機的優先順序。

API 版本下限:2019-03-01

VirtualMachineScaleSet

描述虛擬機擴展集。

VirtualMachineScaleSetDataDisk

描述虛擬機擴展集數據磁碟。

VirtualMachineScaleSetExtension

描述虛擬機擴展集擴充功能。

VirtualMachineScaleSetExtensionProfile

描述虛擬機擴展集擴充功能配置檔。

VirtualMachineScaleSetHardwareProfile

指定虛擬機擴展集的硬體設定。

VirtualMachineScaleSetIdentity

虛擬機擴展集的身分識別。

VirtualMachineScaleSetIPConfiguration

描述虛擬機擴展集網路配置檔的IP組態。

VirtualMachineScaleSetIpTag

包含與公用IP位址相關聯的IP標籤。

VirtualMachineScaleSetListResult

列出虛擬機作業回應。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 受控磁碟的參數。

VirtualMachineScaleSetNetworkConfiguration

描述虛擬機擴展集網路配置檔的網路組態。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

描述虛擬機擴展集網路設定的 DNS 設定。

VirtualMachineScaleSetNetworkProfile

描述虛擬機擴展集網路配置檔。

VirtualMachineScaleSetOSDisk

描述虛擬機擴展集作業系統磁碟。

VirtualMachineScaleSetOSProfile

描述虛擬機擴展集 OS 配置檔。

VirtualMachineScaleSetPublicIPAddressConfiguration

描述虛擬機擴展集IP組態的PublicIPAddress設定

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

描述虛擬機擴展集網路組態的 DNS 設定。

VirtualMachineScaleSetScaleInRules

調整虛擬機擴展集時所要遵循的規則。

可能的值包括:

預設 當虛擬機擴展集相應縮小時,如果擴展集是區域性擴展集,則擴展集會先跨區域平衡。 然後,它會盡可能跨容錯網域進行平衡。 在每個容錯網域內,選擇移除的虛擬機將是未受到相應縮小保護的最新虛擬機。

OldestVM 當虛擬機擴展集正在相應縮小時,將會選擇未受相應縮小保護的最舊虛擬機進行移除。 針對區域性虛擬機擴展集,擴展集會先跨區域進行平衡。 在每個區域中,將會選擇未受保護的最舊虛擬機來移除。

NewestVM 當虛擬機擴展集正在相應縮小時,將會選擇未受相應縮小保護的最新虛擬機進行移除。 針對區域性虛擬機擴展集,擴展集會先跨區域進行平衡。 在每個區域中,將會選擇未受保護的最新虛擬機來移除。

VirtualMachineScaleSetStorageProfile

描述虛擬機擴展集記憶體配置檔。

VirtualMachineScaleSetVMProfile

描述虛擬機擴展集虛擬機配置檔。

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔設定。

注意:它只能針對機密 VM 進行設定

VMGalleryApplication

指定參考計算資源庫應用程式版本的必要資訊

VMSizeProperties

指定虛擬機上的 VM 大小屬性設定。

WindowsConfiguration

指定虛擬機器上的 Windows 作業系統設定。

WindowsPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補評估。 屬性 provisionVMAgent 必須是 true。

WindowsVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與 OrchestraMode 為彈性的虛擬機擴展集相關聯的虛擬機。

可能的值包括:

手動 - 您可以控制將修補程式應用程式套用至虛擬機。 您可以在 VM 內手動套用修補程式來執行此動作。 在此模式中,自動更新會停用;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true

WinRMConfiguration

描述 VM 的 Windows 遠端管理設定

WinRMListener

描述 Windows 遠端管理接聽程式的通訊協議和指紋

AdditionalCapabilities

啟用或停用虛擬機或虛擬機擴展集上的功能。

名稱 類型 Description
hibernationEnabled

boolean

啟用或停用 VM 上休眠功能的旗標。

ultraSSDEnabled

boolean

旗標,可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。 只有在啟用此屬性時,才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。

AdditionalUnattendContent

指定其他 XML 格式資訊,這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 內容是藉由設定名稱、元件名稱和套用內容的傳遞來定義。

名稱 類型 Description
componentName

ComponentNames

元件名稱。 目前唯一允許的值是 Microsoft-Windows-Shell-Setup。

content

string

針對指定的路徑和元件,指定新增至 unattend.xml 檔案的 XML 格式內容。 XML 必須小於 4KB,而且必須包含要插入之設定或功能的根元素。

passName

PassNames

傳遞名稱。 目前唯一允許的值是 OobeSystem。

settingName

SettingNames

指定要套用內容之設定的名稱。 可能的值為:FirstLogonCommands 和 AutoLogon。

ApiEntityReference

API 實體參考。

名稱 類型 Description
id

string

/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符

ApiError

Api 錯誤。

名稱 類型 Description
code

string

錯誤碼。

details

ApiErrorBase[]

API 錯誤詳細數據

innererror

InnerError

Api 內部錯誤

message

string

錯誤訊息。

target

string

特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息。

target

string

特定錯誤的目標。

ApplicationProfile

包含應該提供給 VM/VMSS 的資源庫應用程式清單

名稱 類型 Description
galleryApplications

VMGalleryApplication[]

指定應該提供給 VM/VMSS 的資源庫應用程式

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

名稱 類型 Description
disableAutomaticRollback

boolean

是否應該停用OS映像復原功能。 預設值為 False。

enableAutomaticOSUpgrade

boolean

指出當較新版本的OS映像可供使用時,是否應該以滾動方式將操作系統升級自動套用至擴展集實例。 預設值為 False。

如果 Windows 擴展集將此設定為 true,enableAutomaticUpdates 會自動設定為 false,且無法設定為 true。

AutomaticRepairsPolicy

指定虛擬機擴展集上自動修復的組態參數。

名稱 類型 Description
enabled

boolean

指定是否應在虛擬機擴展集上啟用自動修復。 預設值為 false。

gracePeriod

string

因為 VM 上的狀態變更而暫停自動修復的時間量。 寬限時間會在狀態變更完成之後開始。 這有助於避免提前或意外修復。 時間持續時間應以 ISO 8601 格式指定。 允許的寬限期下限為 10 分鐘, (PT10M) ,這也是預設值。 允許的寬限期上限為 90 分鐘, (PT90M) 。

repairAction

RepairAction

修復動作類型 (取代、重新啟動、重新安裝映像) ,用於修復擴展集中狀況不良的虛擬機。 預設值為 replace。

BillingProfile

指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。

API 版本下限:2019-03-01。

名稱 類型 Description
maxPrice

number

指定您願意支付 Azure Spot VM/VMSS 的最大價格。 此價格以美元為單位。

此價格將會與 VM 大小的目前 Azure Spot 價格進行比較。 此外,價格會在建立/更新 Azure Spot VM/VMSS 時進行比較,而且只有在 maxPrice 大於目前的 Azure Spot 價格時,作業才會成功。

如果目前的 Azure Spot 價格超出建立 VM/VMSS 之後的 maxPrice,maxPrice 也會用於收回 Azure Spot VM/VMSS。

可能的值包括:

- 任何大於零的十進位值。 範例:0.01538

-1 – 表示預設價格為隨選。

您可以將 maxPrice 設定為 -1,以指出基於價格考慮,不應收回 Azure Spot VM/VMSS。 此外,如果默認價格不是由您提供,則為 -1。

API 版本下限:2019-03-01。

BootDiagnostics

開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

名稱 類型 Description
enabled

boolean

虛擬機上是否應該啟用開機診斷。

storageUri

string

用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。

如果在啟用開機診斷時未指定 storageUri,則會使用受控記憶體。

CachingTypes

取得快取類型。

名稱 類型 Description
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

容量保留配置文件的參數。

名稱 類型 Description
capacityReservationGroup

SubResource

指定容量保留群組資源標識符,此標識元應該用於配置虛擬機或擴展集 VM 實例,前提是已保留足夠的容量。 如需詳細資訊, https://aka.ms/CapacityReservation 請參閱 。

CloudError

計算服務的錯誤回應。

名稱 類型 Description
error

ApiError

Api 錯誤。

ComponentNames

元件名稱。 目前唯一允許的值是 Microsoft-Windows-Shell-Setup。

名稱 類型 Description
Microsoft-Windows-Shell-Setup

string

DeleteOptions

指定刪除 VM 時網路介面會發生什麼事

名稱 類型 Description
Delete

string

Detach

string

DiagnosticsProfile

指定開機診斷設定狀態。

API 版本下限:2015-06-15。

名稱 類型 Description
bootDiagnostics

BootDiagnostics

開機診斷是一項偵錯功能,可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。
注意:如果指定 storageUri,請確定記憶體帳戶位於與 VM 相同的區域和訂用帳戶中。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

名稱 類型 Description
Local

string

DiffDiskPlacement

指定作業系統磁碟的暫時磁碟位置。 用戶可以在要求中使用此屬性來選擇位置,也就是快取磁碟或暫時OS磁碟布建的資源磁碟空間。 如需暫時 OS 磁碟大小需求的詳細資訊,請參閱 Windows VM 的暫時 OS 磁碟大小需求, https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 以及 Linux VM 的 https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

名稱 類型 Description
CacheDisk

string

ResourceDisk

string

DiffDiskSettings

描述可針對操作系統磁碟指定之暫時磁碟設定的參數。

注意:暫時磁碟設定只能針對受控磁碟指定。

名稱 類型 Description
option

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

placement

DiffDiskPlacement

指定作業系統磁碟的暫時磁碟位置。

可能的值包括:

CacheDisk

ResourceDisk

默認值:如果已針對 VM 大小設定 快取Disk ,否則會使用 ResourceDisk

請參閱 位於 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。

DiskCreateOptionTypes

指定虛擬機的建立方式。

可能的值包括:

附加 \u2013 當您使用特製化磁碟來建立虛擬機時,會使用此值。

FromImage \u2013 當您使用映射來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也會使用上述的 imageReference 元素。 如果您使用市集映射,您也會使用先前所述的 plan 元素。

名稱 類型 Description
Attach

string

Empty

string

FromImage

string

DiskEncryptionSetParameters

描述可針對磁碟指定的客戶受控磁碟加密集資源標識符參數。

注意:磁碟加密集資源標識碼只能指定給受控磁碟。 如需詳細資訊,請參閱 https://aka.ms/mdssewithcmkoverview

名稱 類型 Description
id

string

資源標識碼

ExtendedLocation

擴充位置的複雜類型。

名稱 類型 Description
name

string

擴充位置的名稱。

type

ExtendedLocationTypes

擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱 類型 Description
EdgeZone

string

ImageReference

指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。 注意:映像參考發行者和供應專案只能在您建立擴展集時設定。

名稱 類型 Description
communityGalleryImageId

string

指定 vm 部署的社群資源庫映像唯一標識碼。 這可以從社群資源庫映像 GET 呼叫擷取。

exactVersion

string

以十進位數指定,也就是用來建立虛擬機的平臺映像或市集映射版本。 這個只讀欄位與 'version' 不同,只有在 'version' 字段中指定的值是 'latest'時。

id

string

資源標識碼

offer

string

指定用來建立虛擬機的平臺映像或 Marketplace 映像供應專案。

publisher

string

映像發行者。

sharedGalleryImageId

string

指定 VM 部署的共享資源庫映像唯一識別碼。 這可以從共用資源庫映像 GET 呼叫擷取。

sku

string

映像 SKU。

version

string

指定用來建立虛擬機的平臺映像或 Marketplace 映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建是十進位數。 指定「最新」以使用部署階段可用的最新映像版本。 即使您使用「最新」,即使有新版本可供使用,VM 映像也不會在部署時間之後自動更新。 請勿針對資源庫映射部署使用字段 'version',資源庫映射應該一律使用 'id' 字段進行部署,若要使用資源庫映射的 'latest' 版本,只要設定 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}' 字段,就不需要輸入版本。

InnerError

內部錯誤詳細數據。

名稱 類型 Description
errordetail

string

內部錯誤訊息或例外狀況傾印。

exceptiontype

string

例外狀況型別。

IPVersion

從 Api-Version 2019-07-01 開始提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會採用為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。

名稱 類型 Description
IPv4

string

IPv6

string

LinuxConfiguration

指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單,請參閱 Azure-Endorsed 發行版上的Linux

名稱 類型 Description
disablePasswordAuthentication

boolean

指定是否應該停用密碼驗證。

patchSettings

LinuxPatchSettings

[預覽功能]指定與Linux上的VM客體修補相關的設定。

provisionVMAgent

boolean

指出是否應該在虛擬機器上佈建虛擬機器代理程式。

當要求本文中未指定這個屬性時,預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上,以便稍後將擴充功能新增至 VM。

ssh

SshConfiguration

指定 Linux OS 的 SSH 金鑰組態。

LinuxPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補程序評估。 屬性 provisionVMAgent 必須為 true。

名稱 類型 Description
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

指定與Linux上的VM客體修補相關的設定。

名稱 類型 Description
assessmentMode

LinuxPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補評估。 屬性 provisionVMAgent 必須是 true。

patchMode

LinuxVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與 OrchestraMode 為彈性的虛擬機擴展集相關聯的虛擬機。

可能的值包括:

ImageDefault - 會使用虛擬機的默認修補組態。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 provisionVMAgent 屬性必須是 true

LinuxVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與具有 OrchestrationMode 的虛擬機擴展集相關聯的虛擬機作為彈性。

可能的值包括:

ImageDefault - 會使用虛擬機的默認修補組態。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 屬性 provisionVMAgent 必須為 true

名稱 類型 Description
AutomaticByPlatform

string

ImageDefault

string

NetworkApiVersion

指定在網路介面組態中建立網路資源時所使用的 Microsoft.Network API 版本

名稱 類型 Description
2020-11-01

string

OperatingSystemTypes

osDiskImage 的操作系統。

名稱 類型 Description
Linux

string

Windows

string

OrchestrationMode

指定虛擬機擴展集的協調流程模式。

名稱 類型 Description
Flexible

string

Uniform

string

PassNames

傳遞名稱。 目前唯一允許的值是 OobeSystem。

名稱 類型 Description
OobeSystem

string

PatchSettings

指定與 Windows 上的 VM 客體修補相關的設定。

名稱 類型 Description
assessmentMode

WindowsPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補評估。 屬性 provisionVMAgent 必須是 true。

enableHotpatching

boolean

可讓客戶修補其 Azure VM,而不需要重新啟動。 針對 enableHotpatching,'provisionVMAgent' 必須設定為 true,而且 'patchMode' 必須設定為 'AutomaticByPlatform'。

patchMode

WindowsVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與 OrchestraMode 為彈性的虛擬機擴展集相關聯的虛擬機。

可能的值包括:

手動 - 您可以控制將修補程式應用程式套用至虛擬機。 您可以在 VM 內手動套用修補程式來執行此動作。 在此模式中,自動更新會停用;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true

Plan

指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站 中,尋找您想要使用的市集映射,然後按兩下 [想要以程序設計方式部署],[開始使用] -> 。 輸入任何必要資訊,然後按兩下 [ 儲存]。

名稱 類型 Description
name

string

方案標識碼。

product

string

指定市集中映像的產品。 這個值與 imageReference 元素下的 Offer 相同。

promotionCode

string

促銷碼。

publisher

string

發行者標識碼。

ProtocolTypes

指定 WinRM 接聽程式的通訊協定。

可能的值包括:
http

https

名稱 類型 Description
Http

string

Https

string

PublicIPAddressSku

描述公用IP Sku。 它只能以 OrchestrationMode 設定為彈性。

名稱 類型 Description
name

PublicIPAddressSkuName

指定公用IP SKU 名稱

tier

PublicIPAddressSkuTier

指定公用IP SKU層

PublicIPAddressSkuName

指定公用IP SKU 名稱

名稱 類型 Description
Basic

string

Standard

string

PublicIPAddressSkuTier

指定公用IP SKU層

名稱 類型 Description
Global

string

Regional

string

RepairAction

修復動作的類型 (取代、重新啟動、重新映像) ,用於修復擴展集中狀況不良的虛擬機。 預設值為 replace。

名稱 類型 Description
Reimage

string

Replace

string

Restart

string

ResourceIdentityType

用於虛擬機的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 將會從虛擬機中移除任何身分識別。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

名稱 類型 Description
enableCrossZoneUpgrade

boolean

允許 VMSS 在建構升級批次時忽略 AZ 界限。 將 Update 網域和 maxBatchInstancePercent 納入考慮,以判斷批次大小。

maxBatchInstancePercent

integer

一個批次中的滾動升級會同時升級的虛擬機實例總數百分比上限。 由於這是最大值,先前或未來批次中狀況不良的實例可能會導致批次中的實例百分比降低,以確保更高的可靠性。 此參數的預設值為 20%。

maxUnhealthyInstancePercent

integer

擴展集中可同時狀況不良之虛擬機實例總數的百分比上限,可能是因為升級而發生,或是在滾動升級中止之前,虛擬機健康情況檢查處於狀況不良狀態。 啟動任何批次之前,將會先檢查此條件約束。 此參數的預設值為 20%。

maxUnhealthyUpgradedInstancePercent

integer

已升級的虛擬機實例百分比上限,這些實例可能處於狀況不良狀態。 升級每個批次之後,就會進行這項檢查。 如果超過此百分比,滾動更新就會中止。 此參數的預設值為 20%。

pauseTimeBetweenBatches

string

在一個批次中完成所有虛擬機的更新,以及啟動下一個批次之間的等候時間。 時間持續時間應以 ISO 8601 格式指定。 默認值為 0 秒, (PT0S) 。

prioritizeUnhealthyInstances

boolean

在任何狀況良好的實例之前,升級擴展集中所有狀況不良的實例。

ScaleInPolicy

描述虛擬機擴展集的相應縮小原則。

名稱 類型 Description
forceDeletion

boolean

此屬性可讓您指定當虛擬機擴展集正在相應縮小時,是否必須強制刪除選擇移除的虛擬機。 (Preview 中的功能)

rules

VirtualMachineScaleSetScaleInRules[]

調整虛擬機擴展集時要遵循的規則。

可能的值包括:

預設 當虛擬機擴展集相應縮小時,如果擴展集是區域性擴展集,則擴展集會先跨區域平衡。 然後,它將會盡可能跨容錯網域進行平衡。 在每個容錯網域內,選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。

OldestVM 當虛擬機擴展集進行相應縮小時,將會選擇未受相應縮小保護的最舊虛擬機進行移除。 針對區域性虛擬機擴展集,擴展集會先跨區域平衡。 在每個區域內,將會選擇未受保護的最舊虛擬機來移除。

NewestVM 當虛擬機擴展集正在相應縮小時,系統會選擇未受相應縮小保護的最新虛擬機,以移除。 針對區域性虛擬機擴展集,擴展集會先跨區域平衡。 在每個區域中,將會選擇未受保護的最新虛擬機來移除。

ScheduledEventsProfile

名稱 類型 Description
terminateNotificationProfile

TerminateNotificationProfile

指定終止排程事件相關組態。

securityEncryptionTypes

指定受控磁碟的 EncryptionType。
它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob,以及只加密 VMGuestState Blob 的 VMGuestStateOnly。

注意:它只能設定為機密 VM。

名稱 類型 Description
DiskWithVMGuestState

string

VMGuestStateOnly

string

SecurityProfile

指定虛擬機或虛擬機擴展集的安全性配置檔設定。

名稱 類型 Description
encryptionAtHost

boolean

這個屬性可由要求中的使用者用來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密,包括主機本身的資源/暫存磁碟。

默認值:除非資源的此屬性設定為 true,否則將會停用主機上的加密。

securityType

SecurityTypes

指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。

默認值:除非設定此屬性,否則不會啟用 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

Sku

描述虛擬機擴展集 SKU。 注意:如果擴展集目前所在的硬體不支援新的 VM SKU,您必須先解除分配擴展集中的 VM,才能修改 SKU 名稱。

名稱 類型 Description
capacity

integer

指定擴展集中的虛擬機數目。

name

string

SKU 名稱。

tier

string

指定擴展集中的虛擬機層。

可能的值如下:

標準

基本

SpotRestorePolicy

指定虛擬機擴展集的 Spot-Try-Restore 屬性。

透過此屬性,客戶可以根據容量可用性和定價條件約束,啟用或停用收回的現成 VMSS VM 實例的自動還原。

名稱 類型 Description
enabled

boolean

啟用 Spot-Try-Restore 功能,其中收回的 VMSS SPOT 實例將會根據容量可用性和定價條件約束,以機率方式還原

restoreTimeout

string

以 ISO 8601 時間持續時間表示的逾時值,之後平臺將不會嘗試還原 VMSS SPOT 實例

SshConfiguration

在 Azure 上執行的 Linux 型 VM SSH 設定

名稱 類型 Description
publicKeys

SshPublicKey[]

用來向Linux型VM進行驗證的SSH公鑰清單。

SshPublicKey

包含 SSH 憑證公鑰的相關信息,以及放置公鑰之 Linux VM 上的路徑。

名稱 類型 Description
keyData

string

用來透過 ssh 向 VM 進行驗證的 SSH 公鑰憑證。 密鑰至少必須是 2048 位,且格式為 ssh-rsa。

如需建立 SSH 金鑰,請參閱 在 Linux 和 Mac 上為 Azure 中的 Linux VM 建立 SSH 金鑰

path

string

指定儲存 ssh 公鑰之已建立 VM 上的完整路徑。 如果檔案已經存在,指定的金鑰就會附加至該檔案。 範例:/home/user/.ssh/authorized_keys

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。

名稱 類型 Description
Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

名稱 類型 Description
id

string

資源標識碼

TerminateNotificationProfile

名稱 類型 Description
enable

boolean

指定是否啟用或停用 Terminate Scheduled 事件。

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

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值包括:

手動 - 您可以控制擴充集中虛擬機更新的應用程式。 您可以使用 manualUpgrade 宏指令來執行此動作。

自動 -擴展集中的所有虛擬機都會同時自動更新。

名稱 類型 Description
Automatic

string

Manual

string

Rolling

string

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

名稱 類型 Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

mode

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值包括:

手動 - 您可以控制擴充集中虛擬機更新的應用程式。 您可以使用 manualUpgrade 動作來執行此動作。

自動 -擴展集中的所有虛擬機都會同時自動更新。

rollingUpgradePolicy

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

UserAssignedIdentities

與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱 類型 Description

VaultCertificate

描述 金鑰保存庫 中的單一憑證參考,以及憑證應該位於 VM 上的位置。

名稱 類型 Description
certificateStore

string

針對 Windows VM,指定應該新增憑證之虛擬機上的證書存儲。 指定的證書存儲隱含地位於LocalMachine帳戶中。

針對Linux VM,憑證檔案會放在 /var/lib/waagent 目錄底下,而 X509 憑證檔案的檔名<為 UppercaseThumbprint.crt,而<私鑰則為 UppercaseThumbprint.prv>>。 這兩個檔案都是 .pem 格式。

certificateUrl

string

這是已上傳至 金鑰保存庫 做為秘密的憑證 URL。 如需將秘密新增至 金鑰保存庫,請參閱將密鑰或秘密新增至密鑰保存庫。 在此情況下,您的憑證必須是下列 JSON 物件的 Base64 編碼,其編碼方式為 UTF-8:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虛擬機上安裝憑證,建議使用適用於Linux的 Azure 金鑰保存庫 虛擬機擴充功能適用於Windows的 Azure 金鑰保存庫 虛擬機擴充功能

VaultSecretGroup

描述一組相同 金鑰保存庫 的憑證。

名稱 類型 Description
sourceVault

SubResource

包含 VaultCertificates 中所有憑證之 金鑰保存庫 的相對 URL。

vaultCertificates

VaultCertificate[]

SourceVault 中包含憑證的金鑰保存庫參考清單。

VirtualHardDisk

描述磁碟的 URI。

名稱 類型 Description
uri

string

指定虛擬硬碟的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。

針對 Azure Spot 虛擬機,同時支援「解除分配」和「刪除」,且最低 API 版本為 2019-03-01。

針對 Azure Spot 擴展集,同時支援 'Deallocate' 和 'Delete',且最低 api 版本為 2017-10-30-preview。

名稱 類型 Description
Deallocate

string

Delete

string

VirtualMachinePriorityTypes

指定虛擬機的優先順序。

API 版本下限:2019-03-01

名稱 類型 Description
Low

string

Regular

string

Spot

string

VirtualMachineScaleSet

描述虛擬機擴展集。

名稱 類型 Description
extendedLocation

ExtendedLocation

虛擬機擴展集的擴充位置。

id

string

資源標識碼

identity

VirtualMachineScaleSetIdentity

如果已設定,則為虛擬機擴展集的身分識別。

location

string

資源位置

name

string

資源名稱

plan

Plan

指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站 中,尋找您想要使用的市集映射,然後按兩下 [想要以程序設計方式部署],[開始使用] -> 。 輸入任何必要資訊,然後按兩下 [ 儲存]。

properties.additionalCapabilities

AdditionalCapabilities

指定虛擬機擴展集中 虛擬機器 上啟用或停用的其他功能。 例如:虛擬機器 是否能夠支援使用 UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。

properties.automaticRepairsPolicy

AutomaticRepairsPolicy

自動修復的原則。

properties.doNotRunExtensionsOnOverprovisionedVMs

boolean

啟用 Overprovision 時,擴充功能只會在最後保留的要求 VM 數目上啟動。 因此,此屬性可確保擴充功能不會在額外的過度布建 VM 上執行。

properties.hostGroup

SubResource

指定虛擬機擴展集所在專用主機群組的相關信息。

API 版本下限:2020-06-01。

properties.orchestrationMode

OrchestrationMode

指定虛擬機擴展集的協調流程模式。

properties.overprovision

boolean

指定是否應該過度布建虛擬機擴展集。

properties.platformFaultDomainCount

integer

每個放置群組的容錯網域計數。

properties.provisioningState

string

布建狀態,只會出現在回應中。

properties.proximityPlacementGroup

SubResource

指定虛擬機擴展集應指派的鄰近放置群組相關信息。

API 版本下限:2018-04-01。

properties.scaleInPolicy

ScaleInPolicy

指定在虛擬機擴展集中調整 虛擬機器 時所套用的原則。

properties.singlePlacementGroup

boolean

若為 true,則會將擴展集限制為單一放置群組,大小上限為 100 部虛擬機。 注意:如果 singlePlacementGroup 為 true,它可能會修改為 false。 不過,如果 singlePlacementGroup 為 false,則無法修改成 true。

properties.spotRestorePolicy

SpotRestorePolicy

指定虛擬機擴展集的Spot Restore 屬性。

properties.timeCreated

string

指定虛擬機擴展集資源建立的時間。

API 版本下限:2021-11-01。

properties.uniqueId

string

指定可唯一識別虛擬機擴展集的標識碼。

properties.upgradePolicy

UpgradePolicy

升級原則。

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

虛擬機器配置檔。

properties.zoneBalance

boolean

如果發生區域中斷,是否要強制甚至跨 x 區域的虛擬機散發。 只有在擴展集的區域屬性包含多個區域時,才能設定 zoneBalance 屬性。 如果沒有指定區域或只指定一個區域,不應設定 zoneBalance 屬性。

sku

Sku

虛擬機擴展集 SKU。

tags

object

資源標籤

type

string

資源類型

zones

string[]

虛擬機擴展集區域。 注意:只有在建立擴展集時,才能設定可用性區域

VirtualMachineScaleSetDataDisk

描述虛擬機擴展集數據磁碟。

名稱 類型 Description
caching

CachingTypes

指定快取需求。

可能的值包括:



ReadOnly

讀寫

預設值: 標準記憶體無。進階記憶體的 ReadOnly

createOption

DiskCreateOptionTypes

建立選項。

diskIOPSReadWrite

integer

指定受控磁碟的 Read-Write IOPS。 只有當 StorageAccountType UltraSSD_LRS時,才應該使用。 如果未指定,則會根據diskSizeGB指派預設值。

diskMBpsReadWrite

integer

指定受控磁碟每秒 MB 的頻寬。 只有當 StorageAccountType UltraSSD_LRS時,才應該使用。 如果未指定,則會根據diskSizeGB指派預設值。

diskSizeGB

integer

指定以 GB 為單位的空白資料磁碟大小。 此元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB

lun

integer

指定數據磁碟的邏輯單位編號。 此值是用來識別 VM 內的數據磁碟,因此對於連結至 VM 的每個數據磁碟而言,都必須是唯一的。

managedDisk

VirtualMachineScaleSetManagedDiskParameters

受控磁碟參數。

name

string

磁碟名稱。

writeAcceleratorEnabled

boolean

指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetExtension

描述虛擬機擴展集擴充功能。

名稱 類型 Description
id

string

資源標識碼

name

string

延伸模組的名稱。

properties.autoUpgradeMinorVersion

boolean

指出擴充功能是否應該在部署時間使用較新的次要版本。 不過,部署之後,除非重新部署延伸模組,否則延伸模組將不會升級次要版本,即使此屬性設定為 true 亦然。

properties.enableAutomaticUpgrade

boolean

指出如果有較新版本的擴充功能可用,平臺是否應該自動升級延伸模組。

properties.forceUpdateTag

string

如果提供值且與先前的值不同,即使延伸模組組態尚未變更,延伸模塊處理程式仍會強制更新。

properties.protectedSettings

object

此延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。

properties.protectedSettingsFromKeyVault

object

以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用的擴充功能

properties.provisionAfterExtensions

string[]

延伸模組名稱的集合,之後必須布建此延伸模組。

properties.provisioningState

string

布建狀態,只會出現在回應中。

properties.publisher

string

擴充處理程序發行者的名稱。

properties.settings

object

擴充功能的 Json 格式化公用設定。

properties.suppressFailures

boolean

指出延伸模組的失敗是否會隱藏 (作業失敗,例如不會連線到 VM,而不論此值) 為何。 預設值為 false。

properties.type

string

指定延伸模組的類型;範例為 「CustomScriptExtension」。。

properties.typeHandlerVersion

string

指定文稿處理程式的版本。

type

string

資源類型

VirtualMachineScaleSetExtensionProfile

描述虛擬機擴展集擴充功能配置檔。

名稱 類型 Description
extensions

VirtualMachineScaleSetExtension[]

虛擬機擴展集子擴充功能資源。

extensionsTimeBudget

string

指定要啟動之所有延伸模組的加註時間。 持續時間應介於 15 分鐘到 120 分鐘之間, (內含) ,且應以 ISO 8601 格式指定。 預設值為90分鐘 (PT1H30M) 。

API 版本下限:2020-06-01

VirtualMachineScaleSetHardwareProfile

指定虛擬機擴展集的硬體設定。

名稱 類型 Description
vmSizeProperties

VMSizeProperties

指定自定義虛擬機大小的屬性。 API 版本下限:2021-11-01。

如需詳細資訊,請遵循 VM 自定義 中的指示。

VirtualMachineScaleSetIdentity

虛擬機擴展集的身分識別。

名稱 類型 Description
principalId

string

虛擬機擴展集身分識別的主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string

與虛擬機擴展集相關聯的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ResourceIdentityType

用於虛擬機擴展集的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 會從虛擬機擴展集移除任何身分識別。

userAssignedIdentities

UserAssignedIdentities

與虛擬機擴展集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

VirtualMachineScaleSetIPConfiguration

描述虛擬機擴展集網路配置檔的IP組態。

名稱 類型 Description
id

string

資源標識碼

name

string

IP 組態名稱。

properties.applicationGatewayBackendAddressPools

SubResource[]

指定應用程式閘道後端位址池的參考數位。 擴展集可以參考多個應用程式閘道的後端位址池。 多個擴展集無法使用相同的應用程式閘道。

properties.applicationSecurityGroups

SubResource[]

指定應用程式安全組的參考陣列。

properties.loadBalancerBackendAddressPools

SubResource[]

指定負載平衡器後端位址池參考的陣列。 擴展集可以參考一個公用和一個內部負載平衡器的後端位址池。 多個擴展集無法使用相同的基本 SKU 負載平衡器。

properties.loadBalancerInboundNatPools

SubResource[]

指定負載平衡器輸入 Nat 集區的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的輸入 nat 集區。 多個擴展集無法使用相同的基本 SKU 負載平衡器。

properties.primary

boolean

指定虛擬機有1個以上的網路介面時的主要網路介面。

properties.privateIPAddressVersion

IPVersion

從 Api-Version 2017-03-30 起提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

publicIPAddressConfiguration。

properties.subnet

ApiEntityReference

指定子網的識別碼。

VirtualMachineScaleSetIpTag

包含與公用IP位址相關聯的IP標籤。

名稱 類型 Description
ipTagType

string

IP 標籤類型。 範例:FirstPartyUsage。

tag

string

與公用IP相關聯的IP標籤。 範例:SQL、記憶體等。

VirtualMachineScaleSetListResult

列出虛擬機作業回應。

名稱 類型 Description
nextLink

string

要擷取下一頁的 uri 虛擬機器擴展集。 使用此呼叫 ListNext () 以擷取 VMSS 的下一頁。

value

VirtualMachineScaleSet[]

虛擬機擴展集的清單。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 受控磁碟的參數。

名稱 類型 Description
diskEncryptionSet

DiskEncryptionSetParameters

指定受控磁碟的客戶受控磁碟加密集資源標識符。

securityProfile

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔。

storageAccountType

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,它不能與OS磁碟搭配使用。

VirtualMachineScaleSetNetworkConfiguration

描述虛擬機擴展集網路配置檔的網路組態。

名稱 類型 Description
id

string

資源標識碼

name

string

網路組態名稱。

properties.deleteOption

DeleteOptions

指定刪除 VM 時網路介面會發生什麼事

properties.dnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings

要套用在網路介面上的 DNS 設定。

properties.enableAcceleratedNetworking

boolean

指定網路介面是否已啟用加速網路功能。

properties.enableFpga

boolean

指定網路介面是否已啟用 FPGA 網路功能。

properties.enableIPForwarding

boolean

是否在此 NIC 上啟用 IP 轉送。

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

指定網路介面的IP組態。

properties.networkSecurityGroup

SubResource

網路安全組。

properties.primary

boolean

指定虛擬機有1個以上的網路介面時的主要網路介面。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

描述虛擬機擴展集網路設定的 DNS 設定。

名稱 類型 Description
dnsServers

string[]

DNS 伺服器 IP 位址清單

VirtualMachineScaleSetNetworkProfile

描述虛擬機擴展集網路配置檔。

名稱 類型 Description
healthProbe

ApiEntityReference

負載平衡器探查的參考,用來判斷虛擬機擴展集中實例的健康情況。 參考的格式為:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'。

networkApiVersion

NetworkApiVersion

指定在具有協調流程模式 「彈性」的虛擬機擴展集網路介面設定中建立網路資源時所使用的 Microsoft.Network API 版本

networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

網路組態的清單。

VirtualMachineScaleSetOSDisk

描述虛擬機擴展集作業系統磁碟。

名稱 類型 Description
caching

CachingTypes

指定快取需求。

可能的值包括:



ReadOnly

讀寫

預設值: 標準記憶體無。進階記憶體的 ReadOnly

createOption

DiskCreateOptionTypes

指定應該如何建立擴展集中的虛擬機。

唯一允許的值是: FromImage \u2013 當您使用映像來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也會使用上述的 imageReference 元素。 如果您使用市集映射,您也會使用先前所述的 plan 元素。

diffDiskSettings

DiffDiskSettings

指定虛擬機擴展集所使用作業系統磁碟的暫時磁碟設定。

diskSizeGB

integer

指定以 GB 為單位的作業系統磁碟大小。 此元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB

image

VirtualHardDisk

指定要根據擴展集的 Unmanaged 使用者映像相關信息。

managedDisk

VirtualMachineScaleSetManagedDiskParameters

受控磁碟參數。

name

string

磁碟名稱。

osType

OperatingSystemTypes

此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時,磁碟包含的 OS 類型。

可能的值包括:

Windows

Linux

vhdContainers

string[]

指定用來儲存擴展集作業系統磁碟的容器 URL。

writeAcceleratorEnabled

boolean

指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetOSProfile

描述虛擬機擴展集 OS 配置檔。

名稱 類型 Description
adminPassword

string

指定系統管理員帳戶的密碼。

Windows) 長度下限 (: 8 個字元

Linux) 長度下限 (: 6 個字元

Windows) 長度上限 (: 123 個字元

Linux) 長度上限 (: 72 個字元

複雜度需求: 需要滿足下列 4 個條件中的 3 個
字元較低
具有大字元
具有數位
具有特殊字元 (Regex 比對 [\W_])

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

如需重設密碼,請參閱 如何在 Windows VM 中重設遠端桌面服務或其登入密碼

如需重設根密碼,請參閱 使用 VMAccess 擴充功能管理使用者、SSH 及檢查或修復 Azure Linux VM 上的磁碟

adminUsername

string

指定系統管理員帳戶的名稱。

僅限 Windows 的限制: 不能以 “.

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

Linux () 長度下限: 1 個字元

Linux) 長度上限 (: 64 個字元

Windows) 最大長度 (: 20 個字元

allowExtensionOperations

boolean

指定是否應該在虛擬機擴展集上允許擴充功能作業。

只有在虛擬機擴展集上沒有擴充功能時,才能將此設定為 False。

computerNamePrefix

string

指定擴展集中所有虛擬機的計算機名稱前置詞。 計算機名稱前置詞長度必須為1到15個字元。

customData

string

指定自訂資料的 Base-64 編碼字串。 Base-64 編碼字串會解碼成二進位陣列而儲存為虛擬機器上的檔案。 二進位陣列的長度上限是 65535 個位元組。

如需針對 VM 使用 cloud-init,請參閱在建立期間使用 cloud-init 自定義 Linux VM

linuxConfiguration

LinuxConfiguration

指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單,請參閱 Azure-Endorsed 發行版上的Linux

secrets

VaultSecretGroup[]

指定應該安裝在擴展集中虛擬機上的憑證集。 若要在虛擬機上安裝憑證,建議使用適用於Linux的 Azure 金鑰保存庫 虛擬機擴充功能適用於Windows的 Azure 金鑰保存庫 虛擬機擴充功能

windowsConfiguration

WindowsConfiguration

指定虛擬機器上的 Windows 作業系統設定。

VirtualMachineScaleSetPublicIPAddressConfiguration

描述虛擬機擴展集IP組態的PublicIPAddress設定

名稱 類型 Description
name

string

publicIP 位址組態名稱。

properties.deleteOption

DeleteOptions

指定刪除 VM 時公用 IP 會發生什麼事

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

要套用在 publicIP 位址 上的 DNS 設定。

properties.idleTimeoutInMinutes

integer

公用IP位址的閒置逾時。

properties.ipTags

VirtualMachineScaleSetIpTag[]

與公用IP位址相關聯的IP標籤清單。

properties.publicIPAddressVersion

IPVersion

從 Api-Version 2019-07-01 開始提供,它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會採用為 IPv4。 可能的值為:'IPv4' 和 'IPv6'。

properties.publicIPPrefix

SubResource

要從中配置 publicIP 位址的 PublicIPPrefix。

sku

PublicIPAddressSku

描述公用IP Sku。 它只能以 OrchestrationMode 設定為彈性。

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

描述虛擬機擴展集網路組態的 DNS 設定。

名稱 類型 Description
domainNameLabel

string

功能變數名稱標籤。功能變數名稱標籤和 VM 索引的串連將會是將建立之 PublicIPAddress 資源的功能變數名稱標籤

VirtualMachineScaleSetScaleInRules

調整虛擬機擴展集時所要遵循的規則。

可能的值包括:

預設 當虛擬機擴展集相應縮小時,如果擴展集是區域性擴展集,則擴展集會先跨區域平衡。 然後,它會盡可能跨容錯網域進行平衡。 在每個容錯網域內,選擇移除的虛擬機將是未受到相應縮小保護的最新虛擬機。

OldestVM 當虛擬機擴展集正在相應縮小時,將會選擇未受相應縮小保護的最舊虛擬機進行移除。 針對區域性虛擬機擴展集,擴展集會先跨區域進行平衡。 在每個區域中,將會選擇未受保護的最舊虛擬機來移除。

NewestVM 當虛擬機擴展集正在相應縮小時,將會選擇未受相應縮小保護的最新虛擬機進行移除。 針對區域性虛擬機擴展集,擴展集會先跨區域進行平衡。 在每個區域中,將會選擇未受保護的最新虛擬機來移除。

名稱 類型 Description
Default

string

NewestVM

string

OldestVM

string

VirtualMachineScaleSetStorageProfile

描述虛擬機擴展集記憶體配置檔。

名稱 類型 Description
dataDisks

VirtualMachineScaleSetDataDisk[]

指定參數,用來將數據磁碟新增至擴展集中的虛擬機。

如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD

imageReference

ImageReference

指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。

osDisk

VirtualMachineScaleSetOSDisk

指定擴展集中虛擬機所使用的操作系統磁碟相關信息。

如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD

VirtualMachineScaleSetVMProfile

描述虛擬機擴展集虛擬機配置檔。

名稱 類型 Description
applicationProfile

ApplicationProfile

指定應該提供給 VM/VMSS 使用的資源庫應用程式

billingProfile

BillingProfile

指定 Azure Spot VMSS 的計費相關詳細數據。

API 版本下限:2019-03-01。

capacityReservation

CapacityReservationProfile

指定擴展集的容量保留相關詳細數據。

API 版本下限:2021-04-01。

diagnosticsProfile

DiagnosticsProfile

指定開機診斷設定狀態。

API 版本下限:2015-06-15。

evictionPolicy

VirtualMachineEvictionPolicyTypes

指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。

針對 Azure Spot 虛擬機,支援「解除分配」和「刪除」,而最低 API 版本為 2019-03-01。

針對 Azure Spot 擴展集,同時支援 'Deallocate' 和 'Delete',而最低 API 版本為 2017-10-30-preview。

extensionProfile

VirtualMachineScaleSetExtensionProfile

指定擴展集中虛擬機上安裝之延伸模組的設定集合。

hardwareProfile

VirtualMachineScaleSetHardwareProfile

指定擴展集的硬體配置檔相關詳細數據。

最低 api-version:2021-11-01。

licenseType

string

指定正在使用的映像或磁碟是在內部部署授權。

Windows Server 操作系統的可能值為:

Windows_Client

Windows_Server

Linux Server 操作系統的可能值為:

RHEL) 的RHEL_BYOS (

SUSE) 的SLES_BYOS (

如需詳細資訊,請參閱 適用於 Windows Server 的 Azure Hybrid Use Benefit

適用於Linux伺服器的 Azure Hybrid Use Benefit

最低 api-version:2015-06-15

networkProfile

VirtualMachineScaleSetNetworkProfile

指定擴展集中虛擬機網路介面的屬性。

osProfile

VirtualMachineScaleSetOSProfile

指定擴展集中虛擬機的作業系統設定。

priority

VirtualMachinePriorityTypes

指定擴展集中虛擬機的優先順序。

最低 api-version:2017-10-30-preview

scheduledEventsProfile

ScheduledEventsProfile

指定排程的事件相關組態。

securityProfile

SecurityProfile

指定擴展集中虛擬機的安全性相關配置檔設定。

storageProfile

VirtualMachineScaleSetStorageProfile

指定虛擬機器磁碟的儲存體設定。

userData

string

擴展集中虛擬機的 UserData,必須以 base-64 編碼。 客戶不應在此傳遞任何秘密。

最低 api-version:2021-03-01

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔設定。

注意:它只能針對機密 VM 進行設定

名稱 類型 Description
diskEncryptionSet

DiskEncryptionSetParameters

針對客戶受控密鑰加密的機密VM OS 磁碟和 VMGuest Blob 所使用的受控磁碟,指定客戶受控磁碟加密集資源識別碼。

securityEncryptionType

securityEncryptionTypes

指定受控磁碟的 EncryptionType。
它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob,以及只加密 VMGuestState Blob 的 VMGuestStateOnly。

注意:它只能設定為機密 VM。

VMGalleryApplication

指定參考計算資源庫應用程式版本的必要資訊

名稱 類型 Description
configurationReference

string

選擇性,指定 Azure Blob 的 URI,以在提供時取代封裝的預設組態

order

integer

選擇性,指定必須安裝套件的順序

packageReferenceId

string

指定 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{version} 形式的 GalleryApplicationVersion 資源標識符

tags

string

選擇性,指定更多泛型內容的傳遞值。

VMSizeProperties

指定虛擬機上的 VM 大小屬性設定。

名稱 類型 Description
vCPUsAvailable

integer

指定 VM 可用的 vCPU 數目。

在要求本文中未指定這個屬性時,預設行為是將它設定為 API 回應中公開給該 VM 大小的 vCPU 值, 以列出區域中的所有可用虛擬機大小

vCPUsPerCore

integer

指定 vCPU 與實體核心比率。

在要求本文中未指定這個屬性時,預設行為會針對API回應中公開的 VM 大小設定為 vCPUPerCore 的值,以 列出區域中所有可用的虛擬機大小

將此屬性設定為 1 也表示超線程已停用。

WindowsConfiguration

指定虛擬機器上的 Windows 作業系統設定。

名稱 類型 Description
additionalUnattendContent

AdditionalUnattendContent[]

指定可併入 Unattend.xml 檔案 (由 Windows 安裝程式使用) 的額外 Base-64 編碼 XML 格式資訊。

enableAutomaticUpdates

boolean

指出是否為 Windows 虛擬機啟用自動 匯報。 預設值為 true。

對於虛擬機擴展集,此屬性可以更新,且更新會在OS重新佈建上生效。

patchSettings

PatchSettings

[預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。

provisionVMAgent

boolean

指出是否應該在虛擬機器上佈建虛擬機器代理程式。

當要求本文中未指定這個屬性時,預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上,以便稍後將擴充功能新增至 VM。

timeZone

string

指定虛擬機的時區。 例如“Pacific Standard Time”。

可能的值可以從 TimeZoneInfo.GetSystemTimeZones 傳回的時區 TimeZoneInfo.Id 值。

winRM

WinRMConfiguration

指定 Windows 遠端管理接聽程式。 藉此將啟用遠端 Windows PowerShell。

WindowsPatchAssessmentMode

指定 IaaS 虛擬機的 VM 客體修補評估模式。

可能的值包括:

ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。

AutomaticByPlatform - 平臺會觸發定期修補評估。 屬性 provisionVMAgent 必須是 true。

名稱 類型 Description
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchMode

指定 VM 客體修補至 IaaS 虛擬機的模式,或與 OrchestraMode 為彈性的虛擬機擴展集相關聯的虛擬機。

可能的值包括:

手動 - 您可以控制將修補程式應用程式套用至虛擬機。 您可以在 VM 內手動套用修補程式來執行此動作。 在此模式中,自動更新會停用;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true。

AutomaticByPlatform - 虛擬機將會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 屬性必須是 true

名稱 類型 Description
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

描述 VM 的 Windows 遠端管理設定

名稱 類型 Description
listeners

WinRMListener[]

Windows 遠端管理接聽程式清單

WinRMListener

描述 Windows 遠端管理接聽程式的通訊協議和指紋

名稱 類型 Description
certificateUrl

string

這是已上傳至 金鑰保存庫 做為秘密的憑證 URL。 如需將秘密新增至 金鑰保存庫,請參閱將密鑰或秘密新增至密鑰保存庫。 在此情況下,您的憑證必須是下列 JSON 物件的 Base64 編碼,其編碼方式為 UTF-8:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虛擬機上安裝憑證,建議使用適用於Linux的 Azure 金鑰保存庫 虛擬機擴充功能適用於Windows的 Azure 金鑰保存庫 虛擬機擴充功能

protocol

ProtocolTypes

指定 WinRM 接聽程式的通訊協定。

可能的值包括:
http

https