Restore Point Collections - List All

Ссылка

Service:: Compute

API Version:: 2024-03-01

Возвращает список коллекций точек восстановления в подписке. Используйте свойство nextLink в ответе, чтобы получить следующую страницу коллекций точек восстановления. Сделайте это, пока nextLink не будет иметь значение NULL для получения всех коллекций точек восстановления.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections?api-version=2024-03-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	RestorePointCollectionListResult	ОК
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	олицетворения учетной записи пользователя

Примеры

Gets the list of restore point collections in a subscription

Sample Request

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python restore_point_collection_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.restore_point_collections.list_all()
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json
func ExampleRestorePointCollectionsClient_NewListAllPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRestorePointCollectionsClient().NewListAllPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorePointCollectionListResult = armcompute.RestorePointCollectionListResult{
		// 	Value: []*armcompute.RestorePointCollection{
		// 		{
		// 			Name: to.Ptr("restorePointCollection1"),
		// 			Type: to.Ptr("Microsoft.Compute/restorePointCollections"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/resourceGroup1/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"myTag1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armcompute.RestorePointCollectionProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointCollectionID: to.Ptr("59f04a5d-f783-4200-a1bd-d3f464e8c4b4"),
		// 				Source: &armcompute.RestorePointCollectionSourceProperties{
		// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Test"),
		// 					Location: to.Ptr("westus"),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("restorePointCollection2"),
		// 			Type: to.Ptr("Microsoft.Compute/restorePointCollections"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/resourceGroup2/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"myTag1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armcompute.RestorePointCollectionProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointCollectionID: to.Ptr("2875c590-e337-4102-9668-4f5b7e3f98a4"),
		// 				Source: &armcompute.RestorePointCollectionSourceProperties{
		// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Prod"),
		// 					Location: to.Ptr("westus"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
 *
 * @summary Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json
 */
async function getsTheListOfRestorePointCollectionsInASubscription() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.restorePointCollections.listAll()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "restorePointCollection1",
      "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup1/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1",
      "type": "Microsoft.Compute/restorePointCollections",
      "location": "westus",
      "tags": {
        "myTag1": "tagValue1"
      },
      "properties": {
        "source": {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Test",
          "location": "westus"
        },
        "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
        "provisioningState": "Succeeded"
      }
    },
    {
      "name": "restorePointCollection2",
      "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup2/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2",
      "type": "Microsoft.Compute/restorePointCollections",
      "location": "westus",
      "tags": {
        "myTag1": "tagValue1"
      },
      "properties": {
        "source": {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Prod",
          "location": "westus"
        },
        "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4",
        "provisioningState": "Deleting"
      }
    }
  ]
}

Определения

