Virtual Machine Scale Sets - Get

Отображение сведений о масштабируемом наборе виртуальных машин.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2024-03-01&$expand=userData

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

vmScaleSetName
path True

string

Имя масштабируемого набора виртуальных машин.

api-version
query True

string

Версия API клиента.

$expand
query

ExpandTypesForGetVMScaleSets

Выражение expand, применяемое к операции. UserData извлекает свойство UserData масштабируемого набора виртуальных машин, предоставленного пользователем во время операции создания или обновления масштабируемого набора виртуальных машин.

Ответы

Имя Тип Описание
200 OK

VirtualMachineScaleSet

ОК

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Get a virtual machine scale set
Get a virtual machine scale set placed on a dedicated host group through automatic placement.
Get a virtual machine scale set with UserData
Get VM scale set VM with Disk Controller Type

Get a virtual machine scale set

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2024-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "etag": "\"1\"",
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      },
      "timeCreated": "2023-09-27T01:03:40.3138469+00:00"
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  }
}

Get a virtual machine scale set placed on a dedicated host group through automatic placement.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2024-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Get a virtual machine scale set with UserData

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2024-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Get VM scale set VM with Disk Controller Type

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2024-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": [],
        "diskControllerType": "NVMe"
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Определения

Имя Описание
AdditionalCapabilities

Включает или отключает возможность для виртуальной машины или масштабируемого набора виртуальных машин.

AdditionalUnattendContent

Указывает дополнительные сведения в формате XML, которые могут быть включены в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется именем параметра, именем компонента и проходом, в котором применяется содержимое.

ApiEntityReference

Справочник по сущностям API.

ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

ApplicationProfile

Содержит список приложений коллекции, которые должны быть доступны для виртуальной машины или VMSS.

AutomaticOSUpgradePolicy

Параметры конфигурации, используемые для автоматического обновления ОС.

AutomaticRepairsPolicy

Задает параметры конфигурации для автоматического восстановления в масштабируемом наборе виртуальных машин.

BillingProfile

Указывает сведения о выставлении счетов для точечных виртуальных машин Azure или VMSS. Минимальная версия API: 2019-03-01.

BootDiagnostics

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

CapacityReservationProfile

Параметры профиля резервирования емкости.

CloudError

Ответ об ошибке от службы вычислений.

ComponentNames

Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.

DeleteOptions

Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины

DiagnosticsProfile

Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015.

DiffDiskOptions

Указывает временные параметры диска для диска операционной системы.

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.

DiffDiskSettings

Описывает параметры временных параметров диска, которые можно указать для диска операционной системы. Примечание: Временные параметры диска можно указать только для управляемого диска.

DiskControllerTypes
DiskCreateOptionTypes

Указывает способ создания виртуальных машин в масштабируемом наборе. Единственное допустимое значение: FromImage. Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, вы также используете элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также используете элемент плана, описанный выше.

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode).

Возможные значения:

Удалить Если это значение используется, диск ОС удаляется при удалении виртуальной машины VMSS Flex.

Отсоединить Если это значение используется, диск ОС сохраняется после удаления виртуальной машины VMSS Flex.

По умолчанию задано значение Delete. Для временного диска ОС значением по умолчанию является Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

DiskEncryptionSetParameters

Описывает параметр набора ресурсов для шифрования управляемых пользователем дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview .

DomainNameLabelScopeTypes

Метка доменного имени область. Объединение хэшируемой метки доменного имени, созданной в соответствии с политикой из метки доменного имени область и индекса виртуальной машины, будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы.

EncryptionIdentity

Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей.

EventGridAndResourceGraph

Указывает конфигурации, связанные с eventGridAndResourceGraph, связанные с запланированными событиями.

ExpandTypesForGetVMScaleSets

Выражение expand, применяемое к операции. UserData извлекает свойство UserData масштабируемого набора виртуальных машин, предоставленного пользователем во время операции создания или обновления масштабируемого набора виртуальных машин.

ExtendedLocation

Сложный тип расширенного расположения.

ExtendedLocationTypes

Тип расширенного расположения.

ImageReference

Указывает сведения об используемом изображении. Вы можете указать сведения об образах платформ, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если требуется использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на образы и предложение можно задать только при создании масштабируемого набора.

InnerError

Сведения о внутренней ошибке.

InstanceViewStatus

Состояние представления экземпляра.

IPVersion

Доступно с Api-Version 2019-07-01, он указывает, является ли конкретная ip-конфигурация IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6.

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

LinuxConfiguration

Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в Azure-Endorsed Дистрибутивы.

LinuxPatchAssessmentMode

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.

LinuxPatchSettings

Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

LinuxVMGuestPatchAutomaticByPlatformSettings

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.

LinuxVMGuestPatchMode

Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий.

Возможны следующие значения:

ImageDefault — используется конфигурация исправлений виртуальной машины по умолчанию.

AutomaticByPlatform — виртуальная машина будет автоматически обновлена платформой. Свойство provisionVMAgent должно иметь значение true.

Mode

Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не будет применять контроль доступа к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Режим принудительного применения.

NetworkApiVersion

указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса для масштабируемого набора виртуальных машин с режимом оркестрации "Гибкий".

NetworkInterfaceAuxiliaryMode

Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.

NetworkInterfaceAuxiliarySku

Указывает, включен ли вспомогательный SKU для ресурса сетевого интерфейса.

OperatingSystemTypes

Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.

OrchestrationMode

Задает режим оркестрации для масштабируемого набора виртуальных машин.

OSImageNotificationProfile
PassNames

Имя прохода. В настоящее время единственным допустимым значением является OobeSystem.

PatchSettings

Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Windows.

Plan

Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить его для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы .>. Введите необходимые сведения и нажмите кнопку Сохранить.

PriorityMixPolicy

Указывает целевые разбиения для точечных и обычных приоритетных виртуальных машин в масштабируемом наборе с гибким режимом оркестрации. С помощью этого свойства клиент может указать базовое число виртуальных машин с регулярным приоритетом, созданных при горизонтальном масштабировании экземпляра VMSS, и разделение между точечными и обычными приоритетными виртуальными машинами после достижения этого базового целевого объекта.

ProtocolTypes

Указывает протокол прослушивателя WinRM. Возможные значения: http,https.

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01.

PublicIPAddressSku

Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как Гибкий.

PublicIPAddressSkuName

Указание имени номера SKU общедоступного IP-адреса

PublicIPAddressSkuTier

