azure_rm_resource_facts – Общие сведения о ресурсах Azure.
Новое в версии 2.6.
Обзор
- Получение данных о любом ресурсе с помощью Azure REST API.
- Этот модуль предоставляет доступ к ресурсам, которые не поддерживаются модулями Ansible.
- Обратитесь к https://docs.microsoft.com/en-us/rest/api/ за подробностями, связанными со специфическим REST API ресурса.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| adfs_authority_url - добавлен в 2.6 | Значение по умолчанию: null | URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном авторитете ADFS. | |
| api_profile - добавлен в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| api_version - / обязательно | Конкретная версия API для использования. | ||
| 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. | |
| password - | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| provider - | Тип поставщика, должен быть указан, если не задан URL | ||
| resource_group - | Группа ресурсов для использования. Обязательно, если не указан URL. | ||
| resource_name - | Имя ресурса. | ||
| resource_type - | Тип ресурса. | ||
| secret - | Секретный ключ клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| subresource - | Список подресурсов | ||
| name - | Имя подресурса | ||
| namespace - | Пространство имен подресурса | ||
| type - | Тип подресурса | ||
| subscription_id - | Ваш идентификатор подписки Azure. | ||
| tenant - | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| url - | URL ресурса Azure RM. | ||
Примечания
Примечание
- Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с использованием принципала службы или пользователя 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 в среде.
Примеры
- name: Get scaleset info
azure_rm_resource_facts:
resource_group: "{{ resource_group }}"
provider: compute
resource_type: virtualmachinescalesets
resource_name: "{{ scaleset_name }}"
api_version: "2017-12-01"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| response словарь | всегда | Ответ, специфичный для типа ресурса. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_resource_facts_module.html