Имя	Описание
AdditionalUnattendContent	Указывает дополнительные сведения в формате XML, которые могут быть включены в файл Unattend.xml, используемый программой установки Windows. Содержимое определяется по имени параметра, имени компонента и проходу, в котором применяется содержимое.
ApiEntityReference	Справочник по сущностям API.
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.
CachingTypes	Возвращает тип кэширования.
CloudError	Ответ об ошибке от службы вычислений.
ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes	ConsistencyMode для RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время в качестве допустимых входных данных принимается только CrashConsistent. Дополнительные сведения см https://aka.ms/RestorePoints . в статье.
DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 15.06.2015.
DiskControllerTypes	Возвращает тип контроллера диска виртуальной машины, записанной во время создания точки восстановления.
DiskEncryptionSetParameters	Описывает параметр набора ресурсов для шифрования управляемых пользователем дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview .
DiskEncryptionSettings	Описание параметров шифрования для диска
DiskRestorePointAttributes	Сведения о точке восстановления диска.
DiskRestorePointInstanceView	Представление экземпляра точки восстановления диска.
DiskRestorePointReplicationStatus	Представление экземпляра точки восстановления диска.
EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций хранилища ключей.
HardwareProfile	Указывает параметры оборудования виртуальной машины.
HyperVGenerationTypes	HyperVGeneration исходной виртуальной машины, для которой фиксируется точка восстановления.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultKeyReference	Описание ссылки на ключ Key Vault
KeyVaultSecretReference	Описание ссылки на секрет Key Vault
LinuxConfiguration	Задает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в разделе Linux в Azure-Endorsed Дистрибутивы.
LinuxPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault — вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.
LinuxPatchSettings	Задает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.
LinuxVMGuestPatchMode	Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий. Возможны следующие значения: ImageDefault — используется конфигурация исправлений виртуальной машины по умолчанию. AutomaticByPlatform — виртуальная машина будет автоматически обновлена платформой. Свойство provisionVMAgent должно иметь значение true.
ManagedDiskParameters	Параметры управляемого диска.
Mode	Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не будет применять контроль доступа к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Режим принудительного применения.
OperatingSystemType	Возвращает тип операционной системы.
OSProfile	Указывает параметры операционной системы виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.
PassNames	Имя прохода. В настоящее время единственным допустимым значением является OobeSystem.
PatchSettings	Задает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
ProtocolTypes	Указывает протокол прослушивателя WinRM. Возможные значения: http,https.
ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2024-03-01.
RestorePoint	Сведения о точке восстановления.
RestorePointCollection	Создание или обновление параметров коллекции точек восстановления.
RestorePointCollectionListResult	Ответ операции сбора точек восстановления списка.
RestorePointCollectionSourceProperties	Свойства исходного ресурса, на основе этого коллекции точек восстановления.
RestorePointEncryption	Параметры шифрования неактивных данных для точки восстановления диска. Это необязательное свойство, которое можно указать во входных данных при создании точки восстановления.
RestorePointEncryptionType	Тип ключа, используемого для шифрования данных точки восстановления диска.
RestorePointInstanceView	Представление экземпляра точки восстановления.
RestorePointSourceMetadata	Описывает свойства виртуальной машины, для которой была создана точка восстановления. Предоставленные свойства представляют собой подмножество и snapshot общих свойств виртуальной машины, захваченных во время создания точки восстановления.
RestorePointSourceVMDataDisk	Описывает диск данных.
RestorePointSourceVMOSDisk	Описывает диск операционной системы.
RestorePointSourceVMStorageProfile	Описывает профиль хранилища.
securityEncryptionTypes	Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.
SecurityProfile	Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
SettingNames	Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.
SshConfiguration	Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure
SshPublicKey	Содержит сведения об открытом ключе сертификата SSH и пути на виртуальной машине Linux, в которой он размещен.
StatusLevelTypes	Код уровня.
StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.
SubResource
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.
VaultCertificate	Описывает ссылку на один сертификат в Key Vault и расположение сертификата на виртуальной машине.
VaultSecretGroup	Описывает набор сертификатов, которые находятся в одном Key Vault.
VirtualMachineSizeTypes	Задает размер виртуальной машины. Тип данных перечисления в настоящее время является нерекомендуемым и будет удален до 23 декабря 2023 г. Рекомендуемый способ получить список доступных размеров — использовать следующие API: Список всех доступных размеров виртуальных машин в группе доступности, Список всех доступных размеров виртуальных машин в регионе, Список всех доступных размеров виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в статье Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
VMDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. Примечание: Его можно задать только для конфиденциальных виртуальных машин.
VMSizeProperties	Задает параметры свойства размера виртуальной машины на виртуальной машине.
WindowsConfiguration	Указывает параметры операционной системы Windows на виртуальной машине.
WindowsPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault — вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправления Windows.
WindowsVMGuestPatchMode	Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий. Возможны следующие значения: Вручную . Вы управляете применением исправлений на виртуальной машине. Это можно сделать, применяя исправления вручную на виртуальной машине. В этом режиме автоматические обновления отключены; свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение false. AutomaticByOS — виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true. AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.
WinRMConfiguration	Описание конфигурации удаленного управления Windows виртуальной машины
WinRMListener	Описание протокола и отпечатка прослушивателя удаленного управления Windows

AdditionalUnattendContent

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

Имя	Тип	Описание
componentName	ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
content	string	Указывает содержимое в формате XML, добавляемое в файл unattend.xml для указанного пути и компонента. Размер XML должен быть меньше 4 КБ и должен содержать корневой элемент для вставляемого параметра или компонента.
passName	PassNames	Имя прохода. В настоящее время единственным допустимым значением является OobeSystem.
settingName	SettingNames	Указывает имя параметра, к которому относится контент. Возможные значения: FirstLogonCommands и AutoLogon.