Указание уровня SKU общедоступного IP-адреса

RepairAction

Тип действия по восстановлению (замена, перезапуск, повторное создание образа), которое будет использоваться для восстановления неработоспособных виртуальных машин в масштабируемом наборе. Значение по умолчанию — replace.

ResiliencyPolicy

Описывает политику устойчивости : resilientVMCreationPolicy и (или) resilientVMDeletionPolicy.

ResilientVMCreationPolicy

Параметры конфигурации, используемые при создании отказоустойчивой виртуальной машины.

ResilientVMDeletionPolicy

Параметры конфигурации, используемые при выполнении устойчивого удаления виртуальной машины.

ResourceIdentityType

Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None приведет к удалению всех удостоверений из масштабируемого набора виртуальных машин.

RollingUpgradePolicy

Параметры конфигурации, используемые при выполнении последовательного обновления.

ScaleInPolicy

Описывает политику масштабирования для масштабируемого набора виртуальных машин.

ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy

Указывает конфигурации, связанные с повтором развертывания, перезагрузки и scheduledEventsAdditionalPublishingTargets Scheduled Event.

ScheduledEventsProfile
securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

SecurityPostureReference

Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01

SecurityProfile

Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.

SecurityTypes

Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.

ServiceArtifactReference

Указывает идентификатор ссылки на артефакт службы, используемый для задания одинаковой версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Минимальная версия API: 2022-11-01

SettingNames

Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.

Sku

Описывает номер SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, на которое в настоящее время находится масштабируемый набор, необходимо отменить выделение виртуальных машин в масштабируемом наборе, прежде чем изменять имя SKU.

SpotRestorePolicy

Задает свойства Spot-Try-Restore для масштабируемого набора виртуальных машин. С помощью этого свойства клиент может включить или отключить автоматическое восстановление экземпляров точечных виртуальных машин VMSS оппортунистически на основе доступности емкости и ценового ограничения.

SshConfiguration

Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure

SshPublicKey

Содержит сведения об открытом ключе сертификата SSH и пути на виртуальной машине Linux, в которой он размещен.

StatusLevelTypes

Код уровня.

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

SubResource
TerminateNotificationProfile
UefiSettings

Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.

UpgradeMode

Указывает режим обновления до виртуальных машин в масштабируемом наборе.

Возможны следующие значения:

Вручную . Вы управляете применением обновлений для виртуальных машин в масштабируемом наборе. Для этого используется действие manualUpgrade.

Автоматически — все виртуальные машины в масштабируемом наборе обновляются автоматически одновременно.

UpgradePolicy

Описывает политику обновления : автоматическое, ручное или последовательное.

UserAssignedIdentities

Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

UserInitiatedReboot

Указывает конфигурации, связанные с запланированными событиями перезагрузки.

UserInitiatedRedeploy

Указывает конфигурации, связанные с запланированными событиями повторного развертывания.

VaultCertificate

Описывает ссылку на один сертификат в Key Vault и расположение сертификата на виртуальной машине.

VaultSecretGroup

Описывает набор сертификатов, которые находятся в одном Key Vault.

VirtualHardDisk

Описывает универсальный код ресурса (URI) диска.

VirtualMachineEvictionPolicyTypes

Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как "Отменить выделение", так и "Удалить", а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как Deallocate, так и Delete, а минимальная версия API — 2017-10-30-preview.

VirtualMachineExtension

Описывает расширение виртуальной машины.

VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

VirtualMachinePriorityTypes

Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview.

VirtualMachineScaleSet

Описывает масштабируемый набор виртуальных машин.

VirtualMachineScaleSetDataDisk

Описывает диск данных масштабируемого набора виртуальных машин.

VirtualMachineScaleSetExtension

Описывает расширение масштабируемого набора виртуальных машин.

VirtualMachineScaleSetExtensionProfile

Описывает профиль расширения масштабируемого набора виртуальных машин.

VirtualMachineScaleSetHardwareProfile

Задает параметры оборудования для масштабируемого набора виртуальных машин.

VirtualMachineScaleSetIdentity

Удостоверение для масштабируемого набора виртуальных машин.

VirtualMachineScaleSetIPConfiguration

Описывает IP-конфигурацию сетевого профиля масштабируемого набора виртуальных машин.

VirtualMachineScaleSetIpTag

Содержит тег IP, связанный с общедоступным IP-адресом.

VirtualMachineScaleSetManagedDiskParameters

Описывает параметры управляемого диска ScaleSet.

VirtualMachineScaleSetNetworkConfiguration

Описывает сетевые конфигурации сетевого профиля масштабируемого набора виртуальных машин.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.

VirtualMachineScaleSetNetworkProfile

Описывает сетевой профиль масштабируемого набора виртуальных машин.

VirtualMachineScaleSetOSDisk

Описывает диск операционной системы масштабируемого набора виртуальных машин.

VirtualMachineScaleSetOSProfile

Описывает профиль ОС масштабируемого набора виртуальных машин.

VirtualMachineScaleSetPublicIPAddressConfiguration

Описание конфигурации IP-адреса конфигурации масштабируемого набора виртуальных машин PublicIPAddress

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.

VirtualMachineScaleSetScaleInRules

Правила, которые следует соблюдать при масштабировании масштабируемого набора виртуальных машин.

Возможны следующие значения:

По умолчанию При масштабировании масштабируемого набора виртуальных машин он сначала распределяется между зонами, если это зональный масштабируемый набор. Затем он будет распределяться по доменам сбоя насколько это возможно. В каждом домене сбоя виртуальные машины, выбранные для удаления, будут новейшими, которые не защищены от масштабирования.

СтарыйVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны самые старые виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне для удаления будут выбраны самые старые виртуальные машины, которые не защищены.

NewestVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны новейшие виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне будут выбраны для удаления новейшие виртуальные машины, которые не защищены.

VirtualMachineScaleSetStorageProfile

Описывает профиль хранения масштабируемого набора виртуальных машин.

VirtualMachineScaleSetVMProfile

Описывает профиль виртуальной машины масштабируемого набора виртуальных машин.

VMDiskSecurityProfile

Задает параметры профиля безопасности для управляемого диска. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

VMGalleryApplication

Указывает необходимые сведения для ссылки на версию приложения коллекции вычислений.

VMSizeProperties

Задает параметры свойства размера виртуальной машины на виртуальной машине.

WindowsConfiguration

Указывает параметры операционной системы Windows на виртуальной машине.

