Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Определение ресурсов Bicep
Тип ресурса коллекций, приложений и версий можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/galleries/applications/versions, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Compute/galleries/applications/versions@2024-03-03' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
publishingProfile: {
advancedSettings: {
{customized property}: 'string'
}
customActions: [
{
description: 'string'
name: 'string'
parameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
}
]
script: 'string'
}
]
enableHealthCheck: bool
endOfLifeDate: 'string'
excludeFromLatest: bool
manageActions: {
install: 'string'
remove: 'string'
update: 'string'
}
replicaCount: int
replicationMode: 'string'
settings: {
configFileName: 'string'
packageFileName: 'string'
scriptBehaviorAfterReboot: 'string'
}
source: {
defaultConfigurationLink: 'string'
mediaLink: 'string'
}
storageAccountType: 'string'
targetExtendedLocations: [
{
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
extendedLocation: {
name: 'string'
type: 'string'
}
extendedLocationReplicaCount: int
name: 'string'
storageAccountType: 'string'
}
]
targetRegions: [
{
additionalReplicaSets: [
{
regionalReplicaCount: int
storageAccountType: 'string'
}
]
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
excludeFromLatest: bool
name: 'string'
regionalReplicaCount: int
storageAccountType: 'string'
}
]
}
safetyProfile: {
allowDeletionOfReplicatedLocations: bool
}
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
Microsoft.Compute/галереи/приложения/версии
Имя | Описание | Ценность |
---|---|---|
местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: коллекции или приложения |
свойства | Описывает свойства версии образа коллекции. | Свойства GalleryApplicationVersionProperties |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
ДополнительноеReplicaSet
Имя | Описание | Ценность |
---|---|---|
regionalReplicaCount | Количество реплик прямого диска создаваемой версии образа. Это свойство является обновляемым | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для создания реплик прямого диска | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Шифрование DataDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
Лунь | Это свойство указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. | int (обязательно) |
ШифрованиеИзображения
Имя | Описание | Ценность |
---|---|---|
Образы диска | Список спецификаций шифрования для образов дисков данных. | Шифрование DataDiskImageEncryption[] |
osDiskImage | Содержит параметры шифрования для образа диска ОС. | OSDiskImageEncryption |
ГалереяApplicationCustomAction
Имя | Описание | Ценность |
---|---|---|
описание | Описание, помогающее пользователям понять, что делает это настраиваемое действие. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Параметры | Параметры, используемые этим пользовательским действием | GalleryApplicationCustomActionParameter[] |
сценарий | Скрипт, выполняемый при выполнении этого настраиваемого действия. | строка (обязательно) |
GalleryApplicationCustomActionParameter
Имя | Описание | Ценность |
---|---|---|
значение по умолчанию | Значение по умолчанию параметра. Применяется только к типам строк | струна |
описание | Описание, помогающий пользователям понять, что это означает этот параметр. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Обязательно | Указывает, должен ли этот параметр передаваться при выполнении пользовательского действия. | булевая переменная (bool) |
тип | Указывает тип параметра пользовательского действия. Возможные значения: String, ConfigurationDataBlob или LogOutputBlob | ConfigurationDataBlob LogOutputBlob "String" |
Свойства GalleryApplicationVersionProperties
Имя | Описание | Ценность |
---|---|---|
Профиль публикации | Профиль публикации версии образа коллекции. | GalleryApplicationVersionPublishingProfile (обязательно) |
safetyProfile | Профиль безопасности версии приложения коллекции. | ГалереяApplicationVersionSafetyProfile |
ГалереяApplicationVersionPublishingProfile
Имя | Описание | Ценность |
---|---|---|
advancedSettings | Необязательный. Дополнительные параметры для передачи в расширение vm-application-manager. Только для расширенного использования. | ГалереяApplicationVersionPublishingProfileAdvancedSettings |
customActions | Список пользовательских действий, которые можно выполнить с этой версией приложения коллекции. | ГалереяApplicationCustomAction[] |
enableHealthCheck | Необязательный. Независимо от того, сообщает ли это приложение о работоспособности. | булевая переменная (bool) |
Дата окончания жизненного цикла | Дата окончания срока действия версии образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым. | струна |
исключитьИзПоследних | Если задано значение true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа. | булевая переменная (bool) |
manageActions | UserArtifactManage | |
репликаCount | Количество реплик версии образа для каждого региона. Это свойство вступит в силу для региона, если регионReplicaCount не указан. Это свойство является обновляемым. | инт |
replicationMode | Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым. | "Full" "Неглубокий" |
Параметры | Дополнительные параметры для приложения виртуальной машины, содержащего целевой пакет и имя файла конфигурации при развертывании в целевой виртуальной машине или масштабируемом наборе виртуальных машин. | UserArtifactSettings (Пользовательские настройки) |
источник | Исходный образ, из которого будет создана версия образа. | UserArtifactSource (обязательно) |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetExtendedLocations | Целевые расширенные расположения, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | ГалереяTargetExtendedLocation[] |
targetRegions | Целевые регионы, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | Целевой регион[] |
ГалереяApplicationVersionPublishingProfileAdvancedSettings
Имя | Описание | Ценность |
---|
ГалереяApplicationVersionSafetyProfile
Имя | Описание | Ценность |
---|---|---|
разрешитьУдалениеРеплицированныхЛокаций | Указывает, разрешено ли удаление этой версии образа коллекции из реплицированных регионов. | булевая переменная (bool) |
ГалереяРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
имя | струна | |
тип | Тип расширенного расположения. | EdgeZone "Неизвестно" |
ГалереяЦелевоеРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
расширенноеМестоположение | Имя расширенного расположения. | ГалереяРасширенноеМестоположение |
extendedLocationReplicaCount | Количество реплик версии образа для каждого расширенного расположения. Это свойство является обновляемым. | инт |
имя | Имя региона. | струна |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
OSDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
securityProfile | Это свойство указывает профиль безопасности образа диска ОС. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
Имя | Описание | Ценность |
---|---|---|
confidentialVMEncryptionType | Типы шифрования конфиденциальных виртуальных машин | "EncryptedVMGuestStateOnlyWithPmk" EncryptedWithCmk "EncryptedWithPmk" NonPersistedTPM |
secureVMDiskEncryptionSetId | Идентификатор набора шифрования дисков защищенной виртуальной машины | струна |
Целевой регион
Имя | Описание | Ценность |
---|---|---|
дополнительныеReplicaSets | Список SKU хранилища с числом реплик для создания реплик прямого диска. | AdditionalReplicaSet[] |
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
исключитьИзПоследних | Содержит параметр флага, чтобы скрыть изображение, когда пользователи указывают version='latest' | булевая переменная (bool) |
имя | Имя региона. | строка (обязательно) |
regionalReplicaCount | Количество реплик версии образа для каждого региона. Это свойство является обновляемым. | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Отслеживаемые Ресурсные Теги
Имя | Описание | Ценность |
---|
UserArtifactManage
Имя | Описание | Ценность |
---|---|---|
устанавливать | Обязательно. Путь и аргументы для установки приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
убирать | Обязательно. Путь и аргументы для удаления приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
обновлять | Необязательный. Путь и аргументы для обновления приложения коллекции. В противном случае операция обновления вызовет команду remove on the previous version and install command on the current version of the gallery application. Это ограничено 4096 символами. | струна |
UserArtifactSettings (Пользовательские настройки)
Имя | Описание | Ценность |
---|---|---|
имя_файла config | Необязательный. Имя, назначаемое скачанным файлом конфигурации на виртуальной машине. Это ограничено 4096 символами. Если это не указано, файл конфигурации будет называться именем приложения коллекции, добавленным с "_config". | струна |
имя_файла пакета | Необязательный. Имя, назначаемое скачанный файл пакета на виртуальной машине. Это ограничено 4096 символами. Если файл пакета не указан, он будет называться таким же, как имя приложения коллекции. | струна |
scriptBehaviorAfterReboot | Необязательный. Действие, которое необходимо предпринять для установки или обновления или удаления приложения коллекции в случае перезагрузки. | "Нет" "Rerun" |
UserArtifactSource (Источник артефактов)
Имя | Описание | Ценность |
---|---|---|
ссылка на конфигурацию по умолчанию | Необязательный. Значение defaultConfigurationLink артефакта должно быть удобочитаемым blob-объектом хранилища. | струна |
медиаСсылка | Обязательно. MediaLink артефакта должен быть удобочитаемым blob-объектом хранилища. | строка (обязательно) |
Определение ресурса шаблона ARM
Тип ресурса коллекций, приложений и версий можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/galleries/applications/versions, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Compute/galleries/applications/versions",
"apiVersion": "2024-03-03",
"name": "string",
"location": "string",
"properties": {
"publishingProfile": {
"advancedSettings": {
"{customized property}": "string"
},
"customActions": [
{
"description": "string",
"name": "string",
"parameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string"
}
],
"script": "string"
}
],
"enableHealthCheck": "bool",
"endOfLifeDate": "string",
"excludeFromLatest": "bool",
"manageActions": {
"install": "string",
"remove": "string",
"update": "string"
},
"replicaCount": "int",
"replicationMode": "string",
"settings": {
"configFileName": "string",
"packageFileName": "string",
"scriptBehaviorAfterReboot": "string"
},
"source": {
"defaultConfigurationLink": "string",
"mediaLink": "string"
},
"storageAccountType": "string",
"targetExtendedLocations": [
{
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"extendedLocation": {
"name": "string",
"type": "string"
},
"extendedLocationReplicaCount": "int",
"name": "string",
"storageAccountType": "string"
}
],
"targetRegions": [
{
"additionalReplicaSets": [
{
"regionalReplicaCount": "int",
"storageAccountType": "string"
}
],
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"excludeFromLatest": "bool",
"name": "string",
"regionalReplicaCount": "int",
"storageAccountType": "string"
}
]
},
"safetyProfile": {
"allowDeletionOfReplicatedLocations": "bool"
}
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
Microsoft.Compute/галереи/приложения/версии
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2024-03-03' |
местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | Описывает свойства версии образа коллекции. | Свойства GalleryApplicationVersionProperties |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
тип | Тип ресурса | "Microsoft.Compute/galleries/applications/versions" |
ДополнительноеReplicaSet
Имя | Описание | Ценность |
---|---|---|
regionalReplicaCount | Количество реплик прямого диска создаваемой версии образа. Это свойство является обновляемым | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для создания реплик прямого диска | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Шифрование DataDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
Лунь | Это свойство указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. | int (обязательно) |
ШифрованиеИзображения
Имя | Описание | Ценность |
---|---|---|
Образы диска | Список спецификаций шифрования для образов дисков данных. | Шифрование DataDiskImageEncryption[] |
osDiskImage | Содержит параметры шифрования для образа диска ОС. | OSDiskImageEncryption |
ГалереяApplicationCustomAction
Имя | Описание | Ценность |
---|---|---|
описание | Описание, помогающее пользователям понять, что делает это настраиваемое действие. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Параметры | Параметры, используемые этим пользовательским действием | GalleryApplicationCustomActionParameter[] |
сценарий | Скрипт, выполняемый при выполнении этого настраиваемого действия. | строка (обязательно) |
GalleryApplicationCustomActionParameter
Имя | Описание | Ценность |
---|---|---|
значение по умолчанию | Значение по умолчанию параметра. Применяется только к типам строк | струна |
описание | Описание, помогающий пользователям понять, что это означает этот параметр. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Обязательно | Указывает, должен ли этот параметр передаваться при выполнении пользовательского действия. | булевая переменная (bool) |
тип | Указывает тип параметра пользовательского действия. Возможные значения: String, ConfigurationDataBlob или LogOutputBlob | ConfigurationDataBlob LogOutputBlob "String" |
Свойства GalleryApplicationVersionProperties
Имя | Описание | Ценность |
---|---|---|
Профиль публикации | Профиль публикации версии образа коллекции. | GalleryApplicationVersionPublishingProfile (обязательно) |
safetyProfile | Профиль безопасности версии приложения коллекции. | ГалереяApplicationVersionSafetyProfile |
ГалереяApplicationVersionPublishingProfile
Имя | Описание | Ценность |
---|---|---|
advancedSettings | Необязательный. Дополнительные параметры для передачи в расширение vm-application-manager. Только для расширенного использования. | ГалереяApplicationVersionPublishingProfileAdvancedSettings |
customActions | Список пользовательских действий, которые можно выполнить с этой версией приложения коллекции. | ГалереяApplicationCustomAction[] |
enableHealthCheck | Необязательный. Независимо от того, сообщает ли это приложение о работоспособности. | булевая переменная (bool) |
Дата окончания жизненного цикла | Дата окончания срока действия версии образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым. | струна |
исключитьИзПоследних | Если задано значение true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа. | булевая переменная (bool) |
manageActions | UserArtifactManage | |
репликаCount | Количество реплик версии образа для каждого региона. Это свойство вступит в силу для региона, если регионReplicaCount не указан. Это свойство является обновляемым. | инт |
replicationMode | Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым. | "Full" "Неглубокий" |
Параметры | Дополнительные параметры для приложения виртуальной машины, содержащего целевой пакет и имя файла конфигурации при развертывании в целевой виртуальной машине или масштабируемом наборе виртуальных машин. | UserArtifactSettings (Пользовательские настройки) |
источник | Исходный образ, из которого будет создана версия образа. | UserArtifactSource (обязательно) |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetExtendedLocations | Целевые расширенные расположения, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | ГалереяTargetExtendedLocation[] |
targetRegions | Целевые регионы, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | Целевой регион[] |
ГалереяApplicationVersionPublishingProfileAdvancedSettings
Имя | Описание | Ценность |
---|
ГалереяApplicationVersionSafetyProfile
Имя | Описание | Ценность |
---|---|---|
разрешитьУдалениеРеплицированныхЛокаций | Указывает, разрешено ли удаление этой версии образа коллекции из реплицированных регионов. | булевая переменная (bool) |
ГалереяРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
имя | струна | |
тип | Тип расширенного расположения. | EdgeZone "Неизвестно" |
ГалереяЦелевоеРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
расширенноеМестоположение | Имя расширенного расположения. | ГалереяРасширенноеМестоположение |
extendedLocationReplicaCount | Количество реплик версии образа для каждого расширенного расположения. Это свойство является обновляемым. | инт |
имя | Имя региона. | струна |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
OSDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
securityProfile | Это свойство указывает профиль безопасности образа диска ОС. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
Имя | Описание | Ценность |
---|---|---|
confidentialVMEncryptionType | Типы шифрования конфиденциальных виртуальных машин | "EncryptedVMGuestStateOnlyWithPmk" EncryptedWithCmk "EncryptedWithPmk" NonPersistedTPM |
secureVMDiskEncryptionSetId | Идентификатор набора шифрования дисков защищенной виртуальной машины | струна |
Целевой регион
Имя | Описание | Ценность |
---|---|---|
дополнительныеReplicaSets | Список SKU хранилища с числом реплик для создания реплик прямого диска. | AdditionalReplicaSet[] |
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
исключитьИзПоследних | Содержит параметр флага, чтобы скрыть изображение, когда пользователи указывают version='latest' | булевая переменная (bool) |
имя | Имя региона. | строка (обязательно) |
regionalReplicaCount | Количество реплик версии образа для каждого региона. Это свойство является обновляемым. | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Отслеживаемые Ресурсные Теги
Имя | Описание | Ценность |
---|
UserArtifactManage
Имя | Описание | Ценность |
---|---|---|
устанавливать | Обязательно. Путь и аргументы для установки приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
убирать | Обязательно. Путь и аргументы для удаления приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
обновлять | Необязательный. Путь и аргументы для обновления приложения коллекции. В противном случае операция обновления вызовет команду remove on the previous version and install command on the current version of the gallery application. Это ограничено 4096 символами. | струна |
UserArtifactSettings (Пользовательские настройки)
Имя | Описание | Ценность |
---|---|---|
имя_файла config | Необязательный. Имя, назначаемое скачанным файлом конфигурации на виртуальной машине. Это ограничено 4096 символами. Если это не указано, файл конфигурации будет называться именем приложения коллекции, добавленным с "_config". | струна |
имя_файла пакета | Необязательный. Имя, назначаемое скачанный файл пакета на виртуальной машине. Это ограничено 4096 символами. Если файл пакета не указан, он будет называться таким же, как имя приложения коллекции. | струна |
scriptBehaviorAfterReboot | Необязательный. Действие, которое необходимо предпринять для установки или обновления или удаления приложения коллекции в случае перезагрузки. | "Нет" "Rerun" |
UserArtifactSource (Источник артефактов)
Имя | Описание | Ценность |
---|---|---|
ссылка на конфигурацию по умолчанию | Необязательный. Значение defaultConfigurationLink артефакта должно быть удобочитаемым blob-объектом хранилища. | струна |
медиаСсылка | Обязательно. MediaLink артефакта должен быть удобочитаемым blob-объектом хранилища. | строка (обязательно) |
Примеры использования
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса коллекций, приложений и версий можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Compute/galleries/applications/versions, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/galleries/applications/versions@2024-03-03"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
publishingProfile = {
advancedSettings = {
{customized property} = "string"
}
customActions = [
{
description = "string"
name = "string"
parameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
}
]
script = "string"
}
]
enableHealthCheck = bool
endOfLifeDate = "string"
excludeFromLatest = bool
manageActions = {
install = "string"
remove = "string"
update = "string"
}
replicaCount = int
replicationMode = "string"
settings = {
configFileName = "string"
packageFileName = "string"
scriptBehaviorAfterReboot = "string"
}
source = {
defaultConfigurationLink = "string"
mediaLink = "string"
}
storageAccountType = "string"
targetExtendedLocations = [
{
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
extendedLocation = {
name = "string"
type = "string"
}
extendedLocationReplicaCount = int
name = "string"
storageAccountType = "string"
}
]
targetRegions = [
{
additionalReplicaSets = [
{
regionalReplicaCount = int
storageAccountType = "string"
}
]
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
excludeFromLatest = bool
name = "string"
regionalReplicaCount = int
storageAccountType = "string"
}
]
}
safetyProfile = {
allowDeletionOfReplicatedLocations = bool
}
}
}
}
Значения свойств
Microsoft.Compute/галереи/приложения/версии
Имя | Описание | Ценность |
---|---|---|
местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
идентификатор_родителя | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: коллекции или приложения |
свойства | Описывает свойства версии образа коллекции. | Свойства GalleryApplicationVersionProperties |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
тип | Тип ресурса | "Microsoft.Compute/галереи/приложения/versions@2024-03-03" |
ДополнительноеReplicaSet
Имя | Описание | Ценность |
---|---|---|
regionalReplicaCount | Количество реплик прямого диска создаваемой версии образа. Это свойство является обновляемым | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для создания реплик прямого диска | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Шифрование DataDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
Лунь | Это свойство указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. | int (обязательно) |
ШифрованиеИзображения
Имя | Описание | Ценность |
---|---|---|
Образы диска | Список спецификаций шифрования для образов дисков данных. | Шифрование DataDiskImageEncryption[] |
osDiskImage | Содержит параметры шифрования для образа диска ОС. | OSDiskImageEncryption |
ГалереяApplicationCustomAction
Имя | Описание | Ценность |
---|---|---|
описание | Описание, помогающее пользователям понять, что делает это настраиваемое действие. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Параметры | Параметры, используемые этим пользовательским действием | GalleryApplicationCustomActionParameter[] |
сценарий | Скрипт, выполняемый при выполнении этого настраиваемого действия. | строка (обязательно) |
GalleryApplicationCustomActionParameter
Имя | Описание | Ценность |
---|---|---|
значение по умолчанию | Значение по умолчанию параметра. Применяется только к типам строк | струна |
описание | Описание, помогающий пользователям понять, что это означает этот параметр. | струна |
имя | Имя настраиваемого действия. Должен быть уникальным в версии приложения коллекции. | строка (обязательно) |
Обязательно | Указывает, должен ли этот параметр передаваться при выполнении пользовательского действия. | булевая переменная (bool) |
тип | Указывает тип параметра пользовательского действия. Возможные значения: String, ConfigurationDataBlob или LogOutputBlob | ConfigurationDataBlob LogOutputBlob "String" |
Свойства GalleryApplicationVersionProperties
Имя | Описание | Ценность |
---|---|---|
Профиль публикации | Профиль публикации версии образа коллекции. | GalleryApplicationVersionPublishingProfile (обязательно) |
safetyProfile | Профиль безопасности версии приложения коллекции. | ГалереяApplicationVersionSafetyProfile |
ГалереяApplicationVersionPublishingProfile
Имя | Описание | Ценность |
---|---|---|
advancedSettings | Необязательный. Дополнительные параметры для передачи в расширение vm-application-manager. Только для расширенного использования. | ГалереяApplicationVersionPublishingProfileAdvancedSettings |
customActions | Список пользовательских действий, которые можно выполнить с этой версией приложения коллекции. | ГалереяApplicationCustomAction[] |
enableHealthCheck | Необязательный. Независимо от того, сообщает ли это приложение о работоспособности. | булевая переменная (bool) |
Дата окончания жизненного цикла | Дата окончания срока действия версии образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым. | струна |
исключитьИзПоследних | Если задано значение true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа. | булевая переменная (bool) |
manageActions | UserArtifactManage | |
репликаCount | Количество реплик версии образа для каждого региона. Это свойство вступит в силу для региона, если регионReplicaCount не указан. Это свойство является обновляемым. | инт |
replicationMode | Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым. | "Full" "Неглубокий" |
Параметры | Дополнительные параметры для приложения виртуальной машины, содержащего целевой пакет и имя файла конфигурации при развертывании в целевой виртуальной машине или масштабируемом наборе виртуальных машин. | UserArtifactSettings (Пользовательские настройки) |
источник | Исходный образ, из которого будет создана версия образа. | UserArtifactSource (обязательно) |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetExtendedLocations | Целевые расширенные расположения, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | ГалереяTargetExtendedLocation[] |
targetRegions | Целевые регионы, в которых будет реплицироваться версия образа. Это свойство является обновляемым. | Целевой регион[] |
ГалереяApplicationVersionPublishingProfileAdvancedSettings
Имя | Описание | Ценность |
---|
ГалереяApplicationVersionSafetyProfile
Имя | Описание | Ценность |
---|---|---|
разрешитьУдалениеРеплицированныхЛокаций | Указывает, разрешено ли удаление этой версии образа коллекции из реплицированных регионов. | булевая переменная (bool) |
ГалереяРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
имя | струна | |
тип | Тип расширенного расположения. | EdgeZone "Неизвестно" |
ГалереяЦелевоеРасширенноеМестоположение
Имя | Описание | Ценность |
---|---|---|
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
расширенноеМестоположение | Имя расширенного расположения. | ГалереяРасширенноеМестоположение |
extendedLocationReplicaCount | Количество реплик версии образа для каждого расширенного расположения. Это свойство является обновляемым. | инт |
имя | Имя региона. | струна |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
OSDiskImageEncryption
Имя | Описание | Ценность |
---|---|---|
diskEncryptionSetId | Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. | струна |
securityProfile | Это свойство указывает профиль безопасности образа диска ОС. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
Имя | Описание | Ценность |
---|---|---|
confidentialVMEncryptionType | Типы шифрования конфиденциальных виртуальных машин | "EncryptedVMGuestStateOnlyWithPmk" EncryptedWithCmk "EncryptedWithPmk" NonPersistedTPM |
secureVMDiskEncryptionSetId | Идентификатор набора шифрования дисков защищенной виртуальной машины | струна |
Целевой регион
Имя | Описание | Ценность |
---|---|---|
дополнительныеReplicaSets | Список SKU хранилища с числом реплик для создания реплик прямого диска. | AdditionalReplicaSet[] |
шифрование | Необязательный. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. | ШифрованиеИзображения |
исключитьИзПоследних | Содержит параметр флага, чтобы скрыть изображение, когда пользователи указывают version='latest' | булевая переменная (bool) |
имя | Имя региона. | строка (обязательно) |
regionalReplicaCount | Количество реплик версии образа для каждого региона. Это свойство является обновляемым. | инт |
Тип учетной записи хранилища | Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. | "PremiumV2_LRS" "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Отслеживаемые Ресурсные Теги
Имя | Описание | Ценность |
---|
UserArtifactManage
Имя | Описание | Ценность |
---|---|---|
устанавливать | Обязательно. Путь и аргументы для установки приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
убирать | Обязательно. Путь и аргументы для удаления приложения коллекции. Это ограничено 4096 символами. | строка (обязательно) |
обновлять | Необязательный. Путь и аргументы для обновления приложения коллекции. В противном случае операция обновления вызовет команду remove on the previous version and install command on the current version of the gallery application. Это ограничено 4096 символами. | струна |
UserArtifactSettings (Пользовательские настройки)
Имя | Описание | Ценность |
---|---|---|
имя_файла config | Необязательный. Имя, назначаемое скачанным файлом конфигурации на виртуальной машине. Это ограничено 4096 символами. Если это не указано, файл конфигурации будет называться именем приложения коллекции, добавленным с "_config". | струна |
имя_файла пакета | Необязательный. Имя, назначаемое скачанный файл пакета на виртуальной машине. Это ограничено 4096 символами. Если файл пакета не указан, он будет называться таким же, как имя приложения коллекции. | струна |
scriptBehaviorAfterReboot | Необязательный. Действие, которое необходимо предпринять для установки или обновления или удаления приложения коллекции в случае перезагрузки. | "Нет" "Rerun" |
UserArtifactSource (Источник артефактов)
Имя | Описание | Ценность |
---|---|---|
ссылка на конфигурацию по умолчанию | Необязательный. Значение defaultConfigurationLink артефакта должно быть удобочитаемым blob-объектом хранилища. | струна |
медиаСсылка | Обязательно. MediaLink артефакта должен быть удобочитаемым blob-объектом хранилища. | строка (обязательно) |