ApiEntityReference

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

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM в формате /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

BootDiagnostics

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

Имя	Тип	Описание
enabled	boolean	Указывает, должна ли на виртуальной машине быть включена загрузочная диагностика.
storageUri	string	URI учетной записи хранения, используемой для размещения выходных данных консоли и снимка экрана. Если параметр storageUri не указан при включении диагностика загрузки, будет использоваться управляемое хранилище.

CachingTypes

Возвращает тип кэширования.

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

CloudError

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

Имя	Тип	Описание
error	ApiError	Ошибка API.

ComponentNames

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

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

ConsistencyModeTypes

ConsistencyMode для RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время в качестве допустимых входных данных принимается только CrashConsistent. Дополнительные сведения см https://aka.ms/RestorePoints . в статье.

Имя	Тип	Описание
ApplicationConsistent	string
CrashConsistent	string
FileSystemConsistent	string

DiagnosticsProfile

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

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

DiskControllerTypes

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

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

DiskEncryptionSetParameters

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

Имя	Тип	Описание
id	string	Идентификатор ресурса

DiskEncryptionSettings

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

Имя	Тип	Описание
diskEncryptionKey	KeyVaultSecretReference	Указывает расположение ключа шифрования диска, который является секретом Key Vault.
enabled	boolean	Указывает, следует ли включить шифрование дисков на виртуальной машине.
keyEncryptionKey	KeyVaultKeyReference	Указывает расположение ключа шифрования ключа в Key Vault.

DiskRestorePointAttributes

Сведения о точке восстановления диска.

Имя	Тип	Описание
encryption	RestorePointEncryption	Параметры шифрования неактивных данных для точки восстановления диска. Это необязательное свойство, которое можно указать во входных данных при создании точки восстановления.
id	string	Идентификатор ресурса
sourceDiskRestorePoint	ApiEntityReference	Идентификатор ресурса точки восстановления исходного диска.

DiskRestorePointInstanceView

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

Имя	Тип	Описание
id	string	Идентификатор точки восстановления диска.
replicationStatus	DiskRestorePointReplicationStatus	Сведения о состоянии репликации точки восстановления диска.

DiskRestorePointReplicationStatus

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

Имя	Тип	Описание
completionPercent	integer	Процент завершения репликации.
status	InstanceViewStatus	Сведения о состоянии ресурса.

EncryptionIdentity

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

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

HardwareProfile

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

Имя	Тип	Описание
vmSize	VirtualMachineSizeTypes	Задает размер виртуальной машины. Тип данных перечисления в настоящее время является нерекомендуемым и будет удален до 23 декабря 2023 г. Рекомендуемый способ получить список доступных размеров — использовать следующие API: Список всех доступных размеров виртуальных машин в группе доступности, Список всех доступных размеров виртуальных машин в регионе, Список всех доступных размеров виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в статье Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
vmSizeProperties	VMSizeProperties	Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-07-01. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для получения дополнительных сведений следуйте инструкциям в разделе Настройка виртуальной машины .

HyperVGenerationTypes

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

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

InnerError

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

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

InstanceViewStatus

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

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Короткая локализуемая метка для состояния.
level	StatusLevelTypes	Код уровня.
message	string	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.
time	string	Время состояния.

KeyVaultKeyReference

Описание ссылки на ключ Key Vault

Имя	Тип	Описание
keyUrl	string	URL-адрес, ссылающийся на ключ шифрования ключа в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Key Vault, содержащий ключ.

KeyVaultSecretReference

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

Имя	Тип	Описание
secretUrl	string	URL-адрес, ссылающийся на секрет в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Key Vault, содержащий секрет.

LinuxConfiguration

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

Имя	Тип	Описание
disablePasswordAuthentication	boolean	Указывает, следует ли отключать проверку подлинности паролем.
enableVMAgentPlatformUpdates	boolean	Указывает, включена ли Обновления платформы VMAgent для виртуальной машины Linux. Значение по умолчанию — false.
patchSettings	LinuxPatchSettings	[Предварительная версия функции] Задает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
provisionVMAgent	boolean	Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
ssh	SshConfiguration	Указывает конфигурацию ключа SSH для операционной системы Linux.

