Virtual Machines - Get

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

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

Параметры URI

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

string

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

subscriptionId
path True

string

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

vmName
path True

string

Имя виртуальной машины.

api-version
query True

string

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

$expand
query

InstanceViewTypes

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

Ответы

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

VirtualMachine

ОК

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

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

Примеры

Get a virtual machine placed on a dedicated host group through automatic placement
Get a virtual machine with Disk Controller Type Properties
Get a virtual machine with VM Size Properties
Get a Virtual Machine.

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

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": []
    },
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Get a virtual machine with Disk Controller Type Properties

Sample Request

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

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ],
      "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a virtual machine with VM Size Properties

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a Virtual Machine.

Sample Request

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

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "proximityPlacementGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded",
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ],
  "managedBy": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"
}

Определения

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

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

AdditionalUnattendContent

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

ApiEntityReference

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

ApiError

Ошибка API.

ApiErrorBase

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

ApplicationProfile

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

AvailablePatchSummary

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

BillingProfile

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

BootDiagnostics

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

BootDiagnosticsInstanceView

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

CachingTypes

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

CapacityReservationProfile

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

CloudError

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

ComponentNames

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

DataDisk

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

DeleteOptions

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

DiagnosticsProfile

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

DiffDiskOptions

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

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.

DiffDiskSettings

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

DiskControllerTypes

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип дискового контроллера по умолчанию, если не указана виртуальная машина при условии, что для параметра hyperVGeneration задано значение V2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только размер виртуальной машины не обновляется в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

DiskCreateOptionTypes

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

DiskDeleteOptionTypes

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

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отключении диска или которое уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за непредвиденного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи могли не быть удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения обновления диска данных toBeDetached до true вместе с параметром detachOption: ForceDetach.

DiskEncryptionSetParameters

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

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

DiskInstanceView

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

DomainNameLabelScopeTypes

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

EncryptionIdentity

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

EventGridAndResourceGraph

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

ExtendedLocation

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

ExtendedLocationTypes

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

HardwareProfile

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

HyperVGenerationType

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

ImageReference

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

InnerError

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

InstanceViewStatus

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

InstanceViewTypes

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

IPVersions

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

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

KeyVaultSecretReference

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

LastPatchInstallationSummary

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

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.

MaintenanceOperationResultCodeTypes

Код результата последней операции обслуживания.

MaintenanceRedeployStatus

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

ManagedDiskParameters

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

Mode

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

NetworkApiVersion

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

NetworkInterfaceAuxiliaryMode

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

NetworkInterfaceAuxiliarySku

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

NetworkInterfaceReference

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

NetworkProfile

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

OperatingSystemTypes

Тип операционной системы.

OSDisk

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

OSImageNotificationProfile

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

OSProfile

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

PassNames

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

PatchOperationStatus

Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. В этот момент он станет "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

PatchSettings

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

Plan

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

ProtocolTypes

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

ProxyAgentSettings

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

PublicIPAddressSku

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

PublicIPAddressSkuName

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

PublicIPAddressSkuTier

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

PublicIPAllocationMethod

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

ResourceIdentityType

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

ScheduledEventsAdditionalPublishingTargets

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

ScheduledEventsPolicy

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

ScheduledEventsProfile

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

securityEncryptionTypes

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

SecurityProfile

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

SecurityTypes

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

SettingNames

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

SshConfiguration

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

SshPublicKey

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

StatusLevelTypes

Код уровня.

StorageAccountTypes

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

StorageProfile

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

SubResource

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

TerminateNotificationProfile

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

UefiSettings

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

UserAssignedIdentities

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

UserInitiatedReboot

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

UserInitiatedRedeploy

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

VaultCertificate

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

VaultSecretGroup

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

VirtualHardDisk

Виртуальный жесткий диск.

VirtualMachine

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

VirtualMachineAgentInstanceView

Агент виртуальной машины, работающий на виртуальной машине.

VirtualMachineEvictionPolicyTypes

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

VirtualMachineExtension

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

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

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

VirtualMachineHealthStatus

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

VirtualMachineIdentity

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

VirtualMachineInstanceView

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

VirtualMachineIpTag

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

VirtualMachineNetworkInterfaceConfiguration

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

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

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

VirtualMachineNetworkInterfaceIPConfiguration

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

VirtualMachinePatchStatus

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

VirtualMachinePriorityTypes

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

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

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

