azure_rm_gallery_info – Получение информации о галерее общих образов Azure
Краткое описание
- Получение информации о галерее общих образов Azure.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| adfs_authority_url строка добавлен в 2.6 | URL-адрес службы Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS. | |
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.auto будет следовать по умолчанию приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключения к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| 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 galleries in a subscription.
azure_rm_gallery_info:
- name: List galleries in a resource group.
azure_rm_gallery_info:
resource_group: myResourceGroup
- name: Get a gallery.
azure_rm_gallery_info:
resource_group: myResourceGroup
name: myGallery
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| galleries сложный | всегда | Список результатов в формате dict, где ключ — имя галереи, а значения — информация об этой галерее. | |
| description строка | Описание галереи. Пример: Это описание галереи. | ||
| id строка | всегда | Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx /resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery | |
| location строка | всегда | Расположение ресурса Пример: eastus | |
| name строка | всегда | Имя ресурса Пример: myGallery | |
| provisioning_state строка | Текущее состояние галереи. Пример: Выполнено | ||
| tags словарь | всегда | Теги ресурса Пример: {'тег': 'значение'} | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Лю Циньи (@smile37773)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_gallery_info_module.html
