Поделиться через


Virtual Machine Scale Sets - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2024-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2024-07-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

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

Ответы

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

VirtualMachineScaleSet

ХОРОШО

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Образец запроса

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

Пример ответа

{
  "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.

Образец запроса

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

Пример ответа

{
  "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

Образец запроса

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

Пример ответа

{
  "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

Образец запроса

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

Пример ответа

{
  "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. Содержимое определяется по имени, имени компонента и передаче, в которой применяется содержимое.

AllocationStrategy

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

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: 2015-06-15.

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 для получения маркера доступа для операций keyvault.

EventGridAndResourceGraph

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

ExpandTypesForGetVMScaleSets

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

ExtendedLocation

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

ExtendedLocationTypes

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

ImageReference

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

InnerError

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

IPVersion

Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration 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, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.

PriorityMixPolicy

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

ProtocolTypes

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

ProxyAgentSettings

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

PublicIPAddressSku

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

PublicIPAddressSkuName

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

PublicIPAddressSkuTier

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

RepairAction

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

ResiliencyPolicy

Описывает политику устойчивости — устойчивыйVMCreationPolicy и/или устойчивыйVMDeletionPolicy.

ResilientVMCreationPolicy

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

ResilientVMDeletionPolicy

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

ResourceIdentityType

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

RollingUpgradePolicy

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

ScaleInPolicy

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

ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy

Указывает конфигурации для повторного развертывания, перезагрузки и scheduledEventsAdditionalPublishingTargets Scheduled event.

ScheduledEventsProfile
securityEncryptionTypes

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

SkuProfile

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

SkuProfileVMSize

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

SpotRestorePolicy

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

SshConfiguration

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

SshPublicKey

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

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

Описывает набор сертификатов, которые находятся в одном хранилище ключей.

VirtualHardDisk

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

VirtualMachineEvictionPolicyTypes

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

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

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

VirtualMachineScaleSetScaleInRules

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

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

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

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

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

ZonalPlatformFaultDomainAlignMode

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

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.

AllocationStrategy

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

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

string

LowestPrice

string

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. Затем обновление откладывается до утверждения обновления с помощью вызова ApprovedRollingUpgrade.

useRollingUpgradePolicy

boolean

Указывает, следует ли использовать политику последовательного обновления во время автоматического обновления ОС. Значение по умолчанию — false. Автоматическое обновление ОС откатится к политике по умолчанию, если политика не определена в VMSS.

AutomaticRepairsPolicy

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

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

boolean

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

gracePeriod

string

Время приостановки автоматического восстановления из-за изменения состояния на виртуальной машине. Время отсрочки начинается после завершения изменения состояния. Это помогает избежать преждевременного или случайного восстановления. Длительность времени должна быть указана в формате ISO 8601. Минимальный допустимый льготный период — 10 минут (PT10M), который также является значением по умолчанию. Максимальный допустимый льготный период составляет 90 минут (PT90M).

repairAction

RepairAction

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

BillingProfile

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

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

number

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

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

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

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

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

-1 — указывает, что цена по умолчанию должна быть up-to по запросу.

Значение maxPrice можно задать для -1, чтобы указать, что виртуальная машина или виртуальная машина Azure не должна быть вытесна по соображениям цены. Кроме того, максимальная цена по умолчанию -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: 2015-06-15.

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

BootDiagnostics

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. ПРИМЕЧАНИЕ. Если указан URI хранилища, убедитесь, что учетная запись хранения находится в том же регионе и подписке, что и виртуальная машина. Вы можете легко просмотреть выходные данные журнала консоли. 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 для получения маркера доступа для операций keyvault.

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

string

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

EventGridAndResourceGraph

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

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

boolean

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

ExpandTypesForGetVMScaleSets

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

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

string

ExtendedLocation

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

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

string

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

type

ExtendedLocationTypes

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

ExtendedLocationTypes

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

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

string

ImageReference

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

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

string

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

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. Основные, незначительные и сборки — это десятичные числа. Укажите "последняя", чтобы использовать последнюю версию образа, доступного во время развертывания. Даже если вы используете "последнюю версию", образ виртуальной машины не будет автоматически обновляться после развертывания, даже если новая версия станет доступной. Не используйте поле "версия" для развертывания образа коллекции, образ коллекции всегда должен использовать поле "id" для развертывания, чтобы использовать последнюю версию образа коллекции, просто установить "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле "id" без ввода версии.

InnerError

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

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

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

IPVersion

Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".

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

string

IPv6

string

KeyVaultSecretReference

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

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

string

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

sourceVault

SubResource

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

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 без перезагрузки. Для включенияHotpatching для параметра 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, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.

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

string

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

product

string

Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference.

promotionCode

string

Код повышения.

publisher

string

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

PriorityMixPolicy

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

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

integer

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

regularPriorityPercentageAboveBase

integer

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

ProtocolTypes

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

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

string

Https

string

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-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

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

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

string

Replace

string

Restart

string

ResiliencyPolicy

Описывает политику устойчивости — устойчивыйVMCreationPolicy и/или устойчивыйVMDeletionPolicy.

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

ResilientVMCreationPolicy

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

resilientVMDeletionPolicy

ResilientVMDeletionPolicy

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

ResilientVMCreationPolicy

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

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

boolean

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

ResilientVMDeletionPolicy

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

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

boolean

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

ResourceIdentityType

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

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

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

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

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

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

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

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

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityPostureReference

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

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

string[]

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

id

string

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

isOverridable

boolean

Можно ли переопределить состояние безопасности пользователем.

SecurityProfile

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

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

boolean

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

encryptionIdentity

EncryptionIdentity

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

proxyAgentSettings

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-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/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

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

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

string

FirstLogonCommands

string

Sku

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

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

integer

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

name

string

Имя SKU.

tier

string

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

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

категории "Стандартный"

базовый

SkuProfile

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

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

AllocationStrategy

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

vmSizes

SkuProfileVMSize[]

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

SkuProfileVMSize

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

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

string

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

SpotRestorePolicy

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

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

Указывает, включено или отключено ли событие завершения.

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 с именем файла <TopcaseThumbprint>.crt для файла сертификата X509 и <TopcaseThumbprint>.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

Описывает набор сертификатов, которые находятся в одном хранилище ключей.

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

SubResource

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

vaultCertificates

VaultCertificate[]

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

VirtualHardDisk

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

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

string

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

VirtualMachineEvictionPolicyTypes

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

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

string

Delete

string

VirtualMachinePriorityTypes

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

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

string

Regular

string

Spot

string

VirtualMachineScaleSet

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

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

string

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

extendedLocation

ExtendedLocation

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

id

string

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

identity

VirtualMachineScaleSetIdentity

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

location

string

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

name

string

Имя ресурса

plan

Plan

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

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

Указывает нужные целевые объекты для смешивания виртуальных машин с приоритетом Spot и Regular в одном экземпляре 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. Однако если singlePlacementGroup имеет значение false, он может не быть изменен на true.

properties.skuProfile

SkuProfile

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

properties.spotRestorePolicy

SpotRestorePolicy

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

properties.timeCreated

string

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

properties.uniqueId

string

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

properties.upgradePolicy

UpgradePolicy

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

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

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

properties.zonalPlatformFaultDomainAlignMode

ZonalPlatformFaultDomainAlignMode

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

properties.zoneBalance

boolean

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

sku

Sku

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

tags

object

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

type

string

Тип ресурса

zones

string[]

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

VirtualMachineScaleSetDataDisk

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

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

CachingTypes

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

createOption

DiskCreateOptionTypes

Параметр создания.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск данных при удалении VMSS Flex (эта функция доступна только для 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

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

VirtualMachineScaleSetExtension

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

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

string

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

name

string

Имя расширения.

properties.autoUpgradeMinorVersion

boolean

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

properties.enableAutomaticUpgrade

boolean

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

properties.forceUpdateTag

string

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

properties.protectedSettings

object

Расширение может содержать защищенные параметрыSettings или 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 включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из масштабируемого набора виртуальных машин.

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[]

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

properties.loadBalancerInboundNatPools

SubResource[]

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

properties.primary

boolean

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

properties.privateIPAddressVersion

IPVersion

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

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

PublicIPAddressConfiguration.

properties.subnet

ApiEntityReference

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

VirtualMachineScaleSetIpTag

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

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

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

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

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

VirtualMachineScaleSetOSProfile

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

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

string

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

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

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

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

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

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

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

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

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

adminUsername

string

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

ограничение только для Windows: не удается завершить ".

Запрещенные значения: "администратор", "admin", "user1", "user1", "test2", "test1", "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

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

computerNamePrefix

string

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

customData

string

Задает строку в кодировке base-64 пользовательских данных. Строка в кодировке Base-64 декодируется в двоичный массив, сохраненный в виде файла на виртуальной машине. Максимальная длина двоичного массива составляет 65535 байтов. Сведения об использовании 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

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

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

string

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

properties.deleteOption

DeleteOptions

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

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Параметры DNS, применяемые к общедоступным АДРЕСАм.

properties.idleTimeoutInMinutes

integer

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

properties.ipTags

VirtualMachineScaleSetIpTag[]

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

properties.publicIPAddressVersion

IPVersion

Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".

properties.publicIPPrefix

SubResource

PublicIPPrefix, из которого следует выделить адреса publicIP.

sku

PublicIPAddressSku

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

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

string

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

domainNameLabelScope

DomainNameLabelScopeTypes

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

VirtualMachineScaleSetScaleInRules

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

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

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

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

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

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

capacityReservation

CapacityReservationProfile

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

diagnosticsProfile

DiagnosticsProfile

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

evictionPolicy

VirtualMachineEvictionPolicyTypes

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

Минимальная версия API: 2015-06-15

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

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

userData

string

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

VMDiskSecurityProfile

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

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

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора ресурсов шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного диска ОПЕРАЦИОННОй системы Конфиденциальной виртуальной машины и большого двоичного объекта VMGuest.

securityEncryptionType

securityEncryptionTypes

Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом 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/{versions}

tags

string

Необязательный атрибут— задает значение сквозного руководства для более универсального контекста.

treatFailureAsDeploymentFailure

boolean

Необязательный, если значение true, любой сбой для любой операции в VmApplication завершится сбоем развертывания.

VMSizeProperties

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

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

integer

Указывает количество виртуальных ЦП, доступных для виртуальной машины. Если это свойство не указано в тексте запроса, поведение по умолчанию — задать для него значение виртуальных ЦП, доступных для этого размера виртуальной машины, предоставляемого в ответе api Список всех доступных размеров виртуальных машин в регионе.

vCPUsPerCore

integer

Указывает отношение виртуальных ЦП к физическому ядру. Если это свойство не указано в тексте запроса, поведение по умолчанию присваивается значению vCPUsPerCore для размера виртуальной машины, предоставленного в ответе api Список всех доступных размеров виртуальных машин в регионе. параметру этого свойства значение 1 также означает, что гиперпоток отключен.

WindowsConfiguration

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

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

AdditionalUnattendContent[]

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

enableAutomaticUpdates

boolean

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

enableVMAgentPlatformUpdates

boolean

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

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.

ZonalPlatformFaultDomainAlignMode

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

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

string

Unaligned

string