Модуль azure.azcollection.azure_rm_galleryimageversion — управление экземпляром версии образа Azure SIG

ad_user

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте этот параметр для аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Определяет, является ли поле tags каноническим или только добавляет значения к существующим тегам.

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной окружения ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

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

Если задано значение credential_file, профиль считывается из ~/.azure/credentials.

Если задано значение cli, учетные данные берутся из профиля Azure CLI. Чтобы указать идентификатор подписки, если их несколько, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае используется подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Чтобы указать идентификатор подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае выбирается первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому необходимо убедиться, что настроенный узел центра является действительным и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

gallery_image_name

string / обязательный

Имя определения образа в галерее, в которой будет создана версия образа.

gallery_name

string / обязательный

Имя коллекции общих образов, в которой находится определение образа.

location

string

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

log_mode

string

Аргумент родительского элемента.

log_path

string

Аргумент родительского элемента.

name

string / обязательный

Имя создаваемой версии образа в галерее.

Имя должно соответствовать шаблону семантической версии. Допустимы только цифры и точки.

Числа должны находиться в диапазоне 32-разрядного целого числа. Например: <MajorVersion>.<MinorVersion>.<Patch>.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

publishing_profile

dictionary

Профиль публикации.

end_of_life_date

string

Дата окончания срока действия версии образа в галерее.

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

Это свойство можно обновлять. Формат должен соответствовать ISO-8601, например «2019-06-26».

exclude_from_latest

boolean

Если exclude_from_latest=true, виртуальные машины, развернутые с использованием последней версии определения образа, не будут использовать эту версию образа.

Варианты:

• false
• true

managed_image

any

Ссылка на управляемый образ: может быть идентификатором ресурса или словарем, содержащим resource_group и name.

Устарел начиная с версии 2.10; используйте вместо него storage_profile.

replica_count

integer

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

Это свойство применяется к региону, если для него не указано regionalReplicaCount.

Это свойство можно обновлять.

snapshot

any

Используемый исходный снимок.

Устарел начиная с версии 2.10; используйте вместо него storage_profile.

storage_account_type

string

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

Это свойство нельзя обновлять.

Варианты:

• "Standard_LRS"
• "Standard_ZRS"

target_regions

list / элементы=any

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

Это свойство можно обновлять.

encryption

dictionary

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

data_disk_images

list / элементы=dictionary

Список спецификаций шифрования образов дисков данных.

disk_encryption_set_id

string

Относительный URI, содержащий идентификатор набора шифрования дисков.

lun

integer

Это свойство задает номер логического устройства диска данных.

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

os_disk_image

dictionary

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

disk_encryption_set_id

string

Относительный URI, содержащий идентификатор набора шифрования дисков.

security_profile

dictionary

Это свойство задает профиль безопасности образа диска ОС.

confidential_vm_encryption_type

dictionary

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

encrypted_vm_guest_state_only_with_pmk

string

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

encrypted_with_cmk

string

Зашифровано с помощью CMK.

encrypted_with_pmk

string

Зашифровано с помощью PMK.

secure_vm_disk_encryption_set_id

string

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

name

string / обязательный

Имя региона.

regional_replica_count

integer

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

Это свойство применяется к региону, если для него не указано regionalReplicaCount.

Это свойство можно обновлять.

storage_account_type

string

Тип учетной записи хранения.

resource_group

string / обязательный

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

secret

string

Секрет клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы.

state

string

Задает требуемое состояние GalleryImageVersion.

Используйте present для создания или обновления GalleryImageVersion и absent для его удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

storage_profile

dictionary

Профиль хранилища версии образа в галерее.

Обязателен при создании.

data_disks

list / элементы=any

Список снимков дисков данных.

Взаимоисключающий с source_image.

host_caching

string

Кэширование диска на узле.

Варианты:

• "None" ← (по умолчанию)
• "ReadOnly"
• "ReadWrite"

lun

integer

Номер логического устройства диска данных.

source

any

Ссылка на снимок диска данных. Может быть идентификатором ресурса или словарем, содержащим resource_group и name.

os_disk

dictionary

Снимок диска ОС

Несовместимо с source_image

host_caching

string

Кэширование диска на хосте

Варианты:

• "None" ← (по умолчанию)
• "ReadOnly"
• "ReadWrite"

source

any

Ссылка на снимок диска ОС.

Может быть идентификатором ресурса.

Может быть словарём, содержащим resource_group и name.

Может быть словарём, содержащим resource_group, storage_account и uri, если снимок хранится как PageBlob в контейнере учётной записи хранения.

source_image

any

Ссылка на управляемый образ или версию образа из коллекции

Может быть идентификатором ресурса управляемого образа или словарём, содержащим resource_group и name

Может быть идентификатором ресурса версии образа или словарём, содержащим resource_group, gallery_name, gallery_image_name и version

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

Несовместимо с os_disk и data_disks

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар строка:строка, назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с учётом всех переданных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

timeout

integer

Задаёт время ожидания (в минутах) при создании версии образа.

По умолчанию: 10

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить после закрытого ключа.

Используйте при аутентификации с помощью субъекта-службы.

id

string

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

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage/versions/10.1.3"