LinuxPatchAssessmentMode

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

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

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

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

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

LinuxPatchSettings

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

Имя	Тип	Описание
assessmentMode	LinuxPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault — вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform — платформа запускает периодические оценки исправлений. Свойство provisionVMAgent должно иметь значение true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Задает дополнительные параметры для режима исправления AutomaticByPlatform в гостевой системе исправлений виртуальной машины в Linux.
patchMode	LinuxVMGuestPatchMode	Указывает режим установки исправлений гостевой виртуальной машины для виртуальной машины IaaS или виртуальных машин, связанных с масштабируемым набором виртуальных машин с параметром OrchestrationMode как гибкий. Возможны следующие значения: ImageDefault — используется конфигурация исправлений виртуальной машины по умолчанию. AutomaticByPlatform — виртуальная машина будет автоматически обновлена платформой. Свойство provisionVMAgent должно иметь значение true.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

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

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать установку исправлений без случайных обновлений
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

LinuxVMGuestPatchMode

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

ManagedDiskParameters

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

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.
id	string	Идентификатор ресурса
securityProfile	VMDiskSecurityProfile	Указывает профиль безопасности для управляемого диска.
storageAccountType	StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

Mode

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

Имя	Тип	Описание
Audit	string
Enforce	string

OperatingSystemType

Возвращает тип операционной системы.

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

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

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.

ProtocolTypes

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

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

ProxyAgentSettings

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

Имя	Тип	Описание
enabled	boolean	Указывает, следует ли включить функцию ProxyAgent на виртуальной машине или в масштабируемом наборе виртуальных машин.
keyIncarnationId	integer	Увеличение значения этого свойства позволяет пользователю сбросить ключ, используемый для защиты канала связи между гостем и узлом.
mode	Mode	Указывает режим, в котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не будет применять контроль доступа к запросам к конечным точкам размещения в режиме аудита, а в режиме принудительного применения он будет применять управление доступом. Значение по умолчанию — Режим принудительного применения.

RestorePoint

Сведения о точке восстановления.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode для RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время в качестве допустимых входных данных принимается только CrashConsistent. Дополнительные сведения см https://aka.ms/RestorePoints . в статье.
properties.excludeDisks	ApiEntityReference[]	Список идентификаторов дисковых ресурсов, которые клиент хочет исключить из точки восстановления. Если диски не указаны, будут включены все диски.
properties.instanceView	RestorePointInstanceView	Представление экземпляра точки восстановления.
properties.provisioningState	string	Возвращает состояние подготовки точки восстановления.
properties.sourceMetadata	RestorePointSourceMetadata	Возвращает сведения о виртуальной машине, записанной во время создания точки восстановления.
properties.sourceRestorePoint	ApiEntityReference	Идентификатор ресурса исходной точки восстановления, из которой необходимо создать копию.
properties.timeCreated	string	Возвращает время создания точки восстановления.
type	string	Тип ресурса

RestorePointCollection

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

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение ресурса
name	string	Имя ресурса
properties.provisioningState	string	Состояние подготовки коллекции точек восстановления.
properties.restorePointCollectionId	string	Уникальный идентификатор коллекции точек восстановления.
properties.restorePoints	RestorePoint[]	Список, содержащий все точки восстановления, созданные в этой коллекции точек восстановления.
properties.source	RestorePointCollectionSourceProperties	Свойства исходного ресурса, на основе этого коллекции точек восстановления.
tags	object	Теги ресурсов
type	string	Тип ресурса

RestorePointCollectionListResult

Ответ операции сбора точек восстановления списка.

Имя	Тип	Описание
nextLink	string	Универсальный код ресурса (URI) для получения следующей страницы RestorePointCollections. Вызовите ListNext() с этим, чтобы получить следующую страницу RestorePointCollections
value	RestorePointCollection[]	Возвращает список коллекций точек восстановления.

RestorePointCollectionSourceProperties

Свойства исходного ресурса, на основе этого коллекции точек восстановления.

Имя	Тип	Описание
id	string	Идентификатор исходного ресурса, используемого для создания коллекции точек восстановления
location	string	Расположение исходного ресурса, используемого для создания коллекции точек восстановления.