WindowsPatchAssessmentMode

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

WindowsVMGuestPatchAutomaticByPlatformSettings

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправления Windows.

WindowsVMGuestPatchMode

Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий.

Возможны следующие значения:

Вручную . Вы управляете применением исправлений на виртуальной машине. Это можно сделать, применяя исправления вручную на виртуальной машине. В этом режиме автоматические обновления отключены; свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение false.

AutomaticByOS — виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true.

AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

WinRMConfiguration

Описание конфигурации удаленного управления Windows виртуальной машины

WinRMListener

Описание протокола и отпечатка прослушивателя удаленного управления Windows

AdditionalCapabilities

Включает или отключает возможность для виртуальной машины или масштабируемого набора виртуальных машин.

Имя Тип Описание
hibernationEnabled

boolean

Флаг, который включает или отключает возможность гибернации на виртуальной машине.

ultraSSDEnabled

boolean

Флаг, который включает или отключает возможность иметь один или несколько управляемых дисков данных с UltraSSD_LRS типа учетной записи хранения на виртуальной машине или VMSS. Управляемые диски с типом учетной записи хранения UltraSSD_LRS можно добавить в виртуальную машину или масштабируемый набор виртуальных машин, только если это свойство включено.

AdditionalUnattendContent

Указывает дополнительные сведения в формате XML, которые могут быть включены в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется именем параметра, именем компонента и проходом, в котором применяется содержимое.

Имя Тип Описание
componentName

ComponentNames

Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.

content

string

Указывает содержимое в формате XML, добавляемое в файл unattend.xml для указанного пути и компонента. Размер XML-кода не должен превышать 4 КБ и должен содержать корневой элемент для вставляемого параметра или компонента.

passName

PassNames

Имя прохода. В настоящее время единственным допустимым значением является OobeSystem.

settingName

SettingNames

Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.

ApiEntityReference

Справочник по сущностям API.

Имя Тип Описание
id

string

Идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApplicationProfile

Содержит список приложений коллекции, которые должны быть доступны для виртуальной машины или VMSS.

Имя Тип Описание
galleryApplications

VMGalleryApplication[]

Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или 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

RepairAction

Тип действия восстановления (замена, перезапуск, создание образа), которое будет использоваться для восстановления неработоспособных виртуальных машин в масштабируемом наборе. Значение по умолчанию — replace.

BillingProfile

Указывает сведения о выставлении счетов для точечных виртуальных машин Azure или VMSS. Минимальная версия API: 2019-03-01.

Имя Тип Описание
maxPrice

number

Указывает максимальную цену, которую вы хотите заплатить за точечные виртуальные машины Azure или VMSS. Эта цена в долларах США.

Эта цена будет сравниваться с текущей ценой Azure Spot для размера виртуальной машины. Кроме того, цены сравниваются во время создания или обновления точечных виртуальных машин Azure или VMSS, и операция будет успешной, только если максимальная цена превышает текущую цену Azure Spot.

MaxPrice также будет использоваться для вытеснения точечных виртуальных машин Azure или VMSS, если текущая цена на точечные машины Azure выходит за пределы maxPrice после создания виртуальной машины или VMSS.

Возможны следующие значения:

— любое десятичное значение больше нуля. Пример: 0,01538

-1 — указывает цену по умолчанию по требованию.

Вы можете задать для параметра maxPrice значение -1, чтобы указать, что точечные виртуальные машины Azure или VMSS не должны быть исключены из цен. Кроме того, максимальная цена по умолчанию составляет -1, если она не предоставлена вами.

Минимальная версия API: 2019-03-01.

BootDiagnostics

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.

Имя Тип Описание
enabled

boolean

Указывает, должна ли на виртуальной машине быть включена загрузочная диагностика.

storageUri

string

URI учетной записи хранения, используемой для размещения выходных данных консоли и снимка экрана. Если параметр storageUri не указан при включении загрузочного диагностика, будет использоваться управляемое хранилище.

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

Имя Тип Описание
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

Параметры профиля резервирования емкости.

Имя Тип Описание
capacityReservationGroup

SubResource

Указывает идентификатор ресурса группы резервирования емкости, который должен использоваться для выделения экземпляров виртуальных машин или масштабируемого набора при условии, что зарезервировано достаточно ресурсов. Дополнительные сведения см https://aka.ms/CapacityReservation . в статье.

CloudError

Ответ об ошибке от службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

ComponentNames

Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.

Имя Тип Описание
Microsoft-Windows-Shell-Setup

string

DeleteOptions

Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины

Имя Тип Описание
Delete

string

Detach

string

DiagnosticsProfile

Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015.

Имя Тип Описание
bootDiagnostics

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

DiffDiskOptions

Указывает временные параметры диска для диска операционной системы.

placement

DiffDiskPlacement

Указывает временное размещение диска для диска операционной системы. Возможные значения: 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. Пользователь не может изменить параметр удаления для временного диска ОС.

Имя Тип Описание
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

Указывает, включены ли сетка событий и граф ресурсов для конфигураций, связанных с запланированными событиями.

ExpandTypesForGetVMScaleSets

Выражение expand, применяемое к операции. UserData извлекает свойство UserData масштабируемого набора виртуальных машин, предоставленного пользователем во время операции создания или обновления масштабируемого набора виртуальных машин.

Имя Тип Описание
userData

string

ExtendedLocation

Сложный тип расширенного расположения.

Имя Тип Описание
name

string

Имя расширенного расположения.

type

ExtendedLocationTypes

Тип расширенного расположения.

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

StatusLevelTypes

Код уровня.

message

string

Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.

time

string

Время состояния.

IPVersion

Доступно с Api-Version 2019-07-01, он указывает, является ли конкретная ip-конфигурация IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6.

Имя Тип Описание
IPv4

string

IPv6

string

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

Имя Тип Описание
secretUrl

string

URL-адрес, ссылающийся на секрет в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащий секрет.

LinuxConfiguration

Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в Azure-Endorsed Дистрибутивы.

Имя Тип Описание
disablePasswordAuthentication

boolean

Указывает, следует ли отключать проверку подлинности паролем.

enableVMAgentPlatformUpdates

boolean

Указывает, включена ли Обновления платформы VMAgent для виртуальной машины Linux. Значение по умолчанию — false.

patchSettings

LinuxPatchSettings

[Предварительная версия функции] Задает параметры, связанные с исправлением гостевой виртуальной машины в Linux.

provisionVMAgent