VirtualMachineSizeTypes

Задает размер виртуальной машины. Тип данных перечисления в настоящее время является устаревшим и будет удален до 23 декабря 2023 г. Рекомендуемый способ получить список доступных размеров — использовать следующие API: Перечисление всех доступных размеров виртуальных машин в группе доступности, Перечисление всех доступных размеров виртуальных машин в регионе, Перечисление всех доступных размеров виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.

VMDiskSecurityProfile

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

VMGalleryApplication

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

VMSizeProperties

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

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. Это включает удаленное взаимодействие с Windows PowerShell.

WinRMListener

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

AdditionalCapabilities

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

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

boolean

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

ultraSSDEnabled

boolean

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

AdditionalUnattendContent

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

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

ComponentNames

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

content

string

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

passName

PassNames

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

settingName

SettingNames

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

ApiEntityReference

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

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

AvailablePatchSummary

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

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

string

Идентификатор действия операции, которая привела к этому результату. Он используется для сопоставления журналов CRP и расширений.

criticalAndSecurityPatchCount

integer

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

error

ApiError

Ошибки, возникшие во время выполнения операции. Массив сведений содержит их список.

lastModifiedTime

string

Метка времени в формате UTC при начале операции.

otherPatchCount

integer

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

rebootPending

boolean

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

startTime

string

Метка времени в формате UTC при начале операции.

status

PatchOperationStatus

Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. В этот момент он станет "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

BillingProfile

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

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

number

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

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

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

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

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

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

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

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

BootDiagnostics

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

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

boolean

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

storageUri

string

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

BootDiagnosticsInstanceView

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

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

string

Снимок экрана: URI большого двоичного объекта консоли. Примечание: Этот параметр не будет задан, если в настоящее время включена загрузочная диагностика с управляемым хранилищем.

serialConsoleLogBlobUri

string

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

status

InstanceViewStatus

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

CachingTypes

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

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

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

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

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

SubResource

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

CloudError

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

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

ApiError

Ошибка API.

ComponentNames

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

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

string

DataDisk

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

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

CachingTypes

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

createOption

DiskCreateOptionTypes

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

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если используется это значение, диск данных удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение.

detachOption

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отключении диска или которое уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за непредвиденного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи могли не быть удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения диска данных обновите toBeDetached до true вместе с параметром detachOption: ForceDetach.

diskIOPSReadWrite

integer

Указывает Read-Write операций ввода-вывода в секунду для управляемого диска при UltraSSD_LRS StorageAccountType. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновить только с помощью обновлений масштабируемого набора VirtualMachine.

diskMBpsReadWrite

integer

Указывает пропускную способность в МБ в секунду для управляемого диска при UltraSSD_LRS StorageAccountType. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновить только с помощью обновлений масштабируемого набора VirtualMachine.

diskSizeGB

integer

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

image

VirtualHardDisk

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

lun

integer

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

managedDisk

ManagedDiskParameters

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

name

string

имя диска.

sourceResource

ApiEntityReference

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

toBeDetached

boolean

Указывает, находится ли диск данных в процессе отсоединения от VirtualMachine/VirtualMachineScaleset.

vhd

VirtualHardDisk

Виртуальный жесткий диск.

writeAcceleratorEnabled

boolean

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

DeleteOptions

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

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

string

Detach

string

DiagnosticsProfile

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

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

BootDiagnostics

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

DiffDiskOptions

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

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

string

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.

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

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип дискового контроллера по умолчанию, если не указана виртуальная машина при условии, что для параметра hyperVGeneration задано значение V2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только размер виртуальной машины не обновляется в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

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

string

SCSI

string

DiskCreateOptionTypes

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

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

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

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

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

string

Detach

string

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отключении диска или которое уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за непредвиденного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи могли не быть удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения обновления диска данных toBeDetached до true вместе с параметром detachOption: ForceDetach.

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

string

DiskEncryptionSetParameters

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

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

string

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

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

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

KeyVaultSecretReference

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

enabled

boolean

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

keyEncryptionKey

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

DiskInstanceView

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

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

DiskEncryptionSettings[]

Задает параметры шифрования для диска ОС.

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

name

string

имя диска.

statuses

InstanceViewStatus[]

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

DomainNameLabelScopeTypes

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

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

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

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

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

string

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

EventGridAndResourceGraph

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

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