RestorePointEncryption

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

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

RestorePointEncryptionType

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

Имя	Тип	Описание
EncryptionAtRestWithCustomerKey	string	Точка восстановления диска шифруется при хранении с помощью управляемого клиентом ключа, который может быть изменен и отозван клиентом.
EncryptionAtRestWithPlatformAndCustomerKeys	string	Точка восстановления диска шифруется при хранении с помощью двух уровней шифрования. Один из ключей — управление клиентом, а другой — управление платформой.
EncryptionAtRestWithPlatformKey	string	Точка восстановления диска шифруется при хранении с помощью ключа, управляемого платформой.

RestorePointInstanceView

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

Имя	Тип	Описание
diskRestorePoints	DiskRestorePointInstanceView[]	Сведения о точках восстановления диска.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.

RestorePointSourceMetadata

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

Имя	Тип	Описание
diagnosticsProfile	DiagnosticsProfile	Возвращает профиль диагностика.
hardwareProfile	HardwareProfile	Возвращает профиль оборудования.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration исходной виртуальной машины, для которой фиксируется точка восстановления.
licenseType	string	Возвращает тип лицензии, который предназначен для сценария использования собственной лицензии.
location	string	Расположение виртуальной машины, из которой была создана точка восстановления.
osProfile	OSProfile	Возвращает профиль ОС.
securityProfile	SecurityProfile	Возвращает профиль безопасности.
storageProfile	RestorePointSourceVMStorageProfile	Возвращает профиль хранилища.
userData	string	UserData, связанный с исходной виртуальной машиной, для которой фиксируется точка восстановления, которая является значением в кодировке Base-64.
vmId	string	Возвращает уникальный идентификатор виртуальной машины.

RestorePointSourceVMDataDisk

Описывает диск данных.

Имя	Тип	Описание
caching	CachingTypes	Возвращает тип кэширования.
diskRestorePoint	DiskRestorePointAttributes	Содержит свойства точки восстановления диска.
diskSizeGB	integer	Возвращает начальный размер диска в ГБ для пустых дисков данных и новый требуемый размер для существующих дисков ОС и данных.
lun	integer	Возвращает номер логического блока.
managedDisk	ManagedDiskParameters	Содержит сведения об управляемом диске.
name	string	Возвращает имя диска.
writeAcceleratorEnabled	boolean	Показывает значение true, если на диске включен ускоритель записи.

RestorePointSourceVMOSDisk

Описывает диск операционной системы.

Имя	Тип	Описание
caching	CachingTypes	Возвращает тип кэширования.
diskRestorePoint	DiskRestorePointAttributes	Содержит свойства точки восстановления диска.
diskSizeGB	integer	Возвращает размер диска в ГБ.
encryptionSettings	DiskEncryptionSettings	Возвращает параметры шифрования дисков.
managedDisk	ManagedDiskParameters	Возвращает сведения об управляемом диске.
name	string	Возвращает имя диска.
osType	OperatingSystemType	Возвращает тип операционной системы.
writeAcceleratorEnabled	boolean	Показывает значение true, если на диске включен ускоритель записи.

RestorePointSourceVMStorageProfile

Описывает профиль хранилища.

Имя	Тип	Описание
dataDisks	RestorePointSourceVMDataDisk[]	Возвращает диски данных виртуальной машины, захваченные во время создания точки восстановления.
diskControllerType	DiskControllerTypes	Возвращает тип контроллера диска виртуальной машины, записанной во время создания точки восстановления.
osDisk	RestorePointSourceVMOSDisk	Возвращает диск ОС виртуальной машины, записанной во время создания точки восстановления.

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, работающих в Azure

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

SshPublicKey

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

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

StatusLevelTypes

Код уровня.

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

StorageAccountTypes

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

Имя	Тип	Описание
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

Имя	Тип	Описание
id	string	Идентификатор ресурса

UefiSettings

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

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

VaultCertificate

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

