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	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также можно задать через переменную среды `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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_devtestlabpolicy_info_module.html