azure.azcollection.azure_rm_devtestlabpolicy_info – Получение фактов политики Azure DTL
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_devtestlabpolicy_info.
Новое в версии 0.1.2: из azure.azcollection
Обзор
- Получение фактов политики Azure DTL.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- 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. |
| lab_name строка / обязательно | Имя лаборатории. | |
| name строка | Имя политики. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| policy_set_name строка / обязательно | Имя набора политик. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags список / элементы=строка | Ограничить результаты, указав список тегов. Формат тегов как 'ключ' или 'ключ:значение'. | |
| 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: Get instance of Policy
azure_rm_devtestlabpolicy_info:
resource_group: myResourceGroup
lab_name: myLab
policy_set_name: myPolicySet
name: myPolicy
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| policies сложный тип | всегда | Список словарей, содержащих факты для политики. | |
| evaluator_type строка | всегда | Тип оценщика для факта политики. Пример: MaxValuePolicy | |
| fact_name строка | всегда | Название факта политики. Пример: UserOwnedLabVmCount | |
| id строка | всегда | Идентификатор источника артефакта. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/po licysets/myPolicySet/policies/myPolicy | |
| lab_name строка | всегда | Название лаборатории. Пример: myLab | |
| name строка | всегда | Название источника артефакта. Пример: myArtifactSource | |
| resource_group строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | |
| tags сложный тип | всегда | Теги ресурса. Пример: { 'MyTag': 'MyValue' } | |
| threshold строка | всегда | Порог факта. Пример: 5 | |
Авторы
- 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.10/collections/azure/azcollection/azure_rm_devtestlabpolicy_info_module.html