Имя	Тип	Описание
certificateStore	string	Для виртуальных машин Windows указывает хранилище сертификатов на виртуальной машине, в которое необходимо добавить сертификат. Указанное хранилище сертификатов неявно находится в учетной записи LocalMachine. Для виртуальных машин Linux файл сертификата помещается в каталог /var/lib/waagent с именем <UppercaseThumbprint.crt> для файла сертификата X509 и <UppercaseThumbprint.prv> для закрытого ключа. Оба этих файла имеют формат PEM.
certificateUrl	string	Это URL-адрес сертификата, переданного в Key Vault в виде секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен иметь кодировку Base64 следующего объекта JSON, кодированного в UTF-8: { "data":"", "dataType":"pfx", "password":"" } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

VaultSecretGroup

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

Имя	Тип	Описание
sourceVault	SubResource	Относительный URL-адрес Key Vault, содержащий все сертификаты в VaultCertificates.
vaultCertificates	VaultCertificate[]	Список ссылок на хранилища ключей в SourceVault, которые содержат сертификаты.

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

VMSizeProperties

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

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

WindowsConfiguration

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

Имя	Тип	Описание
additionalUnattendContent	AdditionalUnattendContent[]	Задает дополнительные сведения в кодировке base-64 и в формате XML, которые могут включаться в файл Unattend.xml, используемый программой установки Windows.
enableAutomaticUpdates	boolean	Указывает, включена ли автоматическая Обновления для виртуальной машины Windows. Значение по умолчанию — true. Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС.
enableVMAgentPlatformUpdates	boolean	Указывает, включена ли для виртуальной машины Windows Обновления платформы VMAgent. Значение по умолчанию — false.
patchSettings	PatchSettings	[Предварительная версия функции] Задает параметры, связанные с установкой исправлений гостевой виртуальной машины в Windows.
provisionVMAgent	boolean	Указывает, должен ли агент виртуальной машины быть подготовлен на виртуальной машине. Если это свойство не указано в тексте запроса, по умолчанию ему присваивается значение true. Это гарантирует, что агент виртуальной машины будет установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
timeZone	string	Указывает часовой пояс виртуальной машины. Например, "Тихоокеанское стандартное время". Возможные значения могут быть TimeZoneInfo.Id значения из часовых поясов, возвращаемых TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Задает прослушиватели удаленного управления Windows. Это включает удаленное взаимодействие с Windows PowerShell.

WindowsPatchAssessmentMode

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

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

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

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать установку исправлений без случайных обновлений
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

WindowsVMGuestPatchMode

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

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

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

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

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

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

WinRMConfiguration

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

Имя	Тип	Описание
listeners	WinRMListener[]	Список прослушивателей удаленного управления Windows

WinRMListener

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

Имя	Тип	Описание
certificateUrl	string	Это URL-адрес сертификата, переданного в Key Vault в виде секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8: { "data":"", "dataType":"pfx", "password":"" } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
protocol	ProtocolTypes	Указывает протокол прослушивателя WinRM. Возможные значения: http,https.

Share via

Restore Point Collections - List All

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

Gets the list of restore point collections in a subscription

Sample Request

Sample Response

Определения

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

CachingTypes

CloudError

ComponentNames

ConsistencyModeTypes

DiagnosticsProfile

DiskControllerTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskRestorePointAttributes

DiskRestorePointInstanceView

DiskRestorePointReplicationStatus

EncryptionIdentity

HardwareProfile

HyperVGenerationTypes

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

ManagedDiskParameters

Mode

OperatingSystemType

OSProfile

PassNames

PatchSettings

ProtocolTypes

ProxyAgentSettings

RestorePoint

RestorePointCollection

RestorePointCollectionListResult

RestorePointCollectionSourceProperties

RestorePointEncryption

RestorePointEncryptionType

RestorePointInstanceView

RestorePointSourceMetadata

RestorePointSourceVMDataDisk

RestorePointSourceVMOSDisk

RestorePointSourceVMStorageProfile

securityEncryptionTypes

SecurityProfile

SecurityTypes

SettingNames

SshConfiguration

SshPublicKey

StatusLevelTypes

StorageAccountTypes

SubResource

UefiSettings

VaultCertificate

VaultSecretGroup

VirtualMachineSizeTypes

VMDiskSecurityProfile

VMSizeProperties

WindowsConfiguration

WindowsPatchAssessmentMode

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

WindowsVMGuestPatchAutomaticByPlatformSettings

WindowsVMGuestPatchMode