azure.azcollection.azure_rm_galleryimageversion_info – Получение информации о версии изображения Azure SIG
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_galleryimageversion_info.
Новое в версии 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. |
| auth_source строка добавлено в 0.0.1 коллекции azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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 |
| Управляет поведением проверки сертификатов для 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 строка / обязательно | Имя общей галереи изображений, в которой находится определение образа. | |
| name строка | Имя ресурса. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с главным принципом службы. | |
| subscription_id строка | Идентификатор вашей Azure подписки. | |
| 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: List gallery image versions in a gallery image definition.
azure_rm_galleryimageversion_info:
resource_group: myResourceGroup
gallery_name: myGallery
gallery_image_name: myImage
- name: Get a gallery image version.
azure_rm_galleryimageversion_info:
resource_group: myResourceGroup
gallery_name: myGallery
gallery_image_name: myImage
name: myVersion
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| versions сложный | всегда | Список результатов словаря, где ключ — имя версии, а значения — информация об этой версии. | |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/myVersion | |
| location строка | всегда | Расположение ресурса. Пример: eastus | |
| name строка | всегда | Имя ресурса. Пример: myVersion | |
| provisioning_state строка | успех | Текущее состояние галереи. Пример: Успешно | |
| publishing_profile словарь | успех | Профиль публикации версии образа галереи. | |
| tags словарь | всегда | Теги ресурса. Пример: {'tag': 'значение'} | |
Авторы
- Liu Qingyi (@smile37773)
© 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_info_module.html