azure.azcollection.azure_rm_galleryimageversion – Управление экземпляром версии изображения Azure SIG

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_galleryimageversion.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
ad_user строка				Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 0.0.1 azure.azcollection				URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлен в 0.0.1 azure.azcollection			По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево			Варианты: нет да ←	Управление тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. При использовании стандартного значения любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 azure.azcollection			Варианты: авто ← cli credential_file env msi	Управление источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет параметров модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считываться из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько, иначе используется по умолчанию az cli подписка. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 azure.azcollection			Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка				Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлен в 0.0.1 azure.azcollection			По умолчанию: "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 булево		Варианты: нет да	Если exclude_from_latest=true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа.
	managed_image строка			Ссылка на управляемый образ, может быть идентификатором ресурса или словарем, содержащим resource_group и name Устарел с версии 2.10, используйте storage_profile вместо этого
	replica_count целое число			Количество реплик версии образа, создаваемых в каждом регионе. Этот параметр будет применяться к региону, если не указан regionalReplicaCount. Этот параметр может быть обновлен.
	snapshot строка			Используемый исходный снимок. Устарел с версии 2.10, используйте storage_profile вместо этого
	storage_account_type строка			Указывает тип учетной записи хранения, который будет использоваться для хранения образа. Этот параметр не может быть обновлен.
	target_regions список / элементы=строка			Целевые регионы, в которые будет происходить репликация версии образа. Этот параметр может быть обновлен.
		name строка		Имя региона.
		regional_replica_count строка		Количество реплик версии образа, создаваемых в каждом регионе. Этот параметр будет применяться к региону, если не указан regionalReplicaCount. Этот параметр может быть обновлен.
		storage_account_type строка		Тип учетной записи хранения.
resource_group строка / обязательно				Имя группы ресурсов.
secret строка				Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state строка			Варианты: отсутствует наличие ←	Утверждение состояния GalleryImageVersion. Используйте `present` для создания или обновления GalleryImageVersion и `absent` для ее удаления.
storage_profile словарь / обязательно				Профиль хранения
	data_disks список / элементы=строка			Список снимков дисков данных Взаимоисключающий с source_image
		host_caching строка	Варианты: Нет ← ReadOnly ReadWrite	Кэширование диска хоста
		lun целое число		LUN диска данных
		source строка		Ссылка на снимок диска данных. Может быть идентификатором ресурса или словарем, содержащим resource_group и name
	os_disk необработанный			Снимок диска ОС Взаимоисключающий с source_image
		host_caching строка	Варианты: Нет ← ReadOnly ReadWrite	Кэширование диска хоста
		source строка		Ссылка на снимок диска ОС. Может быть идентификатором ресурса или словарем, содержащим resource_group и name

	source_image raw	Ссылка на управляемое изображение или версию изображения из галереи Может быть идентификатором ресурса управляемого изображения или словарем, содержащим resource_group и name Может быть идентификатором ресурса версии изображения или словарем, содержащим resource_group,gallery_name, gallery_image_name и version Взаимоисключительно с os_disk и data_disks
subscription_id string		Ваш идентификатор подписки Azure.
tags dictionary		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false.
tenant string		Идентификатор 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

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

Примеры

- name: Create a gallery image version form a managed image
  azure_rm_galleryimageversion:
    resource_group: myResourceGroup
    gallery_name: myGallery
    gallery_image_name: myGalleryImage
    name: 1.1.0
    location: East US
    publishing_profile:
      end_of_life_date: "2020-10-01t00:00:00+00:00"
      exclude_from_latest: yes
      replica_count: 4
      storage_account_type: Standard_LRS
      target_regions:
        - name: West US
          regional_replica_count: 1
        - name: East US
          regional_replica_count: 3
          storage_account_type: Standard_LRS
    storage_profile:
        source_image: /subscriptions/sub123/resourceGroups/group123/providers/Microsoft.Compute/images/myOsImage

- name: Create a gallery image version from another gallery image version
  azure_rm_galleryimageversion:
    resource_group: myResourceGroup
    gallery_name: myGallery
    gallery_image_name: myGalleryImage
    name: 1.2.0
    location: East US
    publishing_profile:
      end_of_life_date: "2020-10-01t00:00:00+00:00"
      exclude_from_latest: yes
      replica_count: 4
      storage_account_type: Standard_LRS
      target_regions:
        - name: West US
          regional_replica_count: 1
        - name: East US
          regional_replica_count: 3
          storage_account_type: Standard_LRS
    storage_profile:
        source_image:
            version: 1.1.0
            gallery_name: myGallery2
            gallery_image_name: myGalleryImage2

- name: Create gallery image by using one os dist snapshot and zero or many data disk snapshots
  azure_rm_galleryimageversion:
    resource_group: myRsourceGroup
    gallery_name: myGallery
    gallery_image_name: myGalleryImage
    name: 3.4.0
    location: East  US
    publishing_profile:
      end_of_life_date: "2020-10-01t00:00:00+00:00"
      exclude_from_latest: yes
      replica_count: 1
      storage_account_type: Standard_LRS
      target_regions:
        - name: East US
          regional_replica_count: 1
          storage_account_type: Standard_LRS
    storage_profile:
      os_disk:
          source: "/subscriptions/mySub/resourceGroups/myGroup/providers/Microsoft.Compute/snapshots/os_snapshot_vma"
      data_disks:
          - lun: 0
            source:
              name: data_snapshot_vma
          - lun: 1
            source: "/subscriptions/mySub/resourceGroups/myGroup/providers/Microsoft.Compute/snapshots/data_snapshot_vmb"

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

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

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

Авторы

Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_galleryimageversion_module.html