boolean

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

ExtendedLocation

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

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

string

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

type

ExtendedLocationTypes

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

ExtendedLocationTypes

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

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

string

HardwareProfile

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

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

VirtualMachineSizeTypes

Задает размер виртуальной машины. Тип данных перечисления в настоящее время является устаревшим и будет удален до 23 декабря 2023 г. Рекомендуемый способ получить список доступных размеров — использовать следующие API: Перечисление всех доступных размеров виртуальных машин в группе доступности, Перечисление всех доступных размеров виртуальных машин в регионе, Перечисление всех доступных размеров виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.

vmSizeProperties

VMSizeProperties

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

HyperVGenerationType

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

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

string

V2

string

ImageReference

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

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

string

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

exactVersion

string

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

id

string

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

offer

string

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

publisher

string

Издатель образа.

sharedGalleryImageId

string

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

sku

string

SKU образа.

version

string

Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основной, Дополнительный и Сборка являются десятичными числами. Укажите "latest", чтобы использовать последнюю версию образа, доступную во время развертывания. Даже если вы используете последнюю версию, образ виртуальной машины не будет автоматически обновляться после развертывания, даже если станет доступна новая версия. Не используйте поле "версия" для развертывания образа коллекции. Образ коллекции всегда должен использовать поле id для развертывания, чтобы использовать "последнюю" версию образа коллекции, просто задайте "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле id без ввода версии.

InnerError

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

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

string

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

exceptiontype

string

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

InstanceViewStatus

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

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

string

Код состояния.

displayStatus

string

Короткая локализуемая метка для состояния.

level

StatusLevelTypes

Код уровня.

message

string

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

time

string

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

InstanceViewTypes

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

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

string

userData

string

IPVersions

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

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

string

IPv6

string

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

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

string

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

sourceVault

SubResource

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

KeyVaultSecretReference

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

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

string

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

sourceVault

SubResource

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

LastPatchInstallationSummary

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

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

ApiError

Ошибки, возникшие во время выполнения операции. Массив сведений содержит их список.

excludedPatchCount

integer

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

failedPatchCount

integer

Количество исправлений, которые не удалось установить.

installationActivityId

string

Идентификатор действия операции, которая привела к этому результату. Он используется для сопоставления журналов CRP и расширений.

installedPatchCount

integer

Количество успешно установленных исправлений.

lastModifiedTime

string

Метка времени начала операции в формате UTC.

maintenanceWindowExceeded

boolean

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

notSelectedPatchCount

integer

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

pendingPatchCount

integer

Количество всех доступных исправлений, которые должны быть установлены в течение операции установки исправлений.

startTime

string

Метка времени начала операции в формате UTC.

status

PatchOperationStatus

Общий успех или состояние сбоя операции. Он остается "InProgress" до завершения операции. В этот момент он будет ознавать "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

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

MaintenanceOperationResultCodeTypes

Код результата последней операции обслуживания.

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

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

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

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

boolean

Значение true, если клиенту разрешено выполнять обслуживание.

lastOperationMessage

string

Сообщение, возвращенное для последней операции обслуживания.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Код результата последней операции обслуживания.

maintenanceWindowEndTime

string

Время окончания периода обслуживания.

maintenanceWindowStartTime

string

Время начала периода обслуживания.

preMaintenanceWindowEndTime

string

Время окончания периода предварительного обслуживания.

preMaintenanceWindowStartTime

string

Время начала периода предварительного обслуживания.

ManagedDiskParameters

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

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

DiskEncryptionSetParameters

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

id

string

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

securityProfile

VMDiskSecurityProfile

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

storageAccountType

StorageAccountTypes

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

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

NetworkInterfaceReference

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

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

string

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

properties.deleteOption

DeleteOptions

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

properties.primary

boolean

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

NetworkProfile

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

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

NetworkApiVersion

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

networkInterfaceConfigurations

VirtualMachineNetworkInterfaceConfiguration[]

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

networkInterfaces

NetworkInterfaceReference[]

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

OperatingSystemTypes

Тип операционной системы.

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

string

Windows

string

OSDisk

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

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

CachingTypes

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

createOption

DiskCreateOptionTypes

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

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение. Для эфемерного диска ОС по умолчанию устанавливается значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

diffDiskSettings

DiffDiskSettings

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

diskSizeGB

integer

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

encryptionSettings

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

image

VirtualHardDisk

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

managedDisk

ManagedDiskParameters

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

name

string

имя диска.

osType

OperatingSystemTypes

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

vhd

VirtualHardDisk

Виртуальный жесткий диск.

writeAcceleratorEnabled

boolean

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

OSImageNotificationProfile

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

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

boolean

Указывает, включено или отключено событие запланированного образа ОС.

notBeforeTimeout

string

Период времени, в течение времени, в течение времени, когда виртуальная машина переосмысляется или обновляется ее ОС, возможно, потребуется утвердить запланированное событие образа ОС, прежде чем событие будет автоматически утверждено (истекло время ожидания). Конфигурация указывается в формате ISO 8601, и значение должно быть 15 минут (PT15M)

OSProfile

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

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

string

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

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

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

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

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

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

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

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

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

adminUsername

string

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

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

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

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

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

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

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

allowExtensionOperations

boolean

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

computerName

string

Указывает имя ОС узла виртуальной машины. Это имя невозможно обновить после создания виртуальной машины. Максимальная длина (Windows): 15 символов. Максимальная длина (Linux): 64 символа. Соглашения об именовании и ограничения см. в статье Рекомендации по реализации служб инфраструктуры Azure.

customData

string

Указывает строку пользовательских данных в кодировке base-64. Строка в кодировке base-64 кодируется в двоичный массив, который сохраняется в виде файла на виртуальной машине. Максимальная длина двоичного массива — 65 535 байт. Примечание. Не передайте секреты или пароли в свойстве customData. Это свойство невозможно обновить после создания виртуальной машины. Свойство customData передается виртуальной машине для сохранения в виде файла. Дополнительные сведения см. в статье Пользовательские данные на виртуальных машинах Azure. Сведения об использовании cloud-init для виртуальной машины Linux см. в статье Использование 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 на виртуальной машине.

PassNames

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

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

string

PatchOperationStatus

Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. В этот момент он станет "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

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

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

PatchSettings

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

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

WindowsPatchAssessmentMode

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

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

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

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

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

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

enableHotpatching

boolean

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

patchMode

WindowsVMGuestPatchMode

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

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

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

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

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

Plan

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

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

string

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

product

string

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

promotionCode

string

Промокод.

publisher

string

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

ProtocolTypes

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

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

string

Https

string

ProxyAgentSettings

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

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

boolean

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

keyIncarnationId

integer

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

mode

Mode

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

PublicIPAddressSku

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

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

PublicIPAddressSkuName

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

tier

PublicIPAddressSkuTier

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

PublicIPAddressSkuName

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

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

string

Standard

string

PublicIPAddressSkuTier

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

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

string

Regional

string

PublicIPAllocationMethod

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

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

string

Static

string

ResourceIdentityType

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

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

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ScheduledEventsAdditionalPublishingTargets

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

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

EventGridAndResourceGraph

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

ScheduledEventsPolicy

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

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

ScheduledEventsAdditionalPublishingTargets

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

userInitiatedReboot

UserInitiatedReboot

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

userInitiatedRedeploy

UserInitiatedRedeploy

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

ScheduledEventsProfile

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

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

OSImageNotificationProfile

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

terminateNotificationProfile

TerminateNotificationProfile

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

securityEncryptionTypes

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

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

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

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

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

boolean

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

encryptionIdentity

EncryptionIdentity

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

proxyAgentSettings

ProxyAgentSettings

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

securityType

SecurityTypes

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

uefiSettings

UefiSettings

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

SecurityTypes

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

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

string

TrustedLaunch

string

SettingNames

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

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

string

FirstLogonCommands

string

SshConfiguration

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

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

SshPublicKey[]

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

SshPublicKey

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

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

string