boolean

Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.

ssh

SshConfiguration

Указывает конфигурацию ключа SSH для операционной системы Linux.

LinuxPatchAssessmentMode

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.

Имя Тип Описание
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Linux.

Имя Тип Описание
assessmentMode

LinuxPatchAssessmentMode

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Задает дополнительные параметры для режима исправления AutomaticByPlatform в гостевой системе исправлений виртуальной машины в Linux.

patchMode

LinuxVMGuestPatchMode

Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого.

Возможны следующие значения:

ImageDefault — используется конфигурация исправлений виртуальной машины по умолчанию.

AutomaticByPlatform — виртуальная машина будет автоматически обновлена платформой. Свойство provisionVMAgent должно иметь значение true.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

Имя Тип Описание
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.

Имя Тип Описание
bypassPlatformSafetyChecksOnUserSchedule

boolean

Позволяет клиенту планировать установку исправлений без случайных обновлений

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений 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

WindowsPatchAssessmentMode

Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault — вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform — платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Задает дополнительные параметры для режима исправлений AutomaticByPlatform в гостевой системе исправлений виртуальной машины в Windows.

enableHotpatching

boolean

Позволяет клиентам исправлять свои виртуальные машины Azure без перезагрузки. Для enableHotpatching параметру provisionVMAgent необходимо задать значение true, а для patchMode — значение AutomaticByPlatform.

patchMode

WindowsVMGuestPatchMode

Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с orchestrationMode в качестве гибкого.

Возможны следующие значения:

Вручную — вы управляете применением исправлений на виртуальной машине. Это можно сделать, применив исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение false

AutomaticByOS — виртуальная машина будет автоматически обновлена операционной системой. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true.

AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

Plan

Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить его для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы .>. Введите необходимые сведения и нажмите кнопку Сохранить.

Имя Тип Описание
name

string

Идентификатор плана.

product

string

Указывает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе 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

Mode

Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не будет применять контроль доступа к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Режим принудительного применения.

PublicIPAddressSku

Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как Гибкий.

Имя Тип Описание
name

PublicIPAddressSkuName

Указание имени номера SKU общедоступного IP-адреса

tier

PublicIPAddressSkuTier

Указание уровня 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

ResilientVMCreationPolicy

Параметры конфигурации, используемые при создании отказоустойчивой виртуальной машины.

resilientVMDeletionPolicy

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

VirtualMachineScaleSetScaleInRules[]

Правила, которые следует соблюдать при масштабировании масштабируемого набора виртуальных машин.

Возможны следующие значения:

По умолчанию При масштабировании масштабируемого набора виртуальных машин он сначала распределяется между зонами, если это зональный масштабируемый набор. Затем он будет распределяться по доменам сбоя насколько это возможно. В каждом домене сбоя виртуальные машины, выбранные для удаления, будут новейшими, которые не защищены от масштабирования.

СтарыйVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны самые старые виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне для удаления будут выбраны самые старые виртуальные машины, которые не защищены.

NewestVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны новейшие виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне будут выбраны для удаления новейшие виртуальные машины, которые не защищены.

ScheduledEventsAdditionalPublishingTargets

Имя Тип Описание
eventGridAndResourceGraph

EventGridAndResourceGraph

Параметры конфигурации, используемые при создании параметра eventGridAndResourceGraph Scheduled Event.

ScheduledEventsPolicy

Указывает конфигурации, связанные с повтором развертывания, перезагрузки и scheduledEventsAdditionalPublishingTargets Scheduled Event.

Имя Тип Описание
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

Параметры конфигурации, используемые при публикации scheduledEventsAdditionalPublishingTargets.

userInitiatedReboot

UserInitiatedReboot

Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedReboot.

userInitiatedRedeploy

UserInitiatedRedeploy

Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedRedeploy.

ScheduledEventsProfile

Имя Тип Описание
osImageNotificationProfile

OSImageNotificationProfile

Указывает конфигурации, связанные с запланированным событием образа ОС.

terminateNotificationProfile

TerminateNotificationProfile

Указывает конфигурации, связанные с запланированными событиями завершения.

securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

Имя Тип Описание
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityPostureReference

Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01

Имя Тип Описание
excludeExtensions

VirtualMachineExtension[]

Список расширений виртуальных машин, которые следует исключить при применении состояния безопасности.

id

string

Идентификатор ссылки на состояние безопасности в формате /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest

SecurityProfile

Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.

Имя Тип Описание
encryptionAtHost

boolean

Это свойство может использоваться пользователем в запросе для включения или отключения шифрования узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая ресурс или временный диск на самом узле. Поведение по умолчанию: Шифрование на узле будет отключено, если это свойство не имеет значение true для ресурса.

encryptionIdentity

EncryptionIdentity

Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей.

proxyAgentSettings

ProxyAgentSettings

Указывает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01.

securityType

SecurityTypes

Указывает тип безопасности виртуальной машины. Чтобы включить UefiSettings, ему необходимо задать любое указанное значение. Поведение по умолчанию: 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/{serviceArtifacts}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.

Имя Тип Описание
AutoLogon

string

FirstLogonCommands

string

Sku

Описывает номер SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, на которое в настоящее время находится масштабируемый набор, необходимо отменить выделение виртуальных машин в масштабируемом наборе, прежде чем изменять имя SKU.

Имя Тип Описание
capacity

integer

Указывает количество виртуальных машин в масштабируемом наборе.

name

string

Имя SKU.

tier

string

Указывает уровень виртуальных машин в масштабируемом наборе.

Возможные значения:

Standard Edition

Основной

SpotRestorePolicy

Задает свойства Spot-Try-Restore для масштабируемого набора виртуальных машин. С помощью этого свойства клиент может включить или отключить автоматическое восстановление экземпляров точечных виртуальных машин VMSS оппортунистически на основе доступности емкости и ценового ограничения.

Имя Тип Описание
enabled

boolean

Включает функцию spot-try-restore, при которой вытесняемые экземпляры VMSS SPOT будут пытаться восстановить оппортунистически на основе доступности емкости и ценовых ограничений.

restoreTimeout

string

Значение времени ожидания, выраженное в формате ISO 8601, по истечении которого платформа не будет пытаться восстановить экземпляры VMSS SPOT.

SshConfiguration

Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure

Имя Тип Описание
publicKeys

SshPublicKey[]

Список открытых ключей 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

AutomaticOSUpgradePolicy

Параметры конфигурации, используемые для автоматического обновления ОС.

mode

UpgradeMode

Указывает режим обновления до виртуальных машин в масштабируемом наборе.

Возможны следующие значения:

Вручную . Вы управляете применением обновлений к виртуальным машинам в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.

Автоматически — все виртуальные машины в масштабируемом наборе обновляются автоматически одновременно.

rollingUpgradePolicy

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:

{
"data":"",
"dataType":"pfx",
"password":""
}
Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

VaultSecretGroup

Описывает набор сертификатов, которые находятся в одном Key Vault.

Имя Тип Описание
sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащий все сертификаты в VaultCertificates.

vaultCertificates

VaultCertificate[]

Список ссылок на хранилища ключей в SourceVault, которые содержат сертификаты.

VirtualHardDisk

Описывает универсальный код ресурса (URI) диска.

Имя Тип Описание
uri

string

Указывает универсальный код ресурса (URI) виртуального жесткого диска.

VirtualMachineEvictionPolicyTypes

Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как "Отменить выделение", так и "Удалить", а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как Deallocate, так и Delete, а минимальная версия 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

VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

properties.protectedSettings

object

Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Расширения защищают параметры, которые передаются по ссылке и используются из хранилища ключей.

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

InstanceViewStatus[]

Сведения о состоянии ресурса.

substatuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

type

string

Указывает тип расширения; пример : CustomScriptExtension.

typeHandlerVersion

string

Указывает версию обработчика скрипта.

VirtualMachinePriorityTypes

Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview.

Имя Тип Описание
Low

string

Regular

string

Spot

string

VirtualMachineScaleSet

Описывает масштабируемый набор виртуальных машин.

Имя Тип Описание
etag

string

Etag — это свойство, возвращаемое при создании, обновлении или получении ответа VMSS, чтобы клиент смог указать его в заголовке для обеспечения оптимистичных обновлений.

extendedLocation

ExtendedLocation

Расширенное расположение масштабируемого набора виртуальных машин.

id

string

Идентификатор ресурса

identity

VirtualMachineScaleSetIdentity

Удостоверение масштабируемого набора виртуальных машин, если оно настроено.

location

string

Расположение ресурса

name

string

Имя ресурса

plan

Plan

Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить его для программного использования. В портал Azure найдите образ Marketplace, который вы хотите использовать, и нажмите кнопку Захотеть развернуть программным способом, Начало работы .>. Введите необходимые сведения и нажмите кнопку Сохранить.

properties.additionalCapabilities

AdditionalCapabilities

Указывает дополнительные возможности, включенные или отключенные на Виртуальные машины в масштабируемом наборе виртуальных машин. Например, может ли Виртуальные машины поддерживать подключение управляемых дисков данных с UltraSSD_LRS типом учетной записи хранения.

properties.automaticRepairsPolicy

AutomaticRepairsPolicy

Политика для автоматического восстановления.

properties.constrainedMaximumCapacity

boolean

Необязательное свойство, для которого должно быть задано значение True или опущено.

properties.doNotRunExtensionsOnOverprovisionedVMs

boolean

Если включена избыточная подготовка, расширения запускаются только на запрошенном количестве виртуальных машин, которые, наконец, сохранены. Таким образом, это свойство гарантирует, что расширения не будут работать на дополнительных избыточных виртуальных машинах.

properties.hostGroup

SubResource

Указывает сведения о выделенной группе узлов, в которой находится масштабируемый набор виртуальных машин. Минимальная версия API: 2020-06-01.

properties.orchestrationMode

OrchestrationMode

Указывает режим оркестрации для масштабируемого набора виртуальных машин.

properties.overprovision

boolean

Указывает, следует ли перепроектировать масштабируемый набор виртуальных машин.

properties.platformFaultDomainCount

integer

Количество доменов сбоя для каждой группы размещения.

properties.priorityMixPolicy

PriorityMixPolicy

Указывает нужные целевые объекты для смешивания точечных и обычных приоритетных виртуальных машин в одном экземпляре VMSS Flex.

properties.provisioningState

string

Состояние подготовки, которое отображается только в ответе.

properties.proximityPlacementGroup

SubResource

Указывает сведения о группе размещения близкого взаимодействия, которым должен быть назначен масштабируемый набор виртуальных машин. Минимальная версия API: 2018-04-01.

properties.resiliencyPolicy

ResiliencyPolicy

Политика устойчивости

properties.scaleInPolicy

ScaleInPolicy

Указывает политики, применяемые при масштабировании в Виртуальные машины в масштабируемом наборе виртуальных машин.

properties.scheduledEventsPolicy

ScheduledEventsPolicy

The ScheduledEventsPolicy.

properties.singlePlacementGroup

boolean

Если значение равно true, это ограничивает масштабируемый набор одной группой размещения с максимальным размером 100 виртуальных машин. ПРИМЕЧАНИЕ. Если singlePlacementGroup имеет значение true, его можно изменить на false. Однако, если значением является false, его не возможно изменить на true.

properties.spotRestorePolicy

SpotRestorePolicy

Задает свойства точечного восстановления для масштабируемого набора виртуальных машин.

properties.timeCreated

string

Указывает время создания ресурса масштабируемого набора виртуальных машин. Минимальная версия API: 2021-11-01.

properties.uniqueId

string

Указывает идентификатор, который однозначно идентифицирует масштабируемый набор виртуальных машин.

properties.upgradePolicy

UpgradePolicy

Политика обновления.

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

Профиль виртуальной машины.

properties.zoneBalance

boolean

Следует ли принудительно использовать строго равномерное распределение виртуальных машин между зонами X в случае сбоя зоны. Свойство zoneBalance можно задать, только если свойство zones масштабируемого набора содержит несколько зон. Если зоны не указаны или указана всего одна зона, свойство ZoneBalance задавать не следует.

sku

Sku

Номер SKU масштабируемого набора виртуальных машин.

tags

object

Теги ресурсов

type

string

Тип ресурса

zones

string[]

Зоны масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Зоны доступности можно задать только при создании масштабируемого набора.

VirtualMachineScaleSetDataDisk

Описывает диск данных масштабируемого набора виртуальных машин.

Имя Тип Описание
caching

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

createOption

DiskCreateOptionTypes

Параметр create.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять диск данных или отсоединять его после гибкого удаления VMSS (эта функция доступна только для VMSS с гибким orchestrationMode).

Возможные значения:

