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 | Список подресурсов | ||
| namespace | Пространство имен подресурса | ||
| type | Тип подресурса | ||
| name | Имя подресурса | ||
| 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 dict | всегда | Ответ, специфичный для типа ресурса. |
Статус
Этот модуль помечен как бета-версия, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_resource_facts_module.html
