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

Примечание

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

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

Для использования в книге задач, укажите: azure.azcollection.azure_rm_virtualmachineimage_info.

Новое в версии 0.1.2: коллекции azure.azcollection

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

Описание

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

Требования

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

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.
auth_source строка добавлено в 0.0.1 из azure.azcollection	Варианты: auto ← 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`.
location строка / обязательно		Значение расположения Azure, например `westus`, `eastus`, `eastus2`, `northcentralus`, и т. д. Передача только значения расположения вернет список доступных издателей для этого расположения.
offer строка		Название предложения образа. В сочетании со SKU позволяет увидеть список доступных версий образа.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
publisher строка		Имя издателя образа. Список предложений образов, связанных с конкретным издателем.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
sku строка		SKU предложения образа. В сочетании с offer позволяет увидеть список доступных версий.
subscription_id строка		Идентификатор вашей подписки Azure.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
version строка		Конкретный номер версии образа.

Примечания

Примечание

Для аутентификации с 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'}]

Авторы

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

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