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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_galleryimageversion.

Добавлена в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
append_tags логический	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноничности любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлено в 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` могут использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. `msi` была добавлена в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`

END_OF_DOCUMENT_MARKER

пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
профиль строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
publishing_profile словарь	Профиль публикации.
end_of_life_date строка	Дата окончания срока действия образа галереи. Это свойство может использоваться для целей вывода из эксплуатации. Это свойство может быть обновлено. Формат должен соответствовать ISO-8601, например, «2019-06-26».
exclude_from_latest логическое	Если exclude_from_latest=true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать этот образ. Возможные значения: `false` `true`
managed_image любой	Ссылка на управляемый образ, это может быть идентификатор ресурса или словарь, содержащий resource_group и name Устарело начиная с версии 2.10, используйте storage_profile вместо этого
replica_count целое число	Количество реплик образа для создания в каждом регионе. Это свойство будет действовать для региона, когда regionalReplicaCount не указано. Это свойство может быть обновлено.
snapshot любой	Используемый исходный снимок. Устарело начиная с версии 2.10, используйте storage_profile вместо этого
storage_account_type строка	Указывает тип хранилища, который будет использоваться для хранения образа. Это свойство не может быть обновлено. Возможные значения: `"Standard_LRS"` `"Standard_ZRS"`
target_regions список / элементы=любой	Целевые регионы, в которые будет реплицироваться образ. Это свойство может быть обновлено.

secure_vm_disk_encryption_set_id string	Идентификатор набора шифрования дисков виртуальных машин.
name string / обязательно	Имя региона.
regional_replica_count целое число	Количество реплик версии образа в каждом регионе. Это свойство будет действовать для региона, когда regionalReplicaCount не указано. Это свойство может быть обновлено.
storage_account_type строка	Тип хранилища.
resource_group строка / обязательно	Имя группы ресурсов.
secret строка	Секрет Azure. Используется при аутентификации с помощью службы принципала.
state строка	Утверждение состояния GalleryImageVersion. Используйте `present`, чтобы создать или обновить GalleryImageVersion, и `absent`, чтобы удалить её. Варианты: `"absent"` `"present"` ← (по умолчанию)
storage_profile словарь	Профиль хранилища Требуется при создании.
data_disks список / элементы=любые	список снимков дисков данных Взаимоисключающее с source_image
host_caching строка	кеширование диска хоста Варианты: `"None"` ← (по умолчанию) `"ReadOnly"` `"ReadWrite"`
lun целое число	lun диска данных
source любой	Ссылка на снимок диска данных. Может быть идентификатором ресурса или словарем, содержащим resource_group и name
os_disk словарь	снимок диска ОС Взаимоисключающее с source_image
host_caching строка	кеширование диска хоста Варианты: `"None"` ← (по умолчанию) `"ReadOnly"` `"ReadWrite"`
source любой	Ссылка на снимок диска ОС. Может быть идентификатором ресурса. Может быть словарем, содержащим resource_group и name. Может быть словарем, содержащим resource_group, storage_account и uri, если снимок хранится как PageBlob в контейнере хранилища.
source_image любой	Ссылка на управляемый образ или версию галереи изображений. Может быть идентификатором ресурса управляемого образа или словарем, содержащим resource_group и name Может быть идентификатором ресурса версии образа или словарем, содержащим resource_group, gallery_name, gallery_image_name и version Взаимоисключающее с os_disk и data_disks
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар строка:строка, присваиваемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор клиента Azure. Используется при аутентификации с помощью службы принципала.
thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы принципала. Требуется, если задан x509_certificate_path.

END_OF_DOCUMENT_MARKER

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

Сертификат должен быть присоединён к закрытому ключу.

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

Примечания

Примечание

Для аутентификации с 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: true
      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: true
      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: true
      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"

- name: Create gallery image by using a os disk snapshot stored in Storage Account container
  azure_rm_galleryimageversion:
    resource_group: myResourceGroup
    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: true
      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:
          resource_group: myResourceGroup
          storage_account: myStorageAccount
          uri: "https://myStorageAccount.blob.core.windows.net/myContainer/myImage.vhd"

Возвращаемые значения

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

Ключ	Описание
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_galleryimageversion_module.html