Сертификат открытого ключа SSH, используемый для проверки подлинности на виртуальной машине через SSH. Ключ должен быть по крайней мере 2048-разрядным и иметь формат ssh-rsa. Сведения о создании ключей SSH см. в статье [Создание ключей SSH в Linux и Mac для виртуальных машин Linux в Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

Указывает полный путь на созданной виртуальной машине, где хранится открытый ключ SSH. Если файл уже существует, указанный ключ добавляется к файлу. Пример: /home/user/.ssh/authorized_keys

StatusLevelTypes

Код уровня.

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

string

Info

string

Warning

string

StorageAccountTypes

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

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

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

StorageProfile

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

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

DataDisk[]

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

diskControllerType

DiskControllerTypes

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип контроллера диска по умолчанию, если не указана виртуальная машина при создании с параметром hyperVGeneration, для которой задано значение V2 на основе возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

imageReference

ImageReference

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

osDisk

OSDisk

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

SubResource

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

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

string

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

TerminateNotificationProfile

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

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

boolean

Указывает, включено или отключено событие Terminate Scheduled.

notBeforeTimeout

string

Настраиваемая продолжительность времени, в течение которой удаляется виртуальная машина, может потенциально утвердить запланированное событие до автоматического утверждения события (истекло время ожидания). Конфигурация должна быть указана в формате ISO 8601, значение по умолчанию — 5 минут (PT5M)

UefiSettings

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

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

boolean

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

vTpmEnabled

boolean

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

UserAssignedIdentities

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

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

UserInitiatedReboot

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

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

boolean

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

UserInitiatedRedeploy

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

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

boolean

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

VaultCertificate

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

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

string

Для виртуальных машин Windows указывает хранилище сертификатов на виртуальной машине, в которое необходимо добавить сертификат. Указанное хранилище сертификатов неявно находится в учетной записи LocalMachine. Для виртуальных машин Linux файл сертификата помещается в каталог /var/lib/waagent с именем <UppercaseThumbprint.crt> для файла сертификата X509 и <UppercaseThumbprint.prv> для закрытого ключа. Оба этих файла имеют формат PEM.

certificateUrl

string

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

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

VaultSecretGroup

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

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

SubResource

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

vaultCertificates

VaultCertificate[]

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

VirtualHardDisk

Виртуальный жесткий диск.

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

string

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

VirtualMachine

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

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

string

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

extendedLocation

ExtendedLocation

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

id

string

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

identity

VirtualMachineIdentity

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

location

string

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

managedBy

string

ManagedBy имеет значение Virtual Machine Scale Set (VMSS) flex ARM resourceID, если виртуальная машина является частью VMSS. Это свойство используется платформой для оптимизации удаления внутренней группы ресурсов.

name

string

Имя ресурса

plan

Plan

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

properties.additionalCapabilities

AdditionalCapabilities

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

properties.applicationProfile

ApplicationProfile

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

properties.availabilitySet

SubResource

Указывает сведения о группе доступности, в которую должна быть назначена виртуальная машина. Виртуальные машины, заданные в одной группе доступности, выделяются в различных узлах для достижения максимальной доступности. Дополнительные сведения о группах доступности см. в статье Общие сведения о группах доступности. Дополнительные сведения о плановом обслуживании Azure см. в статье Обслуживание и обновления для Виртуальные машины в Azure. В настоящее время виртуальную машину можно добавить в группу доступности только во время создания. Группа доступности, в которую добавляется виртуальная машина, должна находиться в той же группе ресурсов, что и ресурс группы доступности. Существующую виртуальную машину нельзя добавить в группу доступности. Это свойство не может существовать вместе со ссылкой properties.virtualMachineScaleSet, отличной от NULL.

properties.billingProfile

BillingProfile

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

properties.capacityReservation

CapacityReservationProfile

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

properties.diagnosticsProfile

DiagnosticsProfile

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

properties.evictionPolicy

VirtualMachineEvictionPolicyTypes

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

properties.extensionsTimeBudget

string

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

properties.hardwareProfile

HardwareProfile

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

properties.host

SubResource

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

properties.hostGroup

SubResource

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

properties.instanceView

VirtualMachineInstanceView

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

properties.licenseType

string

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

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

Windows_Client

Windows_Server

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

RHEL_BYOS (для RHEL)

SLES_BYOS (для SUSE)

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

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

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

properties.networkProfile

NetworkProfile

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

properties.osProfile

OSProfile

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

properties.platformFaultDomain

integer

Указывает домен логического сбоя масштабируемого набора, в котором будет создана виртуальная машина. По умолчанию виртуальная машина автоматически назначается домену сбоя, который лучше всего поддерживает баланс между доступными доменами сбоя. Это применимо, только если задано свойство "virtualMachineScaleSet" этой виртуальной машины. Масштабируемый набор виртуальных машин, на который ссылается ссылка, должен иметь значение platformFaultDomainCount больше 1. Это свойство невозможно обновить после создания виртуальной машины. Назначение домена сбоя можно просмотреть в представлении экземпляра виртуальной машины. Минимальная версия API: 2020,12,01.

properties.priority

VirtualMachinePriorityTypes

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

properties.provisioningState

string

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

properties.proximityPlacementGroup

SubResource

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

properties.scheduledEventsPolicy

ScheduledEventsPolicy

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

properties.scheduledEventsProfile

ScheduledEventsProfile

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

properties.securityProfile

SecurityProfile

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

properties.storageProfile

StorageProfile

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

properties.timeCreated

string

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

properties.userData

string

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

properties.virtualMachineScaleSet

SubResource

Указывает сведения о масштабируемом наборе виртуальных машин, которому должна быть назначена виртуальная машина. Виртуальные машины, указанные в одном масштабируемом наборе виртуальных машин, выделяются для разных узлов, чтобы обеспечить максимальную доступность. В настоящее время виртуальную машину можно добавить в масштабируемый набор виртуальных машин только во время создания. Существующую виртуальную машину нельзя добавить в масштабируемый набор виртуальных машин. Это свойство не может существовать вместе со ссылкой properties.availabilitySet, отличной от NULL. Минимальная версия API: 2019,03,01.

properties.vmId

string

Указывает уникальный идентификатор виртуальной машины, который представляет собой 128-разрядный идентификатор, который закодирован и хранится на всех виртуальных машинах IaaS Azure SMBIOS и может быть считан с помощью команд BIOS платформы.

resources

VirtualMachineExtension[]

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

tags

object

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

type

string

Тип ресурса

zones

string[]

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

VirtualMachineAgentInstanceView

Агент виртуальной машины, работающий на виртуальной машине.

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

VirtualMachineExtensionHandlerInstanceView[]

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

statuses

InstanceViewStatus[]

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

vmAgentVersion

string

Полная версия агента виртуальной машины.

VirtualMachineEvictionPolicyTypes

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

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

string

Delete

string

VirtualMachineExtension

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

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

string

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

location

string

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

name

string

Имя ресурса

properties.autoUpgradeMinorVersion

boolean

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

properties.enableAutomaticUpgrade

boolean

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

properties.forceUpdateTag

string

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

properties.instanceView

VirtualMachineExtensionInstanceView

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

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

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

properties.provisionAfterExtensions

string[]

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

properties.provisioningState

string

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

properties.publisher

string

Имя издателя обработчика расширений.

properties.settings

object

Общедоступные параметры расширения в формате JSON.

properties.suppressFailures

boolean

Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.

properties.type

string

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

properties.typeHandlerVersion

string

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

tags

object

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

type

string

Тип ресурса

VirtualMachineExtensionHandlerInstanceView

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

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

InstanceViewStatus

Состояние обработчика расширения.

type

string

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

typeHandlerVersion

string

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

VirtualMachineExtensionInstanceView

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

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

string

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

statuses

InstanceViewStatus[]

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

substatuses

InstanceViewStatus[]

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

type

string

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

typeHandlerVersion

string

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

VirtualMachineHealthStatus

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

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

InstanceViewStatus

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

VirtualMachineIdentity

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

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

string

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

tenantId

string

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

type

ResourceIdentityType

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

userAssignedIdentities

UserAssignedIdentities

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

VirtualMachineInstanceView

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

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

string

Идентификатор ресурса выделенного узла, на котором выделена виртуальная машина путем автоматического размещения, если виртуальная машина связана с выделенной группой узлов с включенным автоматическим размещением. Минимальная версия API: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

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

computerName

string

Имя компьютера, назначенное виртуальной машине.

disks

DiskInstanceView[]

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

extensions

VirtualMachineExtensionInstanceView[]

Сведения о расширениях.

hyperVGeneration

HyperVGenerationType

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

isVMInStandbyPool

boolean

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

maintenanceRedeployStatus

MaintenanceRedeployStatus

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

osName

string

Операционная система, запущенная на виртуальной машине.

osVersion

string

Версия операционной системы, работающей на виртуальной машине.

patchStatus

VirtualMachinePatchStatus

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

platformFaultDomain

integer

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

platformUpdateDomain

integer

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

rdpThumbPrint

string

Отпечаток сертификата удаленного рабочего стола.

statuses

InstanceViewStatus[]

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

vmAgent

VirtualMachineAgentInstanceView

Агент виртуальной машины, работающий на виртуальной машине.

vmHealth

VirtualMachineHealthStatus

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

VirtualMachineIpTag

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

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

string

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

tag

string

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

VirtualMachineNetworkInterfaceConfiguration

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

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

string

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

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

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

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

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

properties.deleteOption

DeleteOptions

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

properties.disableTcpStateTracking

boolean

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

properties.dnsSettings

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

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

properties.dscpConfiguration

SubResource

properties.enableAcceleratedNetworking

boolean

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

properties.enableFpga

boolean

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

properties.enableIPForwarding

boolean

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

properties.ipConfigurations

VirtualMachineNetworkInterfaceIPConfiguration[]

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

properties.networkSecurityGroup

SubResource

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

properties.primary

boolean

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

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

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

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

string[]

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

VirtualMachineNetworkInterfaceIPConfiguration

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

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

string

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

properties.applicationGatewayBackendAddressPools

SubResource[]

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

properties.applicationSecurityGroups

SubResource[]

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

properties.loadBalancerBackendAddressPools

SubResource[]

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

properties.primary

boolean

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

properties.privateIPAddressVersion

IPVersions

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

properties.publicIPAddressConfiguration

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

properties.subnet

SubResource

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

VirtualMachinePatchStatus

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

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

AvailablePatchSummary

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

configurationStatuses

InstanceViewStatus[]

Состояние включения указанного patchMode

lastPatchInstallationSummary

LastPatchInstallationSummary

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

VirtualMachinePriorityTypes

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

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

string

Regular

string

Spot

string

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

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

string

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

properties.deleteOption

DeleteOptions

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

properties.dnsSettings

VirtualMachinePublicIPAddressDnsSettingsConfiguration

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

properties.idleTimeoutInMinutes

integer

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

properties.ipTags

VirtualMachineIpTag[]

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

properties.publicIPAddressVersion

IPVersions

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

properties.publicIPAllocationMethod

PublicIPAllocationMethod

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

properties.publicIPPrefix

SubResource

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

sku

PublicIPAddressSku

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

VirtualMachinePublicIPAddressDnsSettingsConfiguration

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

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

string

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

domainNameLabelScope

DomainNameLabelScopeTypes

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

VirtualMachineSizeTypes

Задает размер виртуальной машины. Тип данных перечисления в настоящее время является устаревшим и будет удален до 23 декабря 2023 г. Рекомендуемый способ получить список доступных размеров — использовать следующие API: Перечисление всех доступных размеров виртуальных машин в группе доступности, Перечисление всех доступных размеров виртуальных машин в регионе, Перечисление всех доступных размеров виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.

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

string

Basic_A1

string

Basic_A2

string

Basic_A3

string

Basic_A4

string

Standard_A0

string

Standard_A1

string

Standard_A10

string

Standard_A11

string

Standard_A1_v2

string

Standard_A2

string

Standard_A2_v2

string

Standard_A2m_v2

string

Standard_A3

string

Standard_A4

string

Standard_A4_v2

string

Standard_A4m_v2

string

Standard_A5

string

Standard_A6

string

Standard_A7

string

Standard_A8

string

Standard_A8_v2

string

Standard_A8m_v2

string

Standard_A9

string

Standard_B1ms

string

Standard_B1s

string

Standard_B2ms

string

Standard_B2s

string

Standard_B4ms

string

Standard_B8ms

string

Standard_D1

string

Standard_D11

string

Standard_D11_v2

string

Standard_D12

string

Standard_D12_v2

string

Standard_D13

string

Standard_D13_v2

string

Standard_D14

string

Standard_D14_v2

string

Standard_D15_v2

string

Standard_D16_v3

string

Standard_D16s_v3

string

Standard_D1_v2

string

Standard_D2

string

Standard_D2_v2

string

Standard_D2_v3

string

Standard_D2s_v3

string

Standard_D3

string

Standard_D32_v3

string

Standard_D32s_v3

string

Standard_D3_v2

string

Standard_D4

string

Standard_D4_v2

string

Standard_D4_v3

string

Standard_D4s_v3

string

Standard_D5_v2

string

Standard_D64_v3

string

Standard_D64s_v3

string

Standard_D8_v3

string

Standard_D8s_v3

string

Standard_DS1

string

Standard_DS11

string

Standard_DS11_v2

string

Standard_DS12

string

Standard_DS12_v2

string

Standard_DS13

string

Standard_DS13-2_v2

string

Standard_DS13-4_v2

string

Standard_DS13_v2

string

Standard_DS14

string

Standard_DS14-4_v2

string

Standard_DS14-8_v2

string

Standard_DS14_v2

string

Standard_DS15_v2

string

Standard_DS1_v2

string

Standard_DS2

string

Standard_DS2_v2

string

Standard_DS3

string

Standard_DS3_v2

string

Standard_DS4

string

Standard_DS4_v2

string

Standard_DS5_v2

string

Standard_E16_v3

string

Standard_E16s_v3

string

Standard_E2_v3

string

Standard_E2s_v3

string

Standard_E32-16_v3

string

Standard_E32-8s_v3

string

Standard_E32_v3

string

Standard_E32s_v3

string

Standard_E4_v3

string

Standard_E4s_v3

string

Standard_E64-16s_v3

string

Standard_E64-32s_v3

string

Standard_E64_v3

string

Standard_E64s_v3

string

Standard_E8_v3

string

Standard_E8s_v3

string

Standard_F1

string

Standard_F16

string

Standard_F16s

string

Standard_F16s_v2

string

Standard_F1s

string

Standard_F2

string

Standard_F2s

string

Standard_F2s_v2

string

Standard_F32s_v2

string

Standard_F4

string

Standard_F4s

string

Standard_F4s_v2

string

Standard_F64s_v2

string

Standard_F72s_v2

string

Standard_F8

string

Standard_F8s

string

Standard_F8s_v2

string

Standard_G1

string

Standard_G2

string

Standard_G3

string

Standard_G4

string

Standard_G5

string

Standard_GS1

string

Standard_GS2

string

Standard_GS3

string

Standard_GS4

string

Standard_GS4-4

string

Standard_GS4-8

string

Standard_GS5

string

Standard_GS5-16

string

Standard_GS5-8

string

Standard_H16

string

Standard_H16m

string

Standard_H16mr

string

Standard_H16r

string

Standard_H8

string

Standard_H8m

string

Standard_L16s

string

Standard_L32s

string

Standard_L4s

string

Standard_L8s

string

Standard_M128-32ms

string

Standard_M128-64ms

string

Standard_M128ms

string

Standard_M128s

string

Standard_M64-16ms

string

Standard_M64-32ms

string

Standard_M64ms

string

Standard_M64s

string

Standard_NC12

string

Standard_NC12s_v2

string

Standard_NC12s_v3

string

Standard_NC24

string

Standard_NC24r

string

Standard_NC24rs_v2

string

Standard_NC24rs_v3

string

Standard_NC24s_v2

string

Standard_NC24s_v3

string

Standard_NC6

string

Standard_NC6s_v2

string

Standard_NC6s_v3

string

Standard_ND12s

string

Standard_ND24rs

string

Standard_ND24s

string

Standard_ND6s

string

Standard_NV12

string

Standard_NV24

string

Standard_NV6

string

VMDiskSecurityProfile

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

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

DiskEncryptionSetParameters

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

securityEncryptionType

securityEncryptionTypes

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

VMGalleryApplication

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

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

string

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

enableAutomaticUpgrade

boolean

Если задано значение true, при наличии новой версии приложения коллекции в PIR/SIG она будет автоматически обновлена для виртуальной машины или VMSS.

order

integer

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

packageReferenceId

string

Указывает идентификатор ресурса GalleryApplicationVersion в форме /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{versions/{version}

tags

string

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

treatFailureAsDeploymentFailure

boolean

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

VMSizeProperties

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

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

integer

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

vCPUsPerCore

integer

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

WindowsConfiguration

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

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

AdditionalUnattendContent[]

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

enableAutomaticUpdates

boolean

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

enableVMAgentPlatformUpdates

boolean

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

patchSettings

PatchSettings

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

provisionVMAgent

boolean

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

timeZone

string

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

winRM

WinRMConfiguration

Задает прослушиватели удаленного управления Windows. Это включает удаленное взаимодействие с Windows PowerShell.

WindowsPatchAssessmentMode

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

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

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

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

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

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

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

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

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

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

boolean

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

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

WindowsVMGuestPatchMode

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

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

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

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

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

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

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

Указывает прослушиватели удаленного управления Windows. Это включает удаленное взаимодействие с Windows PowerShell.

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