Virtual Machine Scale Sets - List
Возвращает список всех масштабируемых наборов виртуальных машин в группе ресурсов.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2024-03-01Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string |
Имя группы ресурсов. |
|
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
|
api-version
|
query | True |
string |
Версия API клиента. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
ОК |
|
| Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
|
Virtual |
|
Virtual |
VirtualMachineScaleSet_List_MaximumSet_Gen
Sample Request
Sample Response
{
"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,
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
"maxUnhealthyInstancePercent": 81,
"maxUnhealthyUpgradedInstancePercent": 98,
"pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
"enableCrossZoneUpgrade": true,
"prioritizeUnhealthyInstances": true,
"rollbackFailedInstancesOnPolicyBreach": true,
"maxSurge": 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}"
}
]
}
}
],
"networkSecurityGroup": {
"id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
},
"enableAcceleratedNetworking": true,
"enableFpga": true,
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaa"
]
},
"enableIPForwarding": true,
"deleteOption": "Delete"
}
}
],
"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,
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
"maxUnhealthyInstancePercent": 81,
"maxUnhealthyUpgradedInstancePercent": 98,
"pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
"enableCrossZoneUpgrade": true,
"prioritizeUnhealthyInstances": true,
"maxSurge": 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}"
}
]
}
}
],
"networkSecurityGroup": {
"id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
},
"enableAcceleratedNetworking": true,
"enableFpga": true,
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaa"
]
},
"enableIPForwarding": true,
"deleteOption": "Delete"
}
}
],
"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"
}VirtualMachineScaleSet_List_MinimumSet_Gen
Sample Request
Sample Response
{
"value": [
{
"location": "eastus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}"
},
{
"location": "eastus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}"
}
]
}Определения
| Имя | Описание |
|---|---|
|
Additional |
Включает или отключает возможность для виртуальной машины или масштабируемого набора виртуальных машин. |
|
Additional |
Указывает дополнительные сведения в формате XML, которые могут быть включены в файл Unattend.xml, используемый программой установки Windows. Содержимое определяется по имени параметра, имени компонента и проходу, в котором применяется содержимое. |
|
Api |
Справочник по сущностям API. |
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Application |
Содержит список приложений из коллекции, которые должны быть доступны для виртуальной машины или VMSS. |
|
Automatic |
Параметры конфигурации, используемые для автоматического обновления ОС. |
|
Automatic |
Задает параметры конфигурации для автоматического восстановления в масштабируемом наборе виртуальных машин. |
|
Billing |
Указывает сведения о точечных виртуальных машинах Azure или VMSS, связанных с выставлением счетов. Минимальная версия API: 2019-03-01. |
|
Boot |
Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки. |
|
Caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium. |
|
Capacity |
Параметры профиля резервирования мощности. |
|
Cloud |
Ответ об ошибке от службы вычислений. |
|
Component |
Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup. |
|
Delete |
Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины |
|
Diagnostics |
Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015. |
|
Diff |
Задает параметры временного диска для диска операционной системы. |
|
Diff |
Задает эфемерное размещение диска для диска операционной системы. Это свойство может использоваться пользователем в запросе для выбора расположения, т. е. диска кэша, диска ресурсов или дискового пространства nvme для подготовки временного диска ОС. Дополнительные сведения о требованиях к размеру временного диска ОС см. в разделе Требования к размеру диска эфемерной ОС для виртуальной машины Windows на и https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Linux по адресу https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Минимальная версия API для NvmeDisk: 2024-03-01. |
|
Diff |
Описывает параметры параметров временного диска, которые можно указать для диска операционной системы. Примечание: Параметры временного диска можно указать только для управляемого диска. |
|
Disk |
|
|
Disk |
Указывает способ создания виртуальных машин в масштабируемом наборе. Единственное допустимое значение: FromImage. Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, вы также используете элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также используете элемент плана, описанный выше. |
|
Disk |
Указывает, следует ли удалять или отсоединять диск ОС при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode). |
|
Disk |
Описывает параметр управляемого клиентом идентификатора ресурса набора шифрования дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview . |
|
Domain |
Метка доменного имени область. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из метки доменного имени область и индекса виртуальной машины, будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы. |
|
Encryption |
Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей. |
|
Event |
Указывает конфигурации, связанные с eventGridAndResourceGraph, связанные с запланированными событиями. |
|
Extended |
Сложный тип расширенного расположения. |
|
Extended |
Тип расширенного расположения. |
|
Image |
Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на образы и предложение можно задать только при создании масштабируемого набора. |
|
Inner |
Сведения о внутренней ошибке. |
|
Instance |
Состояние представления экземпляра. |
| IPVersion |
Доступно с Api-Version 2019-07-01 и более поздних версий, он указывает, является ли конкретная ipconfiguration IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6. |
|
Key |
Описание ссылки на секрет Key Vault |
|
Linux |
Задает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в дистрибутивах Azure-Endorsed. |
|
Linux |
Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. |
|
Linux |
Задает параметры, связанные с исправлением гостевой виртуальной машины в Linux. |
|
Linux |
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform. |
|
Linux |
Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux. |
|
Linux |
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого. |
| Mode |
Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет выполнять аудит или мониторинг, но не будет применять управление доступом к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Принудительный режим. |
|
Network |
указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса для масштабируемого набора виртуальных машин с режимом оркестрации "Гибкий". |
|
Network |
Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса. |
|
Network |
Указывает, включен ли вспомогательный SKU для ресурса сетевого интерфейса. |
|
Operating |
Это свойство позволяет указать тип операционной системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux. |
|
Orchestration |
Указывает режим оркестрации для масштабируемого набора виртуальных машин. |
|
OSImage |
|
|
Pass |
Имя прохода. В настоящее время единственным допустимым значением является OobeSystem. |
|
Patch |
Задает параметры, связанные с исправлением гостевой виртуальной машины в Windows. |
| Plan |
Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить этот образ для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы ->. Введите необходимые сведения и нажмите кнопку Сохранить. |
|
Priority |
Указывает целевые разбиения для точечных и обычных приоритетных виртуальных машин в масштабируемом наборе с гибким режимом оркестрации. С помощью этого свойства клиент может указать базовое число виртуальных машин с регулярным приоритетом, созданных по мере горизонтального масштабирования экземпляра VMSS, и разделение между точечными и обычными приоритетными виртуальными машинами после достижения этого базового целевого объекта. |
|
Protocol |
Указывает протокол прослушивателя WinRM. Возможные значения: http,https. |
|
Proxy |
Указывает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01. |
|
Public |
Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как гибкий. |
|
Public |
Указание имени номера SKU общедоступного IP-адреса |
|
Public |
Указание уровня SKU общедоступного IP-адреса |
|
Repair |
Тип действия по восстановлению (замена, перезапуск, повторное создание образа), которое будет использоваться для восстановления неработоспособных виртуальных машин в масштабируемом наборе. Значение по умолчанию — replace. |
|
Resiliency |
Описывает политику устойчивости: resilientVMCreationPolicy и (или) resilientVMDeletionPolicy. |
|
Resilient |
Параметры конфигурации, используемые при создании отказоустойчивой виртуальной машины. |
|
Resilient |
Параметры конфигурации, используемые при выполнении устойчивого удаления виртуальной машины. |
|
Resource |
Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из масштабируемого набора виртуальных машин. |
|
Rolling |
Параметры конфигурации, используемые при выполнении последовательного обновления. |
|
Scale |
Описывает политику масштабирования для масштабируемого набора виртуальных машин. |
|
Scheduled |
|
|
Scheduled |
Указывает конфигурации, связанные с повтором, перезагрузкой и scheduledEventsAdditionalPublishingTargets Scheduled Event. |
|
Scheduled |
|
|
security |
Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в большом двоичном объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин. |
|
Security |
Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01 |
|
Security |
Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин. |
|
Security |
Указывает тип безопасности виртуальной машины. Чтобы включить UefiSettings, ему необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включено, если это свойство не задано. |
|
Service |
Указывает идентификатор ссылки на артефакт службы, используемый для установки одной и той же версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Минимальная версия API: 2022-11-01 |
|
Setting |
Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon. |
| Sku |
Описывает номер SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, на который сейчас работает масштабируемый набор, перед изменением имени SKU необходимо освободить виртуальные машины в масштабируемом наборе. |
|
Spot |
Задает свойства Spot-Try-Restore для масштабируемого набора виртуальных машин. С помощью этого свойства клиент может включить или отключить автоматическое восстановление исключенных экземпляров точечных виртуальных машин VMSS в зависимости от доступности емкости и ценового ограничения. |
|
Ssh |
Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure |
|
Ssh |
Содержит сведения об открытом ключе сертификата SSH и пути на виртуальной машине Linux, в которой размещен открытый ключ. |
|
Status |
Код уровня. |
|
Storage |
Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС. |
|
Sub |
|
|
Terminate |
|
|
Uefi |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01. |
|
Upgrade |
Указывает режим обновления до виртуальных машин в масштабируемом наборе. |
|
Upgrade |
Описывает политику обновления : автоматическое, ручное или последовательное. |
|
User |
Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
|
User |
Указывает конфигурации, связанные с запланированными событиями перезагрузки. |
|
User |
Указывает конфигурации, связанные с запланированными событиями повторного развертывания. |
|
Vault |
Описывает ссылку на один сертификат в Key Vault и расположение сертификата на виртуальной машине. |
|
Vault |
Описывает набор сертификатов, которые находятся в одном Key Vault. |
|
Virtual |
Описывает универсальный код ресурса (URI) диска. |
|
Virtual |
Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как Deallocate, так и Delete, а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как "Освободить", так и "Удалить", а минимальная версия API — 2017-10-30-preview. |
|
Virtual |
Описывает расширение виртуальной машины. |
|
Virtual |
Представление экземпляра расширения виртуальной машины. |
|
Virtual |
Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview. |
|
Virtual |
Описывает масштабируемый набор виртуальных машин. |
|
Virtual |
Описывает диск данных масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает расширение масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает профиль расширения масштабируемого набора виртуальных машин. |
|
Virtual |
Задает параметры оборудования для масштабируемого набора виртуальных машин. |
|
Virtual |
Удостоверение для масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает IP-конфигурацию сетевого профиля масштабируемого набора виртуальных машин. |
|
Virtual |
Содержит ip-тег, связанный с общедоступным IP-адресом. |
|
Virtual |
Ответ операции перечисления виртуальной машины. |
|
Virtual |
Описывает параметры управляемого диска ScaleSet. |
|
Virtual |
Описывает сетевые конфигурации сетевого профиля масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин. |
|
Virtual |
Описывает сетевой профиль масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает диск операционной системы масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает профиль ОС масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает конфигурацию Общедоступного IP-адреса конфигурации масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин. |
|
Virtual |
Правила, которые необходимо соблюдать при масштабировании в масштабируемом наборе виртуальных машин. |
|
Virtual |
Описывает профиль хранения масштабируемого набора виртуальных машин. |
|
Virtual |
Описывает профиль виртуальной машины масштабируемого набора виртуальных машин. |
|
VMDisk |
Задает параметры профиля безопасности для управляемого диска. Примечание: Его можно задать только для конфиденциальных виртуальных машин. |
|
VMGallery |
Указывает необходимые сведения для ссылки на версию приложения коллекции вычислений. |
|
VMSize |
Задает параметры свойства размера виртуальной машины на виртуальной машине. |
|
Windows |
Указывает параметры операционной системы Windows на виртуальной машине. |
|
Windows |
Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. |
|
Windows |
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform. |
|
Windows |
Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows. |
|
Windows |
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого. |
|
Win |
Описание конфигурации удаленного управления Windows виртуальной машины |
|
Win |
Описание протокола и отпечатка прослушивателя удаленного управления Windows |
AdditionalCapabilities
Включает или отключает возможность для виртуальной машины или масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| hibernationEnabled |
boolean |
Флаг, который включает или отключает возможность гибернации на виртуальной машине. |
| ultraSSDEnabled |
boolean |
Флаг, который включает или отключает возможность иметь один или несколько управляемых дисков данных с UltraSSD_LRS типом учетной записи хранения на виртуальной машине или VMSS. Управляемые диски с типом учетной записи хранения UltraSSD_LRS можно добавить в виртуальную машину или масштабируемый набор виртуальных машин, только если это свойство включено. |
AdditionalUnattendContent
Указывает дополнительные сведения в формате XML, которые могут быть включены в файл Unattend.xml, используемый программой установки Windows. Содержимое определяется по имени параметра, имени компонента и проходу, в котором применяется содержимое.
| Имя | Тип | Описание |
|---|---|---|
| componentName |
Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup. |
|
| content |
string |
Указывает содержимое в формате XML, добавляемое в файл unattend.xml для указанного пути и компонента. Размер XML должен быть меньше 4 КБ и должен содержать корневой элемент для вставляемого параметра или компонента. |
| passName |
Имя прохода. В настоящее время единственным допустимым значением является OobeSystem. |
|
| settingName |
Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon. |
ApiEntityReference
Справочник по сущностям API.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса ARM в формате /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
ApiError
Ошибка API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке API |
|
| innererror |
Внутренняя ошибка API |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApplicationProfile
Содержит список приложений из коллекции, которые должны быть доступны для виртуальной машины или VMSS.
| Имя | Тип | Описание |
|---|---|---|
| galleryApplications |
Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS. |
AutomaticOSUpgradePolicy
Параметры конфигурации, используемые для автоматического обновления ОС.
| Имя | Тип | Описание |
|---|---|---|
| disableAutomaticRollback |
boolean |
Следует ли отключить функцию отката образа ОС. Значение по умолчанию — false. |
| enableAutomaticOSUpgrade |
boolean |
Указывает, должны ли обновления ОС автоматически применяться к экземплярам масштабируемого набора в последовательном режиме, когда становится доступна более новая версия образа ОС. Значение по умолчанию — false. Если для масштабируемых наборов на основе Windows задано значение true, параметру enableAutomaticUpdates автоматически присваивается значение false и не может быть присвоено значение true. |
| osRollingUpgradeDeferral |
boolean |
Указывает, следует ли отложить автоматическое обновление ОС. При отложенном обновлении ОС для каждой виртуальной машины отправляются расширенные уведомления о том, что обновление ОС после последовательного обновления является входящим с помощью тега IMDS Platform.PendingOSUpgrade. Затем обновление откладывается до утверждения обновления с помощью вызова ApproveRollingUpgrade. |
| useRollingUpgradePolicy |
boolean |
Указывает, следует ли использовать политику последовательного обновления во время автоматического обновления ОС. Значение по умолчанию — false. Автоматическое обновление ОС откатится к политике по умолчанию, если в VMSS не определена политика. |
AutomaticRepairsPolicy
Задает параметры конфигурации для автоматического восстановления в масштабируемом наборе виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Указывает, следует ли включить автоматическое восстановление в масштабируемом наборе виртуальных машин. Значением по умолчанию является false. |
| gracePeriod |
string |
Время, в течение которого автоматическое восстановление приостанавливается из-за изменения состояния на виртуальной машине. Время отсрочки начинается после завершения изменения состояния. Это помогает избежать преждевременного или случайного ремонта. Длительность времени должна быть указана в формате ISO 8601. Минимальный допустимый льготный период составляет 10 минут (PT10M), что также является значением по умолчанию. Максимальный допустимый льготный период составляет 90 минут (PT90M). |
| repairAction |
Тип действия по восстановлению (замена, перезапуск, повторное создание образа), которое будет использоваться для восстановления неработоспособных виртуальных машин в масштабируемом наборе. Значение по умолчанию — replace. |
BillingProfile
Указывает сведения о точечных виртуальных машинах Azure или VMSS, связанных с выставлением счетов. Минимальная версия API: 2019-03-01.
| Имя | Тип | Описание |
|---|---|---|
| maxPrice |
number |
Указывает максимальную цену, которую вы готовы заплатить за точечные виртуальные машины Или VMSS Azure. Эта цена указана в долларах США. |
BootDiagnostics
Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Указывает, должна ли на виртуальной машине быть включена загрузочная диагностика. |
| storageUri |
string |
URI учетной записи хранения, используемой для размещения выходных данных консоли и снимка экрана. Если параметр storageUri не указан при включении диагностика загрузки, будет использоваться управляемое хранилище. |
CachingTypes
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.
| Имя | Тип | Описание |
|---|---|---|
| None |
string |
|
| ReadOnly |
string |
|
| ReadWrite |
string |
CapacityReservationProfile
Параметры профиля резервирования мощности.
| Имя | Тип | Описание |
|---|---|---|
| capacityReservationGroup |
Указывает идентификатор ресурса группы резервирования емкости, который следует использовать для выделения экземпляров виртуальной машины или масштабируемого набора виртуальных машин при условии, что зарезервировано достаточно емкости. Дополнительные сведения см https://aka.ms/CapacityReservation . в статье. |
CloudError
Ответ об ошибке от службы вычислений.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ошибка API. |
ComponentNames
Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
| Имя | Тип | Описание |
|---|---|---|
| Microsoft-Windows-Shell-Setup |
string |
DeleteOptions
Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiagnosticsProfile
Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015.
| Имя | Тип | Описание |
|---|---|---|
| bootDiagnostics |
Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Примечание. Если указан параметр storageUri, убедитесь, что учетная запись хранения находится в том же регионе и подписке, что и виртуальная машина. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки. |
DiffDiskOptions
Задает параметры временного диска для диска операционной системы.
| Имя | Тип | Описание |
|---|---|---|
| Local |
string |
DiffDiskPlacement
Задает эфемерное размещение диска для диска операционной системы. Это свойство может использоваться пользователем в запросе для выбора расположения, т. е. диска кэша, диска ресурсов или дискового пространства nvme для подготовки временного диска ОС. Дополнительные сведения о требованиях к размеру временного диска ОС см. в разделе Требования к размеру диска эфемерной ОС для виртуальной машины Windows на и https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Linux по адресу https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Минимальная версия API для NvmeDisk: 2024-03-01.
| Имя | Тип | Описание |
|---|---|---|
| CacheDisk |
string |
|
| NvmeDisk |
string |
|
| ResourceDisk |
string |
DiffDiskSettings
Описывает параметры параметров временного диска, которые можно указать для диска операционной системы. Примечание: Параметры временного диска можно указать только для управляемого диска.
| Имя | Тип | Описание |
|---|---|---|
| option |
Задает параметры временного диска для диска операционной системы. |
|
| placement |
Задает эфемерное размещение диска для диска операционной системы. Возможные значения: CacheDisk,ResourceDisk,NvmeDisk. Поведение по умолчанию: CacheDisk, если он настроен для размера виртуальной машины, в противном случае используется ResourceDisk или NvmeDisk. Сведения о том, проверка какие размеры виртуальных машин предоставляют диск кэша, см. в документации по размеру виртуальной машины Windows в https://docs.microsoft.com/azure/virtual-machines/windows/sizes и виртуальной машине Linux в .https://docs.microsoft.com/azure/virtual-machines/linux/sizes Минимальная версия API для NvmeDisk: 2024-03-01. |
DiskControllerTypes
| Имя | Тип | Описание |
|---|---|---|
| NVMe |
string |
|
| SCSI |
string |
DiskCreateOptionTypes
Указывает способ создания виртуальных машин в масштабируемом наборе. Единственное допустимое значение: FromImage. Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, вы также используете элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также используете элемент плана, описанный выше.
| Имя | Тип | Описание |
|---|---|---|
| Attach |
string |
|
| Copy |
string |
|
| Empty |
string |
|
| FromImage |
string |
|
| Restore |
string |
DiskDeleteOptionTypes
Указывает, следует ли удалять или отсоединять диск ОС при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode).
Возможные значения:
Удалить Если используется это значение, диск ОС удаляется при удалении виртуальной машины VMSS Flex.
Отсоединить Если используется это значение, диск ОПЕРАЦИОННОй системы сохраняется после удаления виртуальной машины VMSS Flex.
Значение по умолчанию — Delete. Для временного диска ОС значение по умолчанию — Удалить. Пользователь не может изменить параметр удаления для временного диска ОС.
| Имя | Тип | Описание |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiskEncryptionSetParameters
Описывает параметр управляемого клиентом идентификатора ресурса набора шифрования дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview .
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
DomainNameLabelScopeTypes
Метка доменного имени область. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из метки доменного имени область и индекса виртуальной машины, будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы.
| Имя | Тип | Описание |
|---|---|---|
| NoReuse |
string |
|
| ResourceGroupReuse |
string |
|
| SubscriptionReuse |
string |
|
| TenantReuse |
string |
EncryptionIdentity
Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей.
| Имя | Тип | Описание |
|---|---|---|
| userAssignedIdentityResourceId |
string |
Указывает идентификатор ресурса ARM для одного из удостоверений пользователей, связанных с виртуальной машиной. |
EventGridAndResourceGraph
Указывает конфигурации, связанные с eventGridAndResourceGraph, связанные с запланированными событиями.
| Имя | Тип | Описание |
|---|---|---|
| enable |
boolean |
Указывает, включены ли сетка событий и граф ресурсов для конфигураций, связанных с запланированными событиями. |
ExtendedLocation
Сложный тип расширенного расположения.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя расширенного расположения. |
| type |
Тип расширенного расположения. |
ExtendedLocationTypes
Тип расширенного расположения.
| Имя | Тип | Описание |
|---|---|---|
| EdgeZone |
string |
ImageReference
Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на образы и предложение можно задать только при создании масштабируемого набора.
| Имя | Тип | Описание |
|---|---|---|
| communityGalleryImageId |
string |
Указан уникальный идентификатор образа коллекции сообщества для развертывания виртуальной машины. Его можно получить из коллекции сообщества образ GET call. |
| exactVersion |
string |
Указывает в десятичных числах версию образа платформы или образа Marketplace, используемую для создания виртуальной машины. Это поле только для чтения отличается от "version" только в том случае, если значение, указанное в поле "версия", равно "latest". |
| id |
string |
Идентификатор ресурса |
| offer |
string |
Указывает предложение образа платформы или образа Marketplace, используемого для создания виртуальной машины. |
| publisher |
string |
Издатель образа. |
| sharedGalleryImageId |
string |
Указан уникальный идентификатор образа общей коллекции для развертывания виртуальной машины. Его можно получить из вызова GET образа общей коллекции. |
| sku |
string |
Номер SKU образа. |
| version |
string |
Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основной, Дополнительный и Сборка являются десятичными числами. Укажите "latest", чтобы использовать последнюю версию образа, доступную во время развертывания. Даже если вы используете последнюю версию, образ виртуальной машины не будет автоматически обновляться после развертывания, даже если станет доступна новая версия. Не используйте поле "версия" для развертывания образа коллекции. Образ коллекции всегда должен использовать поле id для развертывания, чтобы использовать "последнюю" версию образа коллекции, просто задайте "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле id без ввода версии. |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
InstanceViewStatus
Состояние представления экземпляра.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код состояния. |
| displayStatus |
string |
Короткая локализуемая метка для состояния. |
| level |
Код уровня. |
|
| message |
string |
Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. |
| time |
string |
Время состояния. |
IPVersion
Доступно с Api-Version 2019-07-01 и более поздних версий, он указывает, является ли конкретная ipconfiguration IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6.
| Имя | Тип | Описание |
|---|---|---|
| IPv4 |
string |
|
| IPv6 |
string |
KeyVaultSecretReference
Описание ссылки на секрет Key Vault
| Имя | Тип | Описание |
|---|---|---|
| secretUrl |
string |
URL-адрес, ссылающийся на секрет в Key Vault. |
| sourceVault |
Относительный URL-адрес Key Vault, содержащего секрет. |
LinuxConfiguration
Задает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в дистрибутивах Azure-Endorsed.
| Имя | Тип | Описание |
|---|---|---|
| disablePasswordAuthentication |
boolean |
Указывает, следует ли отключить проверку подлинности паролем. |
| enableVMAgentPlatformUpdates |
boolean |
Указывает, включена ли Обновления платформы VMAgent для виртуальной машины Linux. Значение по умолчанию — false. |
| patchSettings |
[Предварительная версия функции] Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Linux. |
|
| provisionVMAgent |
boolean |
Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже. |
| ssh |
Указывает конфигурацию ключа SSH для операционной системы Linux. |
LinuxPatchAssessmentMode
Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS.
Возможны следующие значения:
ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.
AutomaticByPlatform — платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.
| Имя | Тип | Описание |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
LinuxPatchSettings
Задает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
| Имя | Тип | Описание |
|---|---|---|
| assessmentMode |
Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. |
|
| automaticByPlatformSettings |
Задает дополнительные параметры для режима исправлений AutomaticByPlatform в гостевой установке исправлений виртуальной машины в Linux. |
|
| patchMode |
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
| Имя | Тип | Описание |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.
| Имя | Тип | Описание |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Позволяет клиенту планировать установку исправлений без случайных обновлений |
| rebootSetting |
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform. |
LinuxVMGuestPatchMode
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого.
Возможны следующие значения:
ImageDefault — используется конфигурация исправлений виртуальной машины по умолчанию.
AutomaticByPlatform — виртуальная машина будет автоматически обновлена платформой. Свойство provisionVMAgent должно иметь значение true.
| Имя | Тип | Описание |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
Mode
Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет выполнять аудит или мониторинг, но не будет применять управление доступом к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Принудительный режим.
| Имя | Тип | Описание |
|---|---|---|
| Audit |
string |
|
| Enforce |
string |
NetworkApiVersion
указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса для масштабируемого набора виртуальных машин с режимом оркестрации "Гибкий".
| Имя | Тип | Описание |
|---|---|---|
| 2020-11-01 |
string |
NetworkInterfaceAuxiliaryMode
Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.
| Имя | Тип | Описание |
|---|---|---|
| AcceleratedConnections |
string |
|
| Floating |
string |
|
| None |
string |
NetworkInterfaceAuxiliarySku
Указывает, включен ли вспомогательный SKU для ресурса сетевого интерфейса.
| Имя | Тип | Описание |
|---|---|---|
| A1 |
string |
|
| A2 |
string |
|
| A4 |
string |
|
| A8 |
string |
|
| None |
string |
OperatingSystemTypes
Это свойство позволяет указать тип операционной системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.
| Имя | Тип | Описание |
|---|---|---|
| Linux |
string |
|
| Windows |
string |
OrchestrationMode
Указывает режим оркестрации для масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| Flexible |
string |
|
| Uniform |
string |
OSImageNotificationProfile
| Имя | Тип | Описание |
|---|---|---|
| enable |
boolean |
Указывает, включено или отключено событие Запланированное изображение ОС. |
| notBeforeTimeout |
string |
Период времени, в течение времени, когда виртуальная машина будет переосмыслена или обновлена ос, необходимо будет утвердить запланированное событие образа ОС, прежде чем событие будет автоматически утверждено (истекло время ожидания). Конфигурация указывается в формате ISO 8601, а значение должно быть 15 минут (PT15M) |
PassNames
Имя прохода. В настоящее время единственным допустимым значением является OobeSystem.
| Имя | Тип | Описание |
|---|---|---|
| OobeSystem |
string |
PatchSettings
Задает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
| Имя | Тип | Описание |
|---|---|---|
| assessmentMode |
Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. |
|
| automaticByPlatformSettings |
Задает дополнительные параметры для режима исправления AutomaticByPlatform в гостевой системе исправлений виртуальной машины в Windows. |
|
| enableHotpatching |
boolean |
Позволяет клиентам исправлять свои виртуальные машины Azure без перезагрузки. Для enableHotpatching параметру provisionVMAgent необходимо задать значение true, а для patchMode — значение AutomaticByPlatform. |
| patchMode |
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий. |
Plan
Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить этот образ для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы ->. Введите необходимые сведения и нажмите кнопку Сохранить.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Идентификатор плана. |
| product |
string |
Указывает продукт изображения из Marketplace. Это то же значение, что и Offer в элементе imageReference. |
| promotionCode |
string |
Промокод. |
| publisher |
string |
Идентификатор издателя. |
PriorityMixPolicy
Указывает целевые разбиения для точечных и обычных приоритетных виртуальных машин в масштабируемом наборе с гибким режимом оркестрации. С помощью этого свойства клиент может указать базовое число виртуальных машин с регулярным приоритетом, созданных по мере горизонтального масштабирования экземпляра VMSS, и разделение между точечными и обычными приоритетными виртуальными машинами после достижения этого базового целевого объекта.
| Имя | Тип | Описание |
|---|---|---|
| baseRegularPriorityCount |
integer |
Базовое число виртуальных машин с обычным приоритетом, которые будут созданы в этом масштабируемом наборе по мере горизонтального увеличения масштаба. |
| regularPriorityPercentageAboveBase |
integer |
Процент экземпляров виртуальных машин после достижения базового регулярного приоритета, которые должны использовать обычный приоритет. |
ProtocolTypes
Указывает протокол прослушивателя WinRM. Возможные значения: http,https.
| Имя | Тип | Описание |
|---|---|---|
| Http |
string |
|
| Https |
string |
ProxyAgentSettings
Указывает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Указывает, следует ли включить функцию ProxyAgent на виртуальной машине или в масштабируемом наборе виртуальных машин. |
| keyIncarnationId |
integer |
Увеличение значения этого свойства позволяет пользователю сбросить ключ, используемый для защиты канала связи между гостем и узлом. |
| mode |
Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет выполнять аудит или мониторинг, но не будет применять управление доступом к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Режим принудительного применения. |
PublicIPAddressSku
Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как гибкий.
| Имя | Тип | Описание |
|---|---|---|
| name |
Указание имени номера SKU общедоступного IP-адреса |
|
| tier |
Указание уровня SKU общедоступного IP-адреса |
PublicIPAddressSkuName
Указание имени номера SKU общедоступного IP-адреса
| Имя | Тип | Описание |
|---|---|---|
| Basic |
string |
|
| Standard |
string |
PublicIPAddressSkuTier
Указание уровня SKU общедоступного IP-адреса
| Имя | Тип | Описание |
|---|---|---|
| Global |
string |
|
| Regional |
string |
RepairAction
Тип действия по восстановлению (замена, перезапуск, повторное создание образа), которое будет использоваться для восстановления неработоспособных виртуальных машин в масштабируемом наборе. Значение по умолчанию — replace.
| Имя | Тип | Описание |
|---|---|---|
| Reimage |
string |
|
| Replace |
string |
|
| Restart |
string |
ResiliencyPolicy
Описывает политику устойчивости: resilientVMCreationPolicy и (или) resilientVMDeletionPolicy.
| Имя | Тип | Описание |
|---|---|---|
| resilientVMCreationPolicy |
Параметры конфигурации, используемые при создании отказоустойчивой виртуальной машины. |
|
| resilientVMDeletionPolicy |
Параметры конфигурации, используемые при выполнении устойчивого удаления виртуальной машины. |
ResilientVMCreationPolicy
Параметры конфигурации, используемые при создании отказоустойчивой виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Указывает, должно ли быть включено создание устойчивых виртуальных машин в масштабируемом наборе виртуальных машин. Значением по умолчанию является false. |
ResilientVMDeletionPolicy
Параметры конфигурации, используемые при выполнении устойчивого удаления виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Указывает, должно ли быть включено удаление устойчивых виртуальных машин в масштабируемом наборе виртуальных машин. Значением по умолчанию является false. |
ResourceIdentityType
Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| None |
string |
|
| SystemAssigned |
string |
|
| SystemAssigned, UserAssigned |
string |
|
| UserAssigned |
string |
RollingUpgradePolicy
Параметры конфигурации, используемые при выполнении последовательного обновления.
| Имя | Тип | Описание |
|---|---|---|
| enableCrossZoneUpgrade |
boolean |
Разрешите VMSS игнорировать границы AZ при создании пакетов обновления. Чтобы определить размер пакета, примите во внимание домен обновления и maxBatchInstancePercent. |
| maxBatchInstancePercent |
integer |
Максимальный процент от общего числа экземпляров виртуальных машин, которые будут одновременно обновлены при последовательном обновлении в одном пакете. Так как это максимальное значение, неработоспособные экземпляры в предыдущих или будущих пакетах могут привести к снижению процента экземпляров в пакете для обеспечения более высокой надежности. Значение по умолчанию для этого параметра — 20 %. |
| maxSurge |
boolean |
Создайте новые виртуальные машины для обновления масштабируемого набора, а не для обновления существующих виртуальных машин. Существующие виртуальные машины будут удалены после создания новых виртуальных машин для каждого пакета. |
| maxUnhealthyInstancePercent |
integer |
Максимальный процент от общего числа экземпляров виртуальных машин в масштабируемом наборе, которые могут одновременно быть неработоспособными в результате обновления или в результате проверки работоспособности виртуальной машины в неработоспособном состоянии до прерывания последовательного обновления. Это ограничение будет проверено перед запуском любого пакета. Значение по умолчанию для этого параметра — 20 %. |
| maxUnhealthyUpgradedInstancePercent |
integer |
Максимальный процент обновленных экземпляров виртуальных машин, которые находятся в неработоспособном состоянии. Это проверка произойдет после обновления каждого пакета. Если этот процент когда-либо превышен, последовательное обновление прерывается. Значение по умолчанию для этого параметра — 20 %. |
| pauseTimeBetweenBatches |
string |
Время ожидания между завершением обновления для всех виртуальных машин в одном пакете и запуском следующего пакета. Длительность времени должна быть указана в формате ISO 8601. Значение по умолчанию — 0 секунд (PT0S). |
| prioritizeUnhealthyInstances |
boolean |
Обновите все неработоспособные экземпляры в масштабируемом наборе до всех работоспособных экземпляров. |
| rollbackFailedInstancesOnPolicyBreach |
boolean |
Откат экземпляров, завершившихся сбоем, к предыдущей модели, если политика последовательного обновления нарушена. |
ScaleInPolicy
Описывает политику масштабирования для масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| forceDeletion |
boolean |
Это свойство позволяет указать, следует ли принудительно удалять виртуальные машины, выбранные для удаления, при масштабировании масштабируемого набора виртуальных машин. (Функция в предварительной версии) |
| rules |
Правила, которые необходимо соблюдать при масштабировании в масштабируемом наборе виртуальных машин. |
ScheduledEventsAdditionalPublishingTargets
| Имя | Тип | Описание |
|---|---|---|
| eventGridAndResourceGraph |
Параметры конфигурации, используемые при создании параметра eventGridAndResourceGraph Scheduled Event. |
ScheduledEventsPolicy
Указывает конфигурации, связанные с повтором, перезагрузкой и scheduledEventsAdditionalPublishingTargets Scheduled Event.
| Имя | Тип | Описание |
|---|---|---|
| scheduledEventsAdditionalPublishingTargets |
Параметры конфигурации, используемые при публикации scheduledEventsAdditionalPublishingTargets. |
|
| userInitiatedReboot |
Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedReboot. |
|
| userInitiatedRedeploy |
Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedRedeploy. |
ScheduledEventsProfile
| Имя | Тип | Описание |
|---|---|---|
| osImageNotificationProfile |
Указывает конфигурации, связанные с запланированным событием образа ОС. |
|
| terminateNotificationProfile |
Указывает конфигурации, связанные с запланированным событием terminate. |
securityEncryptionTypes
Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в большом двоичном объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| DiskWithVMGuestState |
string |
|
| NonPersistedTPM |
string |
|
| VMGuestStateOnly |
string |
SecurityPostureReference
Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01
| Имя | Тип | Описание |
|---|---|---|
| excludeExtensions |
Список расширений виртуальных машин, которые следует исключить при применении состояния безопасности. |
|
| id |
string |
Идентификатор ссылки на состояние безопасности в виде /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest |
SecurityProfile
Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| encryptionAtHost |
boolean |
Это свойство может использоваться пользователем в запросе для включения или отключения шифрования узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая ресурс или временный диск на самом узле. Поведение по умолчанию: Шифрование на узле будет отключено, если это свойство не имеет значение true для ресурса. |
| encryptionIdentity |
Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей. |
|
| proxyAgentSettings |
Указывает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01. |
|
| securityType |
Указывает тип безопасности виртуальной машины. Чтобы включить UefiSettings, ему необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включено, если это свойство не задано. |
|
| uefiSettings |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01. |
SecurityTypes
Указывает тип безопасности виртуальной машины. Чтобы включить UefiSettings, ему необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включено, если это свойство не задано.
| Имя | Тип | Описание |
|---|---|---|
| ConfidentialVM |
string |
|
| TrustedLaunch |
string |
ServiceArtifactReference
Указывает идентификатор ссылки на артефакт службы, используемый для установки одной и той же версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Минимальная версия API: 2022-11-01
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ссылки на артефакт службы в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} |
SettingNames
Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.
| Имя | Тип | Описание |
|---|---|---|
| AutoLogon |
string |
|
| FirstLogonCommands |
string |
Sku
Описывает номер SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, на который сейчас работает масштабируемый набор, перед изменением имени SKU необходимо освободить виртуальные машины в масштабируемом наборе.
| Имя | Тип | Описание |
|---|---|---|
| capacity |
integer |
Указывает количество виртуальных машин в масштабируемом наборе. |
| name |
string |
Имя SKU. |
| tier |
string |
Указывает уровень виртуальных машин в масштабируемом наборе. |
SpotRestorePolicy
Задает свойства Spot-Try-Restore для масштабируемого набора виртуальных машин. С помощью этого свойства клиент может включить или отключить автоматическое восстановление исключенных экземпляров точечных виртуальных машин VMSS в зависимости от доступности емкости и ценового ограничения.
| Имя | Тип | Описание |
|---|---|---|
| enabled |
boolean |
Включает функцию Spot-Try-Restore, при которой вытесняемые экземпляры VMSS SPOT будут пытаться восстановить оппортунистически на основе доступности емкости и ценовых ограничений. |
| restoreTimeout |
string |
Значение времени ожидания, выраженное как длительность времени ISO 8601, по истечении которой платформа не будет пытаться восстановить экземпляры VMSS SPOT. |
SshConfiguration
Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure
| Имя | Тип | Описание |
|---|---|---|
| publicKeys |
Список открытых ключей SSH, используемых для проверки подлинности на виртуальных машинах под управлением Linux. |
SshPublicKey
Содержит сведения об открытом ключе сертификата SSH и пути на виртуальной машине Linux, в которой размещен открытый ключ.
| Имя | Тип | Описание |
|---|---|---|
| keyData |
string |
Сертификат открытого ключа SSH, используемый для проверки подлинности на виртуальной машине через SSH. Ключ должен быть по крайней мере 2048-разрядным и иметь формат ssh-rsa. Сведения о создании ключей SSH см. в статье [Создание ключей SSH в Linux и Mac для виртуальных машин Linux в Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
| path |
string |
Указывает полный путь на созданной виртуальной машине, где хранится открытый ключ SSH. Если файл уже существует, указанный ключ добавляется к файлу. Пример: /home/user/.ssh/authorized_keys |
StatusLevelTypes
Код уровня.
| Имя | Тип | Описание |
|---|---|---|
| Error |
string |
|
| Info |
string |
|
| Warning |
string |
StorageAccountTypes
Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.
| Имя | Тип | Описание |
|---|---|---|
| PremiumV2_LRS |
string |
|
| Premium_LRS |
string |
|
| Premium_ZRS |
string |
|
| StandardSSD_LRS |
string |
|
| StandardSSD_ZRS |
string |
|
| Standard_LRS |
string |
|
| UltraSSD_LRS |
string |
SubResource
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
TerminateNotificationProfile
| Имя | Тип | Описание |
|---|---|---|
| enable |
boolean |
Указывает, включено или отключено событие Terminate Scheduled. |
| notBeforeTimeout |
string |
Настраиваемая продолжительность удаления виртуальной машины может потенциально утвердить запланированное событие завершения до автоматического утверждения события (истекло время ожидания). Конфигурация должна быть указана в формате ISO 8601, значение по умолчанию — 5 минут (PT5M). |
UefiSettings
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.
| Имя | Тип | Описание |
|---|---|---|
| secureBootEnabled |
boolean |
Указывает, должна ли быть включена безопасная загрузка на виртуальной машине. Минимальная версия API: 2020-12-01. |
| vTpmEnabled |
boolean |
Указывает, следует ли включить vTPM на виртуальной машине. Минимальная версия API: 2020-12-01. |
UpgradeMode
Указывает режим обновления до виртуальных машин в масштабируемом наборе.
Возможны следующие значения:
Вручную . Вы управляете применением обновлений к виртуальным машинам в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.
Автоматически — все виртуальные машины в масштабируемом наборе обновляются автоматически одновременно.
| Имя | Тип | Описание |
|---|---|---|
| Automatic |
string |
|
| Manual |
string |
|
| Rolling |
string |
UpgradePolicy
Описывает политику обновления : автоматическое, ручное или последовательное.
| Имя | Тип | Описание |
|---|---|---|
| automaticOSUpgradePolicy |
Параметры конфигурации, используемые для автоматического обновления ОС. |
|
| mode |
Указывает режим обновления до виртуальных машин в масштабируемом наборе. |
|
| rollingUpgradePolicy |
Параметры конфигурации, используемые при выполнении последовательного обновления. |
UserAssignedIdentities
Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
| Имя | Тип | Описание |
|---|---|---|
|
|
UserInitiatedReboot
Указывает конфигурации, связанные с запланированными событиями перезагрузки.
| Имя | Тип | Описание |
|---|---|---|
| automaticallyApprove |
boolean |
Указывает конфигурации, связанные с запланированными событиями перезагрузки. |
UserInitiatedRedeploy
Указывает конфигурации, связанные с запланированными событиями повторного развертывания.
| Имя | Тип | Описание |
|---|---|---|
| automaticallyApprove |
boolean |
Указывает конфигурации, связанные с запланированными событиями повторного развертывания. |
VaultCertificate
Описывает ссылку на один сертификат в Key Vault и расположение сертификата на виртуальной машине.
| Имя | Тип | Описание |
|---|---|---|
| certificateStore |
string |
Для виртуальных машин Windows указывает хранилище сертификатов на виртуальной машине, в которую следует добавить сертификат. Указанное хранилище сертификатов неявно находится в учетной записи LocalMachine. Для виртуальных машин Linux файл сертификата помещается в каталог /var/lib/waagent с именем <файла UppercaseThumbprint.crt> для файла сертификата X509 и <UppercaseThumbprint.prv> для закрытого ключа. Оба этих файла имеют формат PEM. |
| certificateUrl |
string |
Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен иметь кодировку Base64 следующего объекта JSON, который закодирован в UTF-8: |
VaultSecretGroup
Описывает набор сертификатов, которые находятся в одном Key Vault.
| Имя | Тип | Описание |
|---|---|---|
| sourceVault |
Относительный URL-адрес Key Vault, содержащий все сертификаты в VaultCertificates. |
|
| vaultCertificates |
Список ссылок на хранилище ключей в SourceVault, которые содержат сертификаты. |
VirtualHardDisk
Описывает универсальный код ресурса (URI) диска.
| Имя | Тип | Описание |
|---|---|---|
| uri |
string |
Указывает универсальный код ресурса (URI) виртуального жесткого диска. |
VirtualMachineEvictionPolicyTypes
Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как Deallocate, так и Delete, а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как "Освободить", так и "Удалить", а минимальная версия API — 2017-10-30-preview.
| Имя | Тип | Описание |
|---|---|---|
| Deallocate |
string |
|
| Delete |
string |
VirtualMachineExtension
Описывает расширение виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| 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 |
Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
| properties.type |
string |
Указывает тип расширения; пример : CustomScriptExtension. |
| properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
| tags |
object |
Теги ресурсов |
| type |
string |
Тип ресурса |
VirtualMachineExtensionInstanceView
Представление экземпляра расширения виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя расширения виртуальной машины. |
| statuses |
Сведения о состоянии ресурса. |
|
| substatuses |
Сведения о состоянии ресурса. |
|
| type |
string |
Указывает тип расширения; пример : CustomScriptExtension. |
| typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
VirtualMachinePriorityTypes
Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview.
| Имя | Тип | Описание |
|---|---|---|
| Low |
string |
|
| Regular |
string |
|
| Spot |
string |
VirtualMachineScaleSet
Описывает масштабируемый набор виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| etag |
string |
Etag — это свойство, возвращаемое в ответе "Создание,обновление/получение" VMSS, поэтому клиент может указать его в заголовке для обеспечения оптимистичных обновлений. |
| extendedLocation |
Расширенное расположение масштабируемого набора виртуальных машин. |
|
| id |
string |
Идентификатор ресурса |
| identity |
Удостоверение масштабируемого набора виртуальных машин, если оно настроено. |
|
| location |
string |
Расположение ресурса |
| name |
string |
Имя ресурса |
| plan |
Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить этот образ для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы ->. Введите необходимые сведения и нажмите кнопку Сохранить. |
|
| properties.additionalCapabilities |
Указывает дополнительные возможности, включенные или отключенные в Виртуальные машины в масштабируемом наборе виртуальных машин. Например: есть ли у Виртуальные машины возможность поддержки подключения управляемых дисков данных с UltraSSD_LRS типа учетной записи хранения. |
|
| properties.automaticRepairsPolicy |
Политика автоматического восстановления. |
|
| properties.constrainedMaximumCapacity |
boolean |
Необязательное свойство, для которого должно быть задано значение True или опущено. |
| properties.doNotRunExtensionsOnOverprovisionedVMs |
boolean |
Если включена overprovision, расширения запускаются только на запрошенном количестве виртуальных машин, которые, наконец, сохранены. Таким образом, это свойство гарантирует, что расширения не будут запускаться на дополнительных виртуальных машинах, подготовленных с избыточной подготовкой. |
| properties.hostGroup |
Указывает сведения о выделенной группе узлов, в которой находится масштабируемый набор виртуальных машин. Минимальная версия API: 2020-06-01. |
|
| properties.orchestrationMode |
Задает режим оркестрации для масштабируемого набора виртуальных машин. |
|
| properties.overprovision |
boolean |
Указывает, следует ли перепродумать масштабируемый набор виртуальных машин. |
| properties.platformFaultDomainCount |
integer |
Количество доменов сбоя для каждой группы размещения. |
| properties.priorityMixPolicy |
Указывает требуемые целевые объекты для смешивания точечных и обычных приоритетных виртуальных машин в одном экземпляре VMSS Flex. |
|
| properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
| properties.proximityPlacementGroup |
Указывает сведения о группе размещения близкого взаимодействия, которым должен быть назначен масштабируемый набор виртуальных машин. Минимальная версия API: 2018-04-01. |
|
| properties.resiliencyPolicy |
Политика устойчивости |
|
| properties.scaleInPolicy |
Указывает политики, применяемые при масштабировании в Виртуальные машины в масштабируемом наборе виртуальных машин. |
|
| properties.scheduledEventsPolicy |
The ScheduledEventsPolicy. |
|
| properties.singlePlacementGroup |
boolean |
Если значение равно true, масштабируемый набор ограничивается одной группой размещения с максимальным размером 100 виртуальных машин. ПРИМЕЧАНИЕ. Если параметр singlePlacementGroup имеет значение true, он может быть изменен на false. Однако, если значением является false, его не возможно изменить на true. |
| properties.spotRestorePolicy |
Задает свойства точечного восстановления для масштабируемого набора виртуальных машин. |
|
| properties.timeCreated |
string |
Указывает время создания ресурса масштабируемого набора виртуальных машин. Минимальная версия API: 2021-11-01. |
| properties.uniqueId |
string |
Указывает идентификатор, который однозначно идентифицирует масштабируемый набор виртуальных машин. |
| properties.upgradePolicy |
Политика обновления. |
|
| properties.virtualMachineProfile |
Профиль виртуальной машины. |
|
| properties.zoneBalance |
boolean |
Следует ли принудительно распределять распределение виртуальных машин между зонами X в случае сбоя зоны. Свойство zoneBalance можно задать, только если свойство zones масштабируемого набора содержит несколько зон. Если зоны не указаны или указана всего одна зона, свойство ZoneBalance задавать не следует. |
| sku |
SKU масштабируемого набора виртуальных машин. |
|
| tags |
object |
Теги ресурсов |
| type |
string |
Тип ресурса |
| zones |
string[] |
Зоны масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Зоны доступности можно задать только при создании масштабируемого набора. |
VirtualMachineScaleSetDataDisk
Описывает диск данных масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium. |
|
| createOption |
Параметр create. |
|
| deleteOption |
Указывает, следует ли удалять или отсоединять диск данных при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode). |
|
| diskIOPSReadWrite |
integer |
Указывает Read-Write операций ввода-вывода в секунду для управляемого диска. Следует использовать только в том случае, если storageAccountType имеет UltraSSD_LRS. Если значение не указано, будет присвоено значение по умолчанию на основе diskSizeGB. |
| diskMBpsReadWrite |
integer |
Указывает пропускную способность управляемого диска в МБ в секунду. Следует использовать только в том случае, если storageAccountType имеет UltraSSD_LRS. Если значение не указано, будет присвоено значение по умолчанию на основе diskSizeGB. |
| diskSizeGB |
integer |
Указывает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это количество байтов x 1024^3 для диска и значение не может быть больше 1023. |
| lun |
integer |
Указывает номер логической единицы диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. |
| managedDisk |
Параметры управляемого диска. |
|
| name |
string |
имя диска. |
| writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить writeAccelerator на диске. |
VirtualMachineScaleSetExtension
Описывает расширение масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
| name |
string |
Имя модуля. |
| properties.autoUpgradeMinorVersion |
boolean |
Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. |
| properties.enableAutomaticUpgrade |
boolean |
Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения. |
| properties.forceUpdateTag |
string |
Если указано значение, отличное от предыдущего, обработчик расширений будет вынужден обновиться, даже если конфигурация расширения не изменилась. |
| properties.protectedSettings |
object |
Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров. |
| properties.protectedSettingsFromKeyVault |
Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей. |
|
| properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которых необходимо подготовить это расширение. |
| properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
| properties.publisher |
string |
Имя издателя обработчика расширений. |
| properties.settings |
object |
Общедоступные параметры расширения в формате JSON. |
| properties.suppressFailures |
boolean |
Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
| properties.type |
string |
Указывает тип расширения; пример : CustomScriptExtension. |
| properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
| type |
string |
Тип ресурса |
VirtualMachineScaleSetExtensionProfile
Описывает профиль расширения масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| extensions |
Дочерние ресурсы расширения масштабируемого набора виртуальных машин. |
|
| extensionsTimeBudget |
string |
Указывает время, отведенное для запуска всех расширений. Продолжительность времени должна составлять от 15 до 120 минут (включительно) и должна быть указана в формате ISO 8601. Значение по умолчанию — 90 минут (PT1H30M). Минимальная версия API: 2020-06-01. |
VirtualMachineScaleSetHardwareProfile
Задает параметры оборудования для масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| vmSizeProperties |
Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-11-01. Для получения дополнительных сведений следуйте инструкциям в разделе Настройка виртуальной машины . |
VirtualMachineScaleSetIdentity
Удостоверение для масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| principalId |
string |
Идентификатор субъекта удостоверения масштабируемого набора виртуальных машин. Это свойство предоставляется только для удостоверения, назначаемого системой. |
| tenantId |
string |
Идентификатор клиента, связанный с масштабируемым набором виртуальных машин. Это свойство предоставляется только для удостоверения, назначаемого системой. |
| type |
Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None приведет к удалению всех удостоверений из масштабируемого набора виртуальных машин. |
|
| userAssignedIdentities |
Список удостоверений пользователей, связанных с масштабируемым набором виртуальных машин. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
VirtualMachineScaleSetIPConfiguration
Описывает IP-конфигурацию сетевого профиля масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя IP-конфигурации. |
| properties.applicationGatewayBackendAddressPools |
Задает массив ссылок на серверные пулы адресов шлюзов приложений. Масштабируемый набор может ссылаться на серверные пулы адресов нескольких шлюзов приложений. Несколько масштабируемых наборов не могут использовать один и тот же шлюз приложений. |
|
| properties.applicationSecurityGroups |
Задает массив ссылок на группу безопасности приложений. |
|
| properties.loadBalancerBackendAddressPools |
Задает массив ссылок на серверные пулы адресов подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на серверные пулы адресов одной общедоступной и одной внутренней подсистемы балансировки нагрузки. Несколько масштабируемых наборов не могут использовать одну и ту же подсистему балансировки нагрузки ценовой категории "Базовый". |
|
| properties.loadBalancerInboundNatPools |
Задает массив ссылок на входящие пулы NAT подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на входящие пулы NAT одного общедоступного и одного внутреннего балансировщика нагрузки. Несколько масштабируемых наборов не могут использовать одну и ту же подсистему балансировки нагрузки ценовой категории "Базовый". |
|
| properties.primary |
boolean |
Указывает основной сетевой интерфейс, если виртуальная машина имеет более 1 сетевого интерфейса. |
| properties.privateIPAddressVersion |
Доступно с Api-Version 2017-03-30 и более поздних версий, он указывает, является ли конкретная ipconfiguration IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6. |
|
| properties.publicIPAddressConfiguration |
PublicIPAddressConfiguration. |
|
| properties.subnet |
Указывает идентификатор подсети. |
VirtualMachineScaleSetIpTag
Содержит ip-тег, связанный с общедоступным IP-адресом.
| Имя | Тип | Описание |
|---|---|---|
| ipTagType |
string |
Тип тега IP. Пример: FirstPartyUsage. |
| tag |
string |
Тег IP, связанный с общедоступным IP-адресом. Пример: SQL, Хранилище и т. д. |
VirtualMachineScaleSetListResult
Ответ операции перечисления виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| nextLink |
string |
Универсальный код ресурса (URI) для получения следующей страницы Масштабируемые наборы виртуальных машин. Вызовите ListNext() с этим параметром, чтобы получить следующую страницу VMSS. |
| value |
Список масштабируемых наборов виртуальных машин. |
VirtualMachineScaleSetManagedDiskParameters
Описывает параметры управляемого диска ScaleSet.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSet |
Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска. |
|
| securityProfile |
Указывает профиль безопасности для управляемого диска. |
|
| storageAccountType |
Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС. |
VirtualMachineScaleSetNetworkConfiguration
Описывает сетевые конфигурации сетевого профиля масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя конфигурации сети. |
| properties.auxiliaryMode |
Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса. |
|
| properties.auxiliarySku |
Указывает, включен ли вспомогательный SKU для ресурса сетевого интерфейса. |
|
| properties.deleteOption |
Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины |
|
| properties.disableTcpStateTracking |
boolean |
Указывает, отключен ли сетевой интерфейс для отслеживания состояния TCP. |
| properties.dnsSettings |
Параметры DNS, применяемые к сетевым интерфейсам. |
|
| properties.enableAcceleratedNetworking |
boolean |
Указывает, включена ли в сетевом интерфейсе функция ускорения сети. |
| properties.enableFpga |
boolean |
Указывает, включен ли сетевой интерфейс ППВМ с поддержкой сети. |
| properties.enableIPForwarding |
boolean |
Включена ли IP-пересылка на этом сетевом адаптере. |
| properties.ipConfigurations |
Задает IP-конфигурации сетевого интерфейса. |
|
| properties.networkSecurityGroup |
Группа безопасности сети. |
|
| properties.primary |
boolean |
Указывает основной сетевой интерфейс, если виртуальная машина имеет более 1 сетевого интерфейса. |
VirtualMachineScaleSetNetworkConfigurationDnsSettings
Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| dnsServers |
string[] |
Список IP-адресов DNS-серверов |
VirtualMachineScaleSetNetworkProfile
Описывает сетевой профиль масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| healthProbe |
Ссылка на пробу подсистемы балансировки нагрузки, используемую для определения работоспособности экземпляра в масштабируемом наборе виртуальных машин. Ссылка будет иметь следующий вид: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}. |
|
| networkApiVersion |
указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса для масштабируемого набора виртуальных машин с режимом оркестрации "Гибкий". |
|
| networkInterfaceConfigurations |
Список конфигураций сети. |
VirtualMachineScaleSetOSDisk
Описывает диск операционной системы масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium. |
|
| createOption |
Указывает способ создания виртуальных машин в масштабируемом наборе. Единственное допустимое значение: FromImage. Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, вы также используете элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также используете элемент плана, описанный выше. |
|
| deleteOption |
Указывает, следует ли удалять или отсоединять диск ОС при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode). |
|
| diffDiskSettings |
Задает параметры временного диска для диска операционной системы, используемого масштабируемым набором виртуальных машин. |
|
| diskSizeGB |
integer |
Указывает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство "diskSizeGB" — это количество байтов x 1024^3 для диска и не может быть больше 1023. |
| image |
Указывает сведения о неуправляемом пользовательском образе, на котором будет основываться масштабируемый набор. |
|
| managedDisk |
Параметры управляемого диска. |
|
| name |
string |
имя диска. |
| osType |
Это свойство позволяет указать тип операционной системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux. |
|
| vhdContainers |
string[] |
Указывает URL-адреса контейнера, используемые для хранения дисков операционной системы для масштабируемого набора. |
| writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить writeAccelerator на диске. |
VirtualMachineScaleSetOSProfile
Описывает профиль ОС масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| adminPassword |
string |
Указывает пароль учетной записи администратора. |
| adminUsername |
string |
Указывает имя учетной записи администратора. |
| allowExtensionOperations |
boolean |
Указывает, следует ли разрешать операции расширения в масштабируемом наборе виртуальных машин. Для этого параметра может быть задано значение False, только если в масштабируемом наборе виртуальных машин нет расширений. |
| computerNamePrefix |
string |
Указывает префикс имени компьютера для всех виртуальных машин в масштабируемом наборе. Префиксы имени компьютера должны содержать от 1 до 15 символов. |
| customData |
string |
Указывает строку пользовательских данных в кодировке base-64. Строка в кодировке base-64 кодируется в двоичный массив, который сохраняется в виде файла на виртуальной машине. Максимальная длина двоичного массива — 65 535 байт. Сведения об использовании cloud-init для виртуальной машины см. в статье Использование cloud-init для настройки виртуальной машины Linux во время создания. |
| linuxConfiguration |
Задает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в дистрибутивах Azure-Endorsed. |
|
| requireGuestProvisionSignal |
boolean |
Необязательное свойство, для которого должно быть задано значение True или опущено. |
| secrets |
Указывает набор сертификатов, которые должны быть установлены на виртуальных машинах в масштабируемом наборе. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows. |
|
| windowsConfiguration |
Указывает параметры операционной системы Windows на виртуальной машине. |
VirtualMachineScaleSetPublicIPAddressConfiguration
Описывает конфигурацию Общедоступного IP-адреса конфигурации масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя конфигурации адреса publicIP. |
| properties.deleteOption |
Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины |
|
| properties.dnsSettings |
Virtual |
Параметры DNS, применяемые к общедоступным IP-адресам. |
| properties.idleTimeoutInMinutes |
integer |
Время ожидания общедоступного IP-адреса. |
| properties.ipTags |
Список тегов IP-адресов, связанных с общедоступным IP-адресом. |
|
| properties.publicIPAddressVersion |
Доступно с Api-Version 2019-07-01 и более поздних версий, он указывает, является ли конкретная ipconfiguration IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6. |
|
| properties.publicIPPrefix |
PublicIPPrefix, из которого следует выделить общедоступные IP-адреса. |
|
| sku |
Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как гибкий. |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| domainNameLabel |
string |
Метка доменного имени. Объединение метки доменного имени и индекса виртуальной машины будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы. |
| domainNameLabelScope |
Метка доменного имени область. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из метки доменного имени область и индекса виртуальной машины, будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы. |
VirtualMachineScaleSetScaleInRules
Правила, которые необходимо соблюдать при масштабировании в масштабируемом наборе виртуальных машин.
Возможны следующие значения:
По умолчанию При масштабировании масштабируемого набора виртуальных машин масштабируемый набор сначала распределяется между зонами, если это зональный масштабируемый набор. Затем он будет сбалансирован между доменами сбоя насколько это возможно. В каждом домене сбоя виртуальные машины, выбранные для удаления, будут новейшими, которые не защищены от масштабирования.
СтарейшаяVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны самые старые виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне для удаления будут выбраны самые старые виртуальные машины, которые не защищены.
Новая виртуальная машина При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны новейшие виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне для удаления будут выбраны новейшие виртуальные машины, которые не защищены.
| Имя | Тип | Описание |
|---|---|---|
| Default |
string |
|
| NewestVM |
string |
|
| OldestVM |
string |
VirtualMachineScaleSetStorageProfile
Описывает профиль хранения масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| dataDisks |
Указывает параметры, используемые для добавления дисков данных на виртуальные машины в масштабируемом наборе. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure. |
|
| diskControllerType |
Указывает тип контроллера диска, настроенный для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2022-08-01 |
|
| imageReference |
Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. |
|
| osDisk |
Указывает сведения о диске операционной системы, используемом виртуальными машинами в масштабируемом наборе. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure. |
VirtualMachineScaleSetVMProfile
Описывает профиль виртуальной машины масштабируемого набора виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| applicationProfile |
Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS. |
|
| billingProfile |
Указывает сведения о точечных виртуальных машинах Azure, связанные с выставлением счетов. Минимальная версия API: 2019-03-01. |
|
| capacityReservation |
Указывает сведения о резервировании емкости масштабируемого набора. Минимальная версия API: 2021-04-01. |
|
| diagnosticsProfile |
Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015. |
|
| evictionPolicy |
Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как Deallocate, так и Delete, а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как "Освободить", так и "Удалить", а минимальная версия API — 2017-10-30-preview. |
|
| extensionProfile |
Задает коллекцию параметров для расширений, установленных на виртуальных машинах в масштабируемом наборе. |
|
| hardwareProfile |
Указывает сведения о профиле оборудования масштабируемого набора. Минимальная версия API: 2021-11-01. |
|
| licenseType |
string |
Указывает, что используемый образ или диск был лицензирован локально. |
| networkProfile |
Задает свойства сетевых интерфейсов виртуальных машин в масштабируемом наборе. |
|
| osProfile |
Задает параметры операционной системы для виртуальных машин в масштабируемом наборе. |
|
| priority |
Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview. |
|
| scheduledEventsProfile |
Указывает конфигурации, связанные с запланированными событиями. |
|
| securityPostureReference |
Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01 |
|
| securityProfile |
Задает параметры профиля, связанного с безопасностью, для виртуальных машин в масштабируемом наборе. |
|
| serviceArtifactReference |
Указывает идентификатор ссылки на артефакт службы, используемый для установки одной и той же версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Минимальная версия API: 2022-11-01 |
|
| storageProfile |
Указывает параметры хранилища дисков виртуальной машины. |
|
| timeCreated |
string |
Указывает время создания этого профиля виртуальной машины для масштабируемого набора виртуальных машин. Минимальная версия API для этого свойства — 2024-03-01. Это значение будет добавлено в теги виртуальных машин VMSS Flex при создании или обновлении профиля виртуальной машины VMSS с минимальной версией API 2024-03-01. |
| userData |
string |
UserData для виртуальных машин в масштабируемом наборе, который должен быть закодирован в кодировке Base-64. Клиент не должен передавать здесь какие-либо секреты. Минимальная версия API: 2021-03-01. |
VMDiskSecurityProfile
Задает параметры профиля безопасности для управляемого диска. Примечание: Его можно задать только для конфиденциальных виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSet |
Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного ключа клиента ConfidentialVM OS Disk и BLOB-объекта VMGuest. |
|
| securityEncryptionType |
Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в большом двоичном объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин. |
VMGalleryApplication
Указывает необходимые сведения для ссылки на версию приложения коллекции вычислений.
| Имя | Тип | Описание |
|---|---|---|
| configurationReference |
string |
Необязательно. Указывает универсальный код ресурса (URI) большого двоичного объекта Azure, который заменит конфигурацию по умолчанию для пакета, если он указан. |
| enableAutomaticUpgrade |
boolean |
Если задано значение true, при наличии новой версии приложения коллекции в PIR/SIG она будет автоматически обновлена для виртуальной машины или VMSS. |
| order |
integer |
Необязательный параметр. Указывает порядок установки пакетов. |
| packageReferenceId |
string |
Указывает идентификатор ресурса GalleryApplicationVersion в форме /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{versions/{version} |
| tags |
string |
Необязательно. Задает значение сквозной передачи для более универсального контекста. |
| treatFailureAsDeploymentFailure |
boolean |
Необязательно. Если значение равно true, любой сбой для любой операции в VmApplication приведет к сбою развертывания. |
VMSizeProperties
Задает параметры свойства размера виртуальной машины на виртуальной машине.
| Имя | Тип | Описание |
|---|---|---|
| vCPUsAvailable |
integer |
Указывает количество виртуальных ЦП, доступных для виртуальной машины. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение виртуальных ЦП, доступных для этого размера виртуальной машины, которое отображается в ответе API списка всех доступных размеров виртуальных машин в регионе. |
| vCPUsPerCore |
integer |
Указывает соотношение виртуальных ЦП и физического ядра. Если это свойство не указано в тексте запроса, по умолчанию устанавливается значение vCPUsPerCore для размера виртуальной машины, предоставленного в ответе API списка всех доступных размеров виртуальных машин в регионе. Присвоение этому свойству значения 1 также означает, что гиперпотония отключена. |
WindowsConfiguration
Указывает параметры операционной системы Windows на виртуальной машине.
| Имя | Тип | Описание |
|---|---|---|
| additionalUnattendContent |
Задает дополнительные сведения в кодировке base-64 и в формате XML, которые могут включаться в файл Unattend.xml, используемый программой установки Windows. |
|
| enableAutomaticUpdates |
boolean |
Указывает, включена ли автоматическая Обновления для виртуальной машины Windows. Значение по умолчанию — true. Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС. |
| enableVMAgentPlatformUpdates |
boolean |
Указывает, включена ли для виртуальной машины Windows Обновления платформы VMAgent. Значение по умолчанию — false. |
| patchSettings |
[Предварительная версия функции] Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Windows. |
|
| provisionVMAgent |
boolean |
Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже. |
| timeZone |
string |
Указывает часовой пояс виртуальной машины. Например, "Тихоокеанское стандартное время". Возможные значения могут быть TimeZoneInfo.Id значения из часовых поясов, возвращаемых TimeZoneInfo.GetSystemTimeZones. |
| winRM |
Задает прослушиватели удаленного управления Windows. Это включает удаленное взаимодействие с Windows PowerShell. |
WindowsPatchAssessmentMode
Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS.
Возможны следующие значения:
ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.
AutomaticByPlatform — платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.
| Имя | Тип | Описание |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
| Имя | Тип | Описание |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
WindowsVMGuestPatchAutomaticByPlatformSettings
Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows.
| Имя | Тип | Описание |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Позволяет клиенту планировать установку исправлений без случайных обновлений |
| rebootSetting |
Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform. |
WindowsVMGuestPatchMode
Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого.
Возможны следующие значения:
Вручную — вы управляете применением исправлений на виртуальной машине. Это можно сделать, применив исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение false
AutomaticByOS — виртуальная машина будет автоматически обновлена операционной системой. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true.
AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.
| Имя | Тип | Описание |
|---|---|---|
| AutomaticByOS |
string |
|
| AutomaticByPlatform |
string |
|
| Manual |
string |
WinRMConfiguration
Описание конфигурации удаленного управления Windows виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| listeners |
Список прослушивателей удаленного управления Windows |
WinRMListener
Описание протокола и отпечатка прослушивателя удаленного управления Windows
| Имя | Тип | Описание |
|---|---|---|
| certificateUrl |
string |
Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который закодирован в UTF-8: |
| protocol |
Указывает протокол прослушивателя WinRM. Возможные значения: http,https. |