Удалить Если используется это значение, диск данных удаляется при удалении виртуальной машины VMSS Flex.

Отсоединить Если используется это значение, диск данных сохраняется после удаления виртуальной машины VMSS Flex.

По умолчанию задано значение Delete.

diskIOPSReadWrite

integer

Указывает Read-Write операций ввода-вывода в секунду для управляемого диска. Следует использовать только в том случае, если StorageAccountType имеет UltraSSD_LRS. Если этот параметр не указан, будет присвоено значение по умолчанию на основе diskSizeGB.

diskMBpsReadWrite

integer

Указывает пропускную способность управляемого диска в МБ в секунду. Следует использовать только в том случае, если StorageAccountType имеет UltraSSD_LRS. Если этот параметр не указан, будет присвоено значение по умолчанию на основе diskSizeGB.

diskSizeGB

integer

Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это количество байтов x 1024^3 для диска, и значение не может быть больше 1023.

lun

integer

Указывает номер логической единицы диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине.

managedDisk

VirtualMachineScaleSetManagedDiskParameters

Параметры управляемого диска.

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

KeyVaultSecretReference

Расширения защищают параметры, которые передаются по ссылке и используются из хранилища ключей.

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

VirtualMachineScaleSetExtension[]

Дочерние ресурсы расширения масштабируемого набора виртуальных машин.

extensionsTimeBudget

string

Указывает время, отведенное для запуска всех расширений. Длительность должна быть от 15 до 120 минут (включительно) и должна быть указана в формате ISO 8601. Значение по умолчанию — 90 минут (PT1H30M). Минимальная версия API: 2020-06-01.

VirtualMachineScaleSetHardwareProfile

Задает параметры оборудования для масштабируемого набора виртуальных машин.

Имя Тип Описание
vmSizeProperties

VMSizeProperties

Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-11-01. Следуйте инструкциям в разделе Настройка виртуальной машины для получения дополнительных сведений.

VirtualMachineScaleSetIdentity

Удостоверение для масштабируемого набора виртуальных машин.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения масштабируемого набора виртуальных машин. Это свойство будет предоставлено только для удостоверения, назначаемого системой.

tenantId

string

Идентификатор клиента, связанный с масштабируемым набором виртуальных машин. Это свойство будет предоставлено только для удостоверения, назначаемого системой.

type

ResourceIdentityType

Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из масштабируемого набора виртуальных машин.

userAssignedIdentities

UserAssignedIdentities

Список удостоверений пользователей, связанных с масштабируемым набором виртуальных машин. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

VirtualMachineScaleSetIPConfiguration

Описывает IP-конфигурацию сетевого профиля масштабируемого набора виртуальных машин.

Имя Тип Описание
name

string

Имя IP-конфигурации.

properties.applicationGatewayBackendAddressPools

SubResource[]

Задает массив ссылок на серверные пулы адресов шлюзов приложений. Масштабируемый набор может ссылаться на серверные пулы адресов нескольких шлюзов приложений. Несколько масштабируемых наборов не могут использовать один и тот же шлюз приложений.

properties.applicationSecurityGroups

SubResource[]

Задает массив ссылок на группу безопасности приложений.

properties.loadBalancerBackendAddressPools

SubResource[]

Задает массив ссылок на серверные пулы адресов подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на серверные пулы адресов одного общедоступного и одного внутреннего балансировщика нагрузки. Несколько масштабируемых наборов не могут использовать одну и ту же подсистему балансировки нагрузки ценовой категории "Базовый".

properties.loadBalancerInboundNatPools

SubResource[]

Задает массив ссылок на входящие пулы NAT подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на входящие пулы NAT одного общедоступного и одного внутреннего балансировщика нагрузки. Несколько масштабируемых наборов не могут использовать одну и ту же подсистему балансировки нагрузки ценовой категории "Базовый".

properties.primary

boolean

Указывает основной сетевой интерфейс, если виртуальная машина имеет более 1 сетевого интерфейса.

properties.privateIPAddressVersion

IPVersion

Доступно с Api-Version 2017-03-30 и более поздних, он указывает, является ли конкретная ipconfiguration IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6.

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

PublicIPAddressConfiguration.

properties.subnet

ApiEntityReference

Указывает идентификатор подсети.

VirtualMachineScaleSetIpTag

Содержит тег IP, связанный с общедоступным IP-адресом.

Имя Тип Описание
ipTagType

string

Тип тега IP. Пример: FirstPartyUsage.

tag

string

Тег IP, связанный с общедоступным IP-адресом. Пример: SQL, хранилище и т. д.

VirtualMachineScaleSetManagedDiskParameters

Описывает параметры управляемого диска ScaleSet.

Имя Тип Описание
diskEncryptionSet

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.

securityProfile

VMDiskSecurityProfile

Указывает профиль безопасности для управляемого диска.

storageAccountType

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

VirtualMachineScaleSetNetworkConfiguration

Описывает сетевые конфигурации сетевого профиля масштабируемого набора виртуальных машин.

Имя Тип Описание
name

string

Имя конфигурации сети.

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

Указывает, включен ли вспомогательный SKU для ресурса сетевого интерфейса.

properties.deleteOption

DeleteOptions

Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины

properties.disableTcpStateTracking

boolean

Указывает, отключен ли сетевой интерфейс для отслеживания состояния TCP.

properties.dnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Параметры DNS, применяемые к сетевым интерфейсам.

properties.enableAcceleratedNetworking

boolean

Указывает, включен ли сетевой интерфейс с поддержкой ускорения сети.

properties.enableFpga

boolean

Указывает, включен ли сетевой интерфейс ППВМ с поддержкой сети.

properties.enableIPForwarding

boolean

Включена ли IP-пересылка на этом сетевом адаптере.

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

Задает IP-конфигурации сетевого интерфейса.

properties.networkSecurityGroup

SubResource

Группа безопасности сети.

properties.primary

boolean

Указывает основной сетевой интерфейс, если виртуальная машина имеет более 1 сетевого интерфейса.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.

Имя Тип Описание
dnsServers

string[]

Список IP-адресов DNS-серверов

VirtualMachineScaleSetNetworkProfile

Описывает сетевой профиль масштабируемого набора виртуальных машин.

Имя Тип Описание
healthProbe

ApiEntityReference

Ссылка на пробу подсистемы балансировки нагрузки, используемую для определения работоспособности экземпляра в масштабируемом наборе виртуальных машин. Ссылка будет иметь следующий вид: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}.

networkApiVersion

NetworkApiVersion

указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса для масштабируемого набора виртуальных машин с режимом оркестрации "Гибкий".

networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

Список конфигураций сети.

VirtualMachineScaleSetOSDisk

Описывает диск операционной системы масштабируемого набора виртуальных машин.

Имя Тип Описание
caching

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

createOption

DiskCreateOptionTypes

Указывает способ создания виртуальных машин в масштабируемом наборе. Единственное допустимое значение: FromImage. Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, вы также используете элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также используете элемент плана, описанный выше.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении VMSS Flex (эта функция доступна только для VMSS с гибким orchestrationMode).

Возможные значения:

Удалить Если это значение используется, диск ОС удаляется при удалении виртуальной машины VMSS Flex.

Отсоединить Если это значение используется, диск ОС сохраняется после удаления виртуальной машины VMSS Flex.

По умолчанию задано значение Delete. Для временного диска ОС значением по умолчанию является Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

diffDiskSettings

DiffDiskSettings

Указывает временные параметры диска для диска операционной системы, используемого масштабируемым набором виртуальных машин.

diskSizeGB

integer

Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство "diskSizeGB" — это количество байтов x 1024^3 для диска и не может быть больше 1023.

image

VirtualHardDisk

Указывает сведения о неуправляемом пользовательском образе, на котором будет основываться масштабируемый набор.

managedDisk

VirtualMachineScaleSetManagedDiskParameters

Параметры управляемого диска.

name

string

имя диска.

osType

OperatingSystemTypes

Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.

vhdContainers

string[]

Указывает URL-адреса контейнера, используемые для хранения дисков операционной системы для масштабируемого набора.

writeAcceleratorEnabled

boolean

Указывает, следует ли включить или отключить writeAccelerator на диске.

VirtualMachineScaleSetOSProfile

Описывает профиль ОС масштабируемого набора виртуальных машин.

Имя Тип Описание
adminPassword

string

Указывает пароль учетной записи администратора.

Минимальная длина (Windows): 8 символов

Минимальная длина (Linux): 6 символов

Максимальная длина (Windows): 123 символа

Максимальная длина (Linux): 72 символа

Требования к сложности: 3 из 4 условий, приведенных ниже, должны быть выполнены
Содержит более низкие символы
Содержит верхние символы
Имеет цифру
Имеет специальный символ (соответствие регулярного выражения [\W_])

Запрещенные значения: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

Сведения о сбросе пароля см. в статье Как сбросить пароль для входа в службу удаленного рабочего стола на виртуальной машине Windows.

Сведения о сбросе пароля привилегированного пользователя см. в статье Управление пользователями, SSH и проверка или восстановление дисков на виртуальных машинах Linux в Azure с помощью расширения VMAccess.

adminUsername

string

Указывает имя учетной записи администратора.

Ограничение только для Windows: Не может заканчиваться на "."

Запрещенные значения: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Минимальная длина (Linux): 1 символ

Максимальная длина (Linux): 64 символа

Максимальная длина (Windows): 20 символов

allowExtensionOperations

boolean

Указывает, следует ли разрешать операции расширения в масштабируемом наборе виртуальных машин. Для этого параметра может быть задано значение False, только если в масштабируемом наборе виртуальных машин нет расширений.

computerNamePrefix

string

Указывает префикс имени компьютера для всех виртуальных машин в масштабируемом наборе. Префиксы имени компьютера должны содержать от 1 до 15 символов.

customData

string

Указывает строку пользовательских данных в кодировке base-64. Строка в кодировке base-64 кодируется в двоичный массив, который сохраняется в виде файла на виртуальной машине. Максимальная длина двоичного массива — 65 535 байт. Сведения об использовании cloud-init для виртуальной машины см. в статье Использование cloud-init для настройки виртуальной машины Linux во время создания.

linuxConfiguration

LinuxConfiguration

Задает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в дистрибутивах Azure-Endorsed.

requireGuestProvisionSignal

boolean

Необязательное свойство, для которого должно быть задано значение True или опущено.

secrets

VaultSecretGroup[]

Указывает набор сертификатов, которые должны быть установлены на виртуальных машинах в масштабируемом наборе. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

windowsConfiguration

WindowsConfiguration

Указывает параметры операционной системы Windows на виртуальной машине.

VirtualMachineScaleSetPublicIPAddressConfiguration

Описание конфигурации IP-адреса конфигурации масштабируемого набора виртуальных машин PublicIPAddress

Имя Тип Описание
name

string

Имя конфигурации адреса publicIP.

properties.deleteOption

DeleteOptions

Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Параметры DNS, применяемые к общедоступным IP-адресам.

properties.idleTimeoutInMinutes

integer

Время ожидания простоя общедоступного IP-адреса.

properties.ipTags

VirtualMachineScaleSetIpTag[]

Список тегов IP-адресов, связанных с общедоступным IP-адресом.

properties.publicIPAddressVersion

IPVersion

Доступно с Api-Version 2019-07-01, он указывает, является ли конкретная ip-конфигурация IPv4 или IPv6. Значение по умолчанию принимается как IPv4. Возможные значения: IPv4 и IPv6.

properties.publicIPPrefix

SubResource

PublicIPPrefix, из которого следует выделить общедоступные IP-адреса.

sku

PublicIPAddressSku

Описывает номер SKU общедоступного IP-адреса. Его можно задать только с параметром OrchestrationMode как Гибкий.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Описывает параметры DNS конфигурации сети масштабируемых наборов виртуальных машин.

Имя Тип Описание
domainNameLabel

string

Метка доменного имени. Объединение метки доменного имени и индекса виртуальной машины будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы.

domainNameLabelScope

DomainNameLabelScopeTypes

Метка доменного имени область. Объединение хэшируемой метки доменного имени, созданной в соответствии с политикой из метки доменного имени область и индекса виртуальной машины, будет являться метками доменных имен ресурсов PublicIPAddress, которые будут созданы.

VirtualMachineScaleSetScaleInRules

Правила, которые следует соблюдать при масштабировании масштабируемого набора виртуальных машин.

Возможны следующие значения:

По умолчанию При масштабировании масштабируемого набора виртуальных машин он сначала распределяется между зонами, если это зональный масштабируемый набор. Затем он будет распределяться по доменам сбоя насколько это возможно. В каждом домене сбоя виртуальные машины, выбранные для удаления, будут новейшими, которые не защищены от масштабирования.

СтарыйVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны самые старые виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне для удаления будут выбраны самые старые виртуальные машины, которые не защищены.

NewestVM При масштабировании масштабируемого набора виртуальных машин для удаления будут выбраны новейшие виртуальные машины, которые не защищены от масштабирования. Для зональных масштабируемых наборов виртуальных машин масштабируемый набор сначала распределяется между зонами. В каждой зоне будут выбраны для удаления новейшие виртуальные машины, которые не защищены.

Имя Тип Описание
Default

string

NewestVM

string

OldestVM

string

VirtualMachineScaleSetStorageProfile

Описывает профиль хранения масштабируемого набора виртуальных машин.

Имя Тип Описание
dataDisks

VirtualMachineScaleSetDataDisk[]

Указывает параметры, используемые для добавления дисков данных на виртуальные машины в масштабируемом наборе. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

diskControllerType

DiskControllerTypes[]

Указывает тип контроллера диска, настроенный для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2022-08-01

imageReference

ImageReference

Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.

osDisk

VirtualMachineScaleSetOSDisk

Указывает сведения о диске операционной системы, используемом виртуальными машинами в масштабируемом наборе. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

VirtualMachineScaleSetVMProfile

Описывает профиль виртуальной машины масштабируемого набора виртуальных машин.

Имя Тип Описание
applicationProfile

ApplicationProfile

Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS.

billingProfile

BillingProfile

Указывает сведения о точечных VMSS Azure, связанные с выставлением счетов. Минимальная версия API: 2019-03-01.

capacityReservation

CapacityReservationProfile

Указывает сведения о резервировании емкости масштабируемого набора. Минимальная версия API: 2021-04-01.

diagnosticsProfile

DiagnosticsProfile

Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015.

evictionPolicy

VirtualMachineEvictionPolicyTypes

Указывает политику вытеснения для точечных виртуальных машин Azure и точечных масштабируемых наборов Azure. Для точечных виртуальных машин Azure поддерживаются как "Отменить выделение", так и "Удалить", а минимальная версия API — 2019-03-01. Для точечных масштабируемых наборов Azure поддерживаются как Deallocate, так и Delete, а минимальная версия API — 2017-10-30-preview.

extensionProfile

VirtualMachineScaleSetExtensionProfile

Задает коллекцию параметров для расширений, установленных на виртуальных машинах в масштабируемом наборе.

hardwareProfile

VirtualMachineScaleSetHardwareProfile

Указывает сведения, связанные с профилем оборудования для масштабируемого набора. Минимальная версия API: 2021-11-01.

licenseType

string

Указывает, что используемый образ или диск были лицензированы локально.

Возможные значения операционной системы Windows Server:

Windows_Client

Windows_Server

Возможные значения для операционной системы Linux Server:

RHEL_BYOS (для RHEL)

SLES_BYOS (для SUSE)

Дополнительные сведения см. в статье Преимущество гибридного использования Azure для Windows Server.

Преимущество гибридного использования Azure для сервера Linux

Минимальная версия API: 15.06.2015

networkProfile

VirtualMachineScaleSetNetworkProfile

Задает свойства сетевых интерфейсов виртуальных машин в масштабируемом наборе.

osProfile

VirtualMachineScaleSetOSProfile

Задает параметры операционной системы для виртуальных машин в масштабируемом наборе.

priority

VirtualMachinePriorityTypes

Указывает приоритет для виртуальных машин в масштабируемом наборе. Минимальная версия API: 2017-10-30-preview.

scheduledEventsProfile

ScheduledEventsProfile

Указывает конфигурации, связанные с запланированными событиями.

securityPostureReference

SecurityPostureReference

Указывает состояние безопасности, которое будет использоваться для всех виртуальных машин в масштабируемом наборе. Минимальная версия API: 2023-03-01

securityProfile

SecurityProfile

Задает параметры профиля, связанного с безопасностью, для виртуальных машин в масштабируемом наборе.

serviceArtifactReference

ServiceArtifactReference

Указывает идентификатор ссылки на артефакт службы, используемый для задания одинаковой версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Минимальная версия API: 2022-11-01

storageProfile

VirtualMachineScaleSetStorageProfile

Указывает параметры хранилища дисков виртуальной машины.

timeCreated

string

Указывает время создания этого профиля виртуальной машины для масштабируемого набора виртуальных машин. Минимальная версия API для этого свойства — 2024-03-01. Это значение будет добавлено к тегам виртуальной машины VMSS Flex при создании или обновлении профиля виртуальной машины VMSS с минимальной версией API 2024-03-01.

userData

string

UserData для виртуальных машин в масштабируемом наборе, которые должны быть закодированы в кодировке Base-64. Клиент не должен передавать здесь какие-либо секреты. Минимальная версия API: 2021-03-01.

VMDiskSecurityProfile

Задает параметры профиля безопасности для управляемого диска. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

Имя Тип Описание
diskEncryptionSet

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного ключа конфиденциальной виртуальной машины и большого двоичного объекта VMGuest.

securityEncryptionType

securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте 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

AdditionalUnattendContent[]

Задает дополнительные сведения в кодировке base-64 и в формате XML, которые могут включаться в файл Unattend.xml, используемый программой установки Windows.

enableAutomaticUpdates

boolean

Указывает, включено ли автоматическое Обновления для виртуальной машины Windows. Значение по умолчанию — true. Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС.

enableVMAgentPlatformUpdates

boolean

Указывает, включена ли платформа VMAgent Обновления для виртуальной машины Windows. Значение по умолчанию — false.

patchSettings

PatchSettings

[Предварительная версия функции] Задает параметры, связанные с исправлением гостевой виртуальной машины в Windows.

provisionVMAgent

boolean

Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.

timeZone

string

Указывает часовой пояс виртуальной машины. Например, "Тихоокеанское стандартное время". Возможные значения можно TimeZoneInfo.Id из часовых поясов, возвращаемых TimeZoneInfo.GetSystemTimeZones.

winRM

WinRMConfiguration

Указывает прослушиватели удаленного управления 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

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений 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

WinRMListener[]

Список прослушивателей удаленного управления Windows

WinRMListener

Описание протокола и отпечатка прослушивателя удаленного управления Windows

Имя Тип Описание
certificateUrl

string

Это URL-адрес сертификата, переданного в Key Vault в виде секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

protocol

ProtocolTypes

Указывает протокол прослушивателя WinRM. Возможные значения: http,https.