Моментальные снимки Microsoft.Compute 2022-03-02
Определение ресурсов Bicep
Тип ресурса моментальных снимков можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/snapshots, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Compute/snapshots@2022-03-02' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
extendedLocation: {
name: 'string'
type: 'EdgeZone'
}
properties: {
completionPercent: int
copyCompletionError: {
errorCode: 'CopySourceNotFound'
errorMessage: 'string'
}
creationData: {
createOption: 'string'
galleryImageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
logicalSectorSize: int
securityDataUri: 'string'
sourceResourceId: 'string'
sourceUri: 'string'
storageAccountId: 'string'
uploadSizeBytes: int
}
dataAccessAuthMode: 'string'
diskAccessId: 'string'
diskSizeGB: int
encryption: {
diskEncryptionSetId: 'string'
type: 'string'
}
encryptionSettingsCollection: {
enabled: bool
encryptionSettings: [
{
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
]
encryptionSettingsVersion: 'string'
}
hyperVGeneration: 'string'
incremental: bool
networkAccessPolicy: 'string'
osType: 'string'
publicNetworkAccess: 'string'
purchasePlan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
}
securityProfile: {
secureVMDiskEncryptionSetId: 'string'
securityType: 'string'
}
supportedCapabilities: {
acceleratedNetwork: bool
architecture: 'string'
}
supportsHibernation: bool
}
}
Значения свойств
Снимки
Имя | Описание | Ценность |
---|---|---|
имя | Имя ресурса | строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, периоды и дефисы. Начните с буквенно-цифровых символов. Заканчивается буквенно-цифровым или подчеркиванием. |
местоположение | Расположение ресурса | строка (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
SKU | Имя SKU моментальных снимков. Может быть Standard_LRS, Premium_LRS или Standard_ZRS. Это необязательный параметр для добавочного моментального снимка, а поведение по умолчанию — SKU будет иметь тот же номер SKU, что и предыдущий моментальный снимок. | SnapshotSku |
extendedLocation | Расширенное расположение, в котором будет создан моментальный снимок. Невозможно изменить расширенное расположение. | ExtendedLocation |
свойства | Свойства ресурса моментального снимка. | SnapshotProperties |
ExtendedLocation
Имя | Описание | Ценность |
---|---|---|
имя | Имя расширенного расположения. | струна |
тип | Тип расширенного расположения. | EdgeZone |
SnapshotProperties
Имя | Описание | Ценность |
---|---|---|
завершениеPercent | Процент завершения фоновой копии при создании ресурса с помощью операции CopyStart. | int |
copyCompletionError | Указывает сведения об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopyCompletionError |
creationData | Сведения об источнике диска. Данные creationData нельзя изменить после создания диска. | CreationData (обязательно) |
dataAccessAuthMode | Дополнительные требования к проверке подлинности при экспорте или отправке на диск или моментальный снимок. | AzureActiveDirectory "Нет" |
diskAccessId | Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках. | струна |
diskSizeGB | Если createData.createOption является пустым, это поле является обязательным и указывает размер создаваемого диска. Если это поле присутствует для обновлений или создания с другими параметрами, оно указывает на изменение размера. Изменение размера допускается только в том случае, если диск не подключен к работающей виртуальной машине и может увеличить размер диска. | int |
шифрование | Свойство шифрования можно использовать для шифрования неактивных данных с помощью управляемых клиентом ключей или управляемых платформой ключей. | шифрования |
encryptionSettingsCollection | Коллекция параметров шифрования, используемая для шифрования дисков Azure, может содержать несколько параметров шифрования на диск или моментальный снимок. | EncryptionSettingsCollection |
hyperVGeneration | Создание гипервизора виртуальной машины. Применимо только к дискам ОС. | "V1" "V2" |
Добавочного | Является ли моментальный снимок добавочным. Добавочные моментальные снимки на том же диске занимают меньше места, чем полные моментальные снимки и могут быть различаются. | bool |
networkAccessPolicy | Политика доступа к диску через сеть. | AllowAll AllowPrivate "DenyAll" |
osType | Тип операционной системы. | Linux "Windows" |
publicNetworkAccess | Политика управления экспортом на диске. | "Отключено" "Включено" |
purchasePlan | Сведения о плане покупки для образа, из которого был создан исходный диск для моментального снимка. | PurchasePlan |
securityProfile | Содержит сведения, связанные с безопасностью для ресурса. | DiskSecurityProfile |
supportedCapabilities | Список поддерживаемых возможностей для образа, из которого исходный диск был создан из моментального снимка. | SupportedCapabilities |
поддержка поддержкиHibernation | Указывает, что ОС на моментальном снимке поддерживает гибернацию. | bool |
CopyCompletionError
Имя | Описание | Ценность |
---|---|---|
ErrorCode | Указывает код ошибки, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopySourceNotFound (обязательно) |
errorMessage | Указывает сообщение об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | строка (обязательно) |
СозданиеData
Имя | Описание | Ценность |
---|---|---|
createOption | Это перечисляет возможные источники создания диска. | "Присоединить" "Копировать" "CopyStart" "Пустой" FromImage "Импорт" ImportSecure "Восстановить" "Отправить" UploadPreparedSecure (обязательный) |
galleryImageReference | Требуется при создании из образа коллекции. Идентификатор/sharedGalleryImageId/communityGalleryImageId объекта ImageDiskReference будет идентификатором ARM общей версии образа галли, из которой создается диск. | ImageDiskReference |
ImageReference | Сведения о источнике диска для образов ПИР или пользователей. | ImageDiskReference |
logicalSectorSize | Размер логического сектора в байтах для дисков Категории "Ультра". Поддерживаемые значения : 512 ad 4096. 4096 — это значение по умолчанию. | int |
securityDataUri | Если createOption — ImportSecure, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого в гостевой состояние виртуальной машины. | струна |
sourceResourceId | Если createOption — Copy, это идентификатор ARM исходного моментального снимка или диска. | струна |
sourceUri | Если createOption — Import, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого на управляемый диск. | струна |
storageAccountId | Требуется, если createOption является импортом. Идентификатор Azure Resource Manager учетной записи хранения, содержащей большой двоичный объект для импорта в виде диска. | струна |
uploadSizeBytes | Если createOption — Upload, это размер содержимого отправки, включая нижний колонтитул VHD. Это значение должно быть от 20972032 (20 МиБ + 512 байт для нижнего колонтитула VHD) и 35183298347520 байт (32 ТиБ + 512 байт для нижнего колонтитула VHD). | int |
ImageDiskReference
Имя | Описание | Ценность |
---|---|---|
communityGalleryImageId | Относительный uri, содержащий ссылку на образ коллекции вычислений Azure сообщества. | струна |
идентификатор | Относительный URI, содержащий репозиторий образов платформы, образ пользователя или образ коллекции вычислений Azure. | струна |
lun | Если диск создается на диске данных образа, это индекс, указывающий, какой из дисков данных в образе следует использовать. Для дисков ОС это поле равно NULL. | int |
sharedGalleryImageId | Относительный URI, содержащий прямую ссылку на образ коллекции вычислений Azure. | струна |
Шифрование
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | ResourceId набора шифрования дисков, который используется для включения шифрования неактивных данных. | струна |
тип | Тип ключа, используемого для шифрования данных диска. | EncryptionAtRestWithCustomerKey EncryptionAtRestWithPlatformAndCustomerKeys EncryptionAtRestWithPlatformKey |
EncryptionSettingsCollection
Имя | Описание | Ценность |
---|---|---|
Включен | Задайте для этого флага значение true и укажите DiskEncryptionKey и необязательный ключ KeyEncryptionKey, чтобы включить шифрование. Установите для этого флага значение false и удалите DiskEncryptionKey и KeyEncryptionKey, чтобы отключить шифрование. Если EncryptionSettings имеет значение NULL в объекте запроса, существующие параметры остаются неизменными. | bool (обязательно) |
encryptionSettings | Коллекция параметров шифрования, по одному для каждого тома диска. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Описывает тип шифрования, используемый для дисков. После установки этого поля его нельзя перезаписать. "1.0" соответствует шифрованию дисков Azure с помощью приложения AAD.'1.1" соответствует шифрованию дисков Azure. | струна |
EncryptionSettingsElement
Имя | Описание | Ценность |
---|---|---|
diskEncryptionKey | Url-адрес секрета Key Vault и идентификатор хранилища ключа шифрования диска | KeyVaultAndSecretReference |
keyEncryptionKey | Url-адрес ключа Key Vault и идентификатор хранилища ключа шифрования ключей. KeyEncryptionKey является необязательным и при использовании используется для распаковки ключа шифрования диска. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Имя | Описание | Ценность |
---|---|---|
secretUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
SourceVault
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ресурса | струна |
KeyVaultAndKeyReference
Имя | Описание | Ценность |
---|---|---|
keyUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
PurchasePlan
Имя | Описание | Ценность |
---|---|---|
имя | Идентификатор плана. | строка (обязательно) |
продукт | Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference. | строка (обязательно) |
промокод | Код продвижения предложения. | струна |
издатель | Идентификатор издателя. | строка (обязательно) |
DiskSecurityProfile
Имя | Описание | Ценность |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId набора шифрования диска, связанного с поддерживаемым конфиденциальным диском виртуальной машины, зашифрованным с помощью управляемого клиентом ключа. | струна |
securityType | Указывает тип безопасности виртуальной машины. Применимо только для дисков ОС. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" 'TrustedLaunch' |
Поддерживаемые возможностиCapabilities
Имя | Описание | Ценность |
---|---|---|
ускорениеNetwork | Значение true, если образ, из которого создается диск ОС, поддерживает ускорение сети. | bool |
архитектура | Архитектура ЦП, поддерживаемая диском ОС. | Arm64 'x64' |
SnapshotSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Определение ресурса шаблона ARM
Тип ресурса моментальных снимков можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/snapshots, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2022-03-02",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"properties": {
"completionPercent": "int",
"copyCompletionError": {
"errorCode": "CopySourceNotFound",
"errorMessage": "string"
},
"creationData": {
"createOption": "string",
"galleryImageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"logicalSectorSize": "int",
"securityDataUri": "string",
"sourceResourceId": "string",
"sourceUri": "string",
"storageAccountId": "string",
"uploadSizeBytes": "int"
},
"dataAccessAuthMode": "string",
"diskAccessId": "string",
"diskSizeGB": "int",
"encryption": {
"diskEncryptionSetId": "string",
"type": "string"
},
"encryptionSettingsCollection": {
"enabled": "bool",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
}
],
"encryptionSettingsVersion": "string"
},
"hyperVGeneration": "string",
"incremental": "bool",
"networkAccessPolicy": "string",
"osType": "string",
"publicNetworkAccess": "string",
"purchasePlan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string"
},
"securityProfile": {
"secureVMDiskEncryptionSetId": "string",
"securityType": "string"
},
"supportedCapabilities": {
"acceleratedNetwork": "bool",
"architecture": "string"
},
"supportsHibernation": "bool"
}
}
Значения свойств
Снимки
Имя | Описание | Ценность |
---|---|---|
тип | Тип ресурса | "Microsoft.Compute/snapshots" |
apiVersion | Версия API ресурсов | '2022-03-02' |
имя | Имя ресурса | строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, периоды и дефисы. Начните с буквенно-цифровых символов. Заканчивается буквенно-цифровым или подчеркиванием. |
местоположение | Расположение ресурса | строка (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
SKU | Имя SKU моментальных снимков. Может быть Standard_LRS, Premium_LRS или Standard_ZRS. Это необязательный параметр для добавочного моментального снимка, а поведение по умолчанию — SKU будет иметь тот же номер SKU, что и предыдущий моментальный снимок. | SnapshotSku |
extendedLocation | Расширенное расположение, в котором будет создан моментальный снимок. Невозможно изменить расширенное расположение. | ExtendedLocation |
свойства | Свойства ресурса моментального снимка. | SnapshotProperties |
ExtendedLocation
Имя | Описание | Ценность |
---|---|---|
имя | Имя расширенного расположения. | струна |
тип | Тип расширенного расположения. | EdgeZone |
SnapshotProperties
Имя | Описание | Ценность |
---|---|---|
завершениеPercent | Процент завершения фоновой копии при создании ресурса с помощью операции CopyStart. | int |
copyCompletionError | Указывает сведения об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopyCompletionError |
creationData | Сведения об источнике диска. Данные creationData нельзя изменить после создания диска. | CreationData (обязательно) |
dataAccessAuthMode | Дополнительные требования к проверке подлинности при экспорте или отправке на диск или моментальный снимок. | AzureActiveDirectory "Нет" |
diskAccessId | Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках. | струна |
diskSizeGB | Если createData.createOption является пустым, это поле является обязательным и указывает размер создаваемого диска. Если это поле присутствует для обновлений или создания с другими параметрами, оно указывает на изменение размера. Изменение размера допускается только в том случае, если диск не подключен к работающей виртуальной машине и может увеличить размер диска. | int |
шифрование | Свойство шифрования можно использовать для шифрования неактивных данных с помощью управляемых клиентом ключей или управляемых платформой ключей. | шифрования |
encryptionSettingsCollection | Коллекция параметров шифрования, используемая для шифрования дисков Azure, может содержать несколько параметров шифрования на диск или моментальный снимок. | EncryptionSettingsCollection |
hyperVGeneration | Создание гипервизора виртуальной машины. Применимо только к дискам ОС. | "V1" "V2" |
Добавочного | Является ли моментальный снимок добавочным. Добавочные моментальные снимки на том же диске занимают меньше места, чем полные моментальные снимки и могут быть различаются. | bool |
networkAccessPolicy | Политика доступа к диску через сеть. | AllowAll AllowPrivate "DenyAll" |
osType | Тип операционной системы. | Linux "Windows" |
publicNetworkAccess | Политика управления экспортом на диске. | "Отключено" "Включено" |
purchasePlan | Сведения о плане покупки для образа, из которого был создан исходный диск для моментального снимка. | PurchasePlan |
securityProfile | Содержит сведения, связанные с безопасностью для ресурса. | DiskSecurityProfile |
supportedCapabilities | Список поддерживаемых возможностей для образа, из которого исходный диск был создан из моментального снимка. | SupportedCapabilities |
поддержка поддержкиHibernation | Указывает, что ОС на моментальном снимке поддерживает гибернацию. | bool |
CopyCompletionError
Имя | Описание | Ценность |
---|---|---|
ErrorCode | Указывает код ошибки, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopySourceNotFound (обязательно) |
errorMessage | Указывает сообщение об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | строка (обязательно) |
СозданиеData
Имя | Описание | Ценность |
---|---|---|
createOption | Это перечисляет возможные источники создания диска. | "Присоединить" "Копировать" "CopyStart" "Пустой" FromImage "Импорт" ImportSecure "Восстановить" "Отправить" UploadPreparedSecure (обязательный) |
galleryImageReference | Требуется при создании из образа коллекции. Идентификатор/sharedGalleryImageId/communityGalleryImageId объекта ImageDiskReference будет идентификатором ARM общей версии образа галли, из которой создается диск. | ImageDiskReference |
ImageReference | Сведения о источнике диска для образов ПИР или пользователей. | ImageDiskReference |
logicalSectorSize | Размер логического сектора в байтах для дисков Категории "Ультра". Поддерживаемые значения : 512 ad 4096. 4096 — это значение по умолчанию. | int |
securityDataUri | Если createOption — ImportSecure, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого в гостевой состояние виртуальной машины. | струна |
sourceResourceId | Если createOption — Copy, это идентификатор ARM исходного моментального снимка или диска. | струна |
sourceUri | Если createOption — Import, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого на управляемый диск. | струна |
storageAccountId | Требуется, если createOption является импортом. Идентификатор Azure Resource Manager учетной записи хранения, содержащей большой двоичный объект для импорта в виде диска. | струна |
uploadSizeBytes | Если createOption — Upload, это размер содержимого отправки, включая нижний колонтитул VHD. Это значение должно быть от 20972032 (20 МиБ + 512 байт для нижнего колонтитула VHD) и 35183298347520 байт (32 ТиБ + 512 байт для нижнего колонтитула VHD). | int |
ImageDiskReference
Имя | Описание | Ценность |
---|---|---|
communityGalleryImageId | Относительный uri, содержащий ссылку на образ коллекции вычислений Azure сообщества. | струна |
идентификатор | Относительный URI, содержащий репозиторий образов платформы, образ пользователя или образ коллекции вычислений Azure. | струна |
lun | Если диск создается на диске данных образа, это индекс, указывающий, какой из дисков данных в образе следует использовать. Для дисков ОС это поле равно NULL. | int |
sharedGalleryImageId | Относительный URI, содержащий прямую ссылку на образ коллекции вычислений Azure. | струна |
Шифрование
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | ResourceId набора шифрования дисков, который используется для включения шифрования неактивных данных. | струна |
тип | Тип ключа, используемого для шифрования данных диска. | EncryptionAtRestWithCustomerKey EncryptionAtRestWithPlatformAndCustomerKeys EncryptionAtRestWithPlatformKey |
EncryptionSettingsCollection
Имя | Описание | Ценность |
---|---|---|
Включен | Задайте для этого флага значение true и укажите DiskEncryptionKey и необязательный ключ KeyEncryptionKey, чтобы включить шифрование. Установите для этого флага значение false и удалите DiskEncryptionKey и KeyEncryptionKey, чтобы отключить шифрование. Если EncryptionSettings имеет значение NULL в объекте запроса, существующие параметры остаются неизменными. | bool (обязательно) |
encryptionSettings | Коллекция параметров шифрования, по одному для каждого тома диска. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Описывает тип шифрования, используемый для дисков. После установки этого поля его нельзя перезаписать. "1.0" соответствует шифрованию дисков Azure с помощью приложения AAD.'1.1" соответствует шифрованию дисков Azure. | струна |
EncryptionSettingsElement
Имя | Описание | Ценность |
---|---|---|
diskEncryptionKey | Url-адрес секрета Key Vault и идентификатор хранилища ключа шифрования диска | KeyVaultAndSecretReference |
keyEncryptionKey | Url-адрес ключа Key Vault и идентификатор хранилища ключа шифрования ключей. KeyEncryptionKey является необязательным и при использовании используется для распаковки ключа шифрования диска. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Имя | Описание | Ценность |
---|---|---|
secretUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
SourceVault
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ресурса | струна |
KeyVaultAndKeyReference
Имя | Описание | Ценность |
---|---|---|
keyUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
PurchasePlan
Имя | Описание | Ценность |
---|---|---|
имя | Идентификатор плана. | строка (обязательно) |
продукт | Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference. | строка (обязательно) |
промокод | Код продвижения предложения. | струна |
издатель | Идентификатор издателя. | строка (обязательно) |
DiskSecurityProfile
Имя | Описание | Ценность |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId набора шифрования диска, связанного с поддерживаемым конфиденциальным диском виртуальной машины, зашифрованным с помощью управляемого клиентом ключа. | струна |
securityType | Указывает тип безопасности виртуальной машины. Применимо только для дисков ОС. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" 'TrustedLaunch' |
Поддерживаемые возможностиCapabilities
Имя | Описание | Ценность |
---|---|---|
ускорениеNetwork | Значение true, если образ, из которого создается диск ОС, поддерживает ускорение сети. | bool |
архитектура | Архитектура ЦП, поддерживаемая диском ОС. | Arm64 'x64' |
SnapshotSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса моментальных снимков можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/snapshots, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2022-03-02"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
completionPercent = int
copyCompletionError = {
errorCode = "CopySourceNotFound"
errorMessage = "string"
}
creationData = {
createOption = "string"
galleryImageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
imageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
logicalSectorSize = int
securityDataUri = "string"
sourceResourceId = "string"
sourceUri = "string"
storageAccountId = "string"
uploadSizeBytes = int
}
dataAccessAuthMode = "string"
diskAccessId = "string"
diskSizeGB = int
encryption = {
diskEncryptionSetId = "string"
type = "string"
}
encryptionSettingsCollection = {
enabled = bool
encryptionSettings = [
{
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
]
encryptionSettingsVersion = "string"
}
hyperVGeneration = "string"
incremental = bool
networkAccessPolicy = "string"
osType = "string"
publicNetworkAccess = "string"
purchasePlan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
}
securityProfile = {
secureVMDiskEncryptionSetId = "string"
securityType = "string"
}
supportedCapabilities = {
acceleratedNetwork = bool
architecture = "string"
}
supportsHibernation = bool
}
sku = {
name = "string"
}
extendedLocation = {
name = "string"
type = "EdgeZone"
}
})
}
Значения свойств
Снимки
Имя | Описание | Ценность |
---|---|---|
тип | Тип ресурса | "Microsoft.Compute/snapshots@2022-03-02" |
имя | Имя ресурса | строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, периоды и дефисы. Начните с буквенно-цифровых символов. Заканчивается буквенно-цифровым или подчеркиванием. |
местоположение | Расположение ресурса | строка (обязательно) |
parent_id | Чтобы развернуть в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
SKU | Имя SKU моментальных снимков. Может быть Standard_LRS, Premium_LRS или Standard_ZRS. Это необязательный параметр для добавочного моментального снимка, а поведение по умолчанию — SKU будет иметь тот же номер SKU, что и предыдущий моментальный снимок. | SnapshotSku |
extendedLocation | Расширенное расположение, в котором будет создан моментальный снимок. Невозможно изменить расширенное расположение. | ExtendedLocation |
свойства | Свойства ресурса моментального снимка. | SnapshotProperties |
ExtendedLocation
Имя | Описание | Ценность |
---|---|---|
имя | Имя расширенного расположения. | струна |
тип | Тип расширенного расположения. | EdgeZone |
SnapshotProperties
Имя | Описание | Ценность |
---|---|---|
завершениеPercent | Процент завершения фоновой копии при создании ресурса с помощью операции CopyStart. | int |
copyCompletionError | Указывает сведения об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopyCompletionError |
creationData | Сведения об источнике диска. Данные creationData нельзя изменить после создания диска. | CreationData (обязательно) |
dataAccessAuthMode | Дополнительные требования к проверке подлинности при экспорте или отправке на диск или моментальный снимок. | AzureActiveDirectory "Нет" |
diskAccessId | Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках. | струна |
diskSizeGB | Если createData.createOption является пустым, это поле является обязательным и указывает размер создаваемого диска. Если это поле присутствует для обновлений или создания с другими параметрами, оно указывает на изменение размера. Изменение размера допускается только в том случае, если диск не подключен к работающей виртуальной машине и может увеличить размер диска. | int |
шифрование | Свойство шифрования можно использовать для шифрования неактивных данных с помощью управляемых клиентом ключей или управляемых платформой ключей. | шифрования |
encryptionSettingsCollection | Коллекция параметров шифрования, используемая для шифрования дисков Azure, может содержать несколько параметров шифрования на диск или моментальный снимок. | EncryptionSettingsCollection |
hyperVGeneration | Создание гипервизора виртуальной машины. Применимо только к дискам ОС. | "V1" "V2" |
Добавочного | Является ли моментальный снимок добавочным. Добавочные моментальные снимки на том же диске занимают меньше места, чем полные моментальные снимки и могут быть различаются. | bool |
networkAccessPolicy | Политика доступа к диску через сеть. | AllowAll AllowPrivate "DenyAll" |
osType | Тип операционной системы. | Linux "Windows" |
publicNetworkAccess | Политика управления экспортом на диске. | "Отключено" "Включено" |
purchasePlan | Сведения о плане покупки для образа, из которого был создан исходный диск для моментального снимка. | PurchasePlan |
securityProfile | Содержит сведения, связанные с безопасностью для ресурса. | DiskSecurityProfile |
supportedCapabilities | Список поддерживаемых возможностей для образа, из которого исходный диск был создан из моментального снимка. | SupportedCapabilities |
поддержка поддержкиHibernation | Указывает, что ОС на моментальном снимке поддерживает гибернацию. | bool |
CopyCompletionError
Имя | Описание | Ценность |
---|---|---|
ErrorCode | Указывает код ошибки, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | CopySourceNotFound (обязательно) |
errorMessage | Указывает сообщение об ошибке, если фоновая копия ресурса, созданного с помощью операции CopyStart, завершается сбоем. | строка (обязательно) |
СозданиеData
Имя | Описание | Ценность |
---|---|---|
createOption | Это перечисляет возможные источники создания диска. | "Присоединить" "Копировать" "CopyStart" "Пустой" FromImage "Импорт" ImportSecure "Восстановить" "Отправить" UploadPreparedSecure (обязательно) |
galleryImageReference | Требуется при создании из образа коллекции. Идентификатор/sharedGalleryImageId/communityGalleryImageId объекта ImageDiskReference будет идентификатором ARM общей версии образа галли, из которой создается диск. | ImageDiskReference |
ImageReference | Сведения о источнике диска для образов ПИР или пользователей. | ImageDiskReference |
logicalSectorSize | Размер логического сектора в байтах для дисков Категории "Ультра". Поддерживаемые значения : 512 ad 4096. 4096 — это значение по умолчанию. | int |
securityDataUri | Если createOption — ImportSecure, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого в гостевой состояние виртуальной машины. | струна |
sourceResourceId | Если createOption — Copy, это идентификатор ARM исходного моментального снимка или диска. | струна |
sourceUri | Если createOption — Import, это универсальный код ресурса (URI) большого двоичного объекта, импортируемого на управляемый диск. | струна |
storageAccountId | Требуется, если createOption является импортом. Идентификатор Azure Resource Manager учетной записи хранения, содержащей большой двоичный объект для импорта в виде диска. | струна |
uploadSizeBytes | Если createOption — Upload, это размер содержимого отправки, включая нижний колонтитул VHD. Это значение должно быть от 20972032 (20 МиБ + 512 байт для нижнего колонтитула VHD) и 35183298347520 байт (32 ТиБ + 512 байт для нижнего колонтитула VHD). | int |
ImageDiskReference
Имя | Описание | Ценность |
---|---|---|
communityGalleryImageId | Относительный uri, содержащий ссылку на образ коллекции вычислений Azure сообщества. | струна |
идентификатор | Относительный URI, содержащий репозиторий образов платформы, образ пользователя или образ коллекции вычислений Azure. | струна |
lun | Если диск создается на диске данных образа, это индекс, указывающий, какой из дисков данных в образе следует использовать. Для дисков ОС это поле равно NULL. | int |
sharedGalleryImageId | Относительный URI, содержащий прямую ссылку на образ коллекции вычислений Azure. | струна |
Шифрование
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | ResourceId набора шифрования дисков, который используется для включения шифрования неактивных данных. | струна |
тип | Тип ключа, используемого для шифрования данных диска. | EncryptionAtRestWithCustomerKey "EncryptionAtRestWithPlatformAndCustomerKeys" EncryptionAtRestWithPlatformKey |
EncryptionSettingsCollection
Имя | Описание | Ценность |
---|---|---|
Включен | Задайте для этого флага значение true и укажите DiskEncryptionKey и необязательный ключ KeyEncryptionKey, чтобы включить шифрование. Установите для этого флага значение false и удалите DiskEncryptionKey и KeyEncryptionKey, чтобы отключить шифрование. Если EncryptionSettings имеет значение NULL в объекте запроса, существующие параметры остаются неизменными. | bool (обязательно) |
encryptionSettings | Коллекция параметров шифрования, по одному для каждого тома диска. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Описывает тип шифрования, используемый для дисков. После установки этого поля его нельзя перезаписать. "1.0" соответствует шифрованию дисков Azure с помощью приложения AAD.'1.1" соответствует шифрованию дисков Azure. | струна |
EncryptionSettingsElement
Имя | Описание | Ценность |
---|---|---|
diskEncryptionKey | Url-адрес секрета Key Vault и идентификатор хранилища ключа шифрования диска | KeyVaultAndSecretReference |
keyEncryptionKey | Url-адрес ключа Key Vault и идентификатор хранилища ключа шифрования ключей. KeyEncryptionKey является необязательным и при использовании используется для распаковки ключа шифрования диска. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Имя | Описание | Ценность |
---|---|---|
secretUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
SourceVault
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ресурса | струна |
KeyVaultAndKeyReference
Имя | Описание | Ценность |
---|---|---|
keyUrl | URL-адрес, указывающий на ключ или секрет в KeyVault | строка (обязательно) |
sourceVault | Идентификатор ресурса KeyVault, содержащий ключ или секрет | SourceVault (обязательно) |
PurchasePlan
Имя | Описание | Ценность |
---|---|---|
имя | Идентификатор плана. | строка (обязательно) |
продукт | Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference. | строка (обязательно) |
промокод | Код продвижения предложения. | струна |
издатель | Идентификатор издателя. | строка (обязательно) |
DiskSecurityProfile
Имя | Описание | Ценность |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId набора шифрования диска, связанного с поддерживаемым конфиденциальным диском виртуальной машины, зашифрованным с помощью управляемого клиентом ключа. | струна |
securityType | Указывает тип безопасности виртуальной машины. Применимо только для дисков ОС. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
Поддерживаемые возможностиCapabilities
Имя | Описание | Ценность |
---|---|---|
ускорениеNetwork | Значение true, если образ, из которого создается диск ОС, поддерживает ускорение сети. | bool |
архитектура | Архитектура ЦП, поддерживаемая диском ОС. | Arm64 "x64" |
SnapshotSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |