azure_rm_galleryimageversion – Управление экземпляром Azure SIG Image Version

Новая версия с 2.9.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Обзор

Создание, обновление и удаление экземпляра Azure SIG Image Version.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
ad_user строка				Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не сервисным принципалом.
adfs_authority_url строка добавлен в 2.6				URL-адрес авторизации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile строка добавлен в 2.5			По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логический			Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5			Варианты: авто cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная окружения ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать умолчанию приоритета параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные берутся из профиля Azure CLI по умолчанию. Также может быть задан через переменную окружения `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5			Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную окружения `AZURE_CERT_VALIDATION`.
client_id строка				ID клиента Azure. Используйте при аутентификации сервисным принципалом.
cloud_environment строка добавлен в 2.4			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную окружения `AZURE_CLOUD_ENVIRONMENT`.
gallery_image_name строка / обязательно				Имя определения образа галереи, в котором будет создана версия образа.
gallery_name строка / обязательно				Имя общей галереи образов, в которой находится определение образа.
location строка				Расположение ресурса
name строка / обязательно				Имя создаваемой версии образа галереи. Должно соответствовать шаблону имени семантической версии: разрешены цифры и точки. Цифры должны быть в диапазоне 32-битного целого числа. Формат: <MajorVersion>.<MinorVersion>.<Patch>
password строка				Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не сервисным принципалом.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
publishing_profile словарь / обязательно				Профиль публикации.
	end_of_life_date строка			Дата окончания жизненного цикла версии образа галереи. Этот параметр может использоваться для целей вывода из эксплуатации. Этот параметр может обновляться. Формат должен соответствовать ISO-8601, например "2019-06-26".
	exclude_from_latest -			Если установлено в true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа. тип: bool
	managed_image сырой			Ссылка на управляемый образ, может быть идентификатором ресурса или словарем, содержащим `resource_group` и `name`
	replica_count -			Количество реплик версии образа, которые будут созданы в каждом регионе. Этот параметр будет действовать для региона, если regionalReplicaCount не указан. Этот параметр может обновляться. тип: число
	snapshot сырой			Исходный снимок, который будет использоваться.
	storage_account_type строка			Указывает тип хранилища, который будет использоваться для хранения образа. Этот параметр не может обновляться.
	target_regions список			Целевые регионы, в которые будет происходить репликация версии образа. Этот параметр может обновляться.
		name строка		Имя региона.
		regional_replica_count строка		Количество реплик версии образа, которые будут созданы в каждом регионе. Этот параметр будет действовать для региона, если regionalReplicaCount не указан. Этот параметр может обновляться.
		storage_account_type строка		Тип хранилища.
resource_group строка / обязательно				Имя группы ресурсов.
secret строка				Секретный ключ клиента Azure. Используйте при аутентификации сервисным принципалом.
state строка			Варианты: отсутствует существует ←	Утверждение состояния GalleryImageVersion. Используйте `present` для создания или обновления GalleryImageVersion и `absent` для её удаления.
subscription_id строка				Идентификатор вашей подписки Azure.
tags словарь				Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в false.
tenant строка				Идентификатор Azure-тенанта. Используйте при аутентификации сервисным принципалом.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с использованием управляющего принципа или пользователя Active Directory.
Для аутентификации через управляющего принципа передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: Create or update a simple gallery Image Version.
  azure_rm_galleryimageversion:
    resource_group: myResourceGroup
    gallery_name: myGallery1283
    gallery_image_name: myImage
    name: 10.1.3
    location: West US
    publishing_profile:
      end_of_life_date: "2020-10-01t00:00:00+00:00"
      exclude_from_latest: yes
      replica_count: 3
      storage_account_type: Standard_LRS
      target_regions:
        - name: West US
          regional_replica_count: 1
        - name: East US
          regional_replica_count: 2
          storage_account_type: Standard_ZRS
      managed_image:
        name: myImage
        resource_group: myResourceGroup

Значения возврата

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage/versions/10.1.3

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Zim Kalinowski (@zikalino)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_galleryimageversion_module.html