community.azure.azure_rm_devtestlabpolicy_info – Получение фактов политики Azure DTL
Примечание
Этот плагин является частью коллекции community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Чтобы использовать его в книге задач, укажите: community.azure.azure_rm_devtestlabpolicy_info.
Обзор
- Получение фактов политики 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 может быть использована для определения идентификатора подписки, если их несколько, иначе используется по умолчанию подписка из Azure 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
community.azure.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_devtestlabpolicy_info_module.html