Модуль azure.azcollection.azure_rm_virtualmachineimage_info — Получение фактов о виртуальных машинных образах

Примечание

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

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

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

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

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

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

Описание

Получение фактов о виртуальных машинных образах.

Требования

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

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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"`
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

secret string	Секретный ключ Azure. Используется при аутентификации с помощью службы принципала.
sku string	SKU предложения изображений. Используйте вместе с предложением для просмотра списка доступных версий.
subscription_id string	Ваш идентификатор подписки Azure.
tenant string	Идентификатор клиента Azure. Используется при аутентификации с помощью службы принципала.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы принципала. Требуется, если определен параметр x509_certificate_path.
version string	Конкретный номер версии изображения.
x509_certificate_path path добавлено в 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: Get facts for a specific image
  azure_rm_virtualmachineimage_info:
    location: eastus
    publisher: OpenLogic
    offer: CentOS
    sku: '7.1'
    version: '7.1.20160308'

- name: List available versions
  azure_rm_virtualmachineimage_info:
    location: eastus
    publisher: OpenLogic
    offer: CentOS
    sku: '7.1'

- name: List available offers
  azure_rm_virtualmachineimage_info:
    location: eastus
    publisher: OpenLogic

- name: List available publishers
  azure_rm_virtualmachineimage_info:
    location: eastus

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

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

Ключ	Описание
azure_vmimages список / элементы=строка	Список словарей изображений. Возвращается: всегда Пример: [{"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150410", "location": "eastus", "name": "7.1.20150410"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150605", "location": "eastus", "name": "7.1.20150605"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150731", "location": "eastus", "name": "7.1.20150731"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20160308", "location": "eastus", "name": "7.1.20160308"}]

Ключ

Описание

azure_vmimages

список / элементы=строка

Список словарей изображений.

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

Пример: [{"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150410", "location": "eastus", "name": "7.1.20150410"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150605", "location": "eastus", "name": "7.1.20150605"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20150731", "location": "eastus", "name": "7.1.20150731"}, {"id": "/Subscriptions/xxx...xxx/Providers/Microsoft.Compute/Locations/eastus/ Publishers/OpenLogic/ArtifactTypes/VMImage/Offers/CentOS/Skus/7.1/Versions/7.1.20160308", "location": "eastus", "name": "7.1.20160308"}]

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Ссылки на коллекцию

© 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_virtualmachineimage_info_module.html