azure_rm_devtestlabpolicy – Управление экземпляром Azure Policy

Новое в версии 2.8.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Создание, обновление и удаление экземпляра Azure Policy.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
adfs_authority_url строка добавлено в 2.6		URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое значение	Варианты: нет да ←	Управляет тем, будет ли поле тегов каноническим или просто добавляться к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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`.
description -		Описание политики.
fact_name -	Варианты: user_owned_lab_vm_count user_owned_lab_premium_vm_count lab_vm_count lab_premium_vm_count lab_vm_size gallery_image user_owned_lab_vm_count_in_subnet lab_target_cost	Имя факта политики (например, `lab_vm_count`, `lab_vm_size`), MaxVmsAllowedPerLab и т.д.
lab_name - / обязательно		Название лаборатории.
name - / обязательно		Название политики.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
policy_set_name - / обязательно		Название набора политик.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала.
state -	Варианты: отсутствует присутствует ←	Утверждение состояния политики. Используйте `present` для создания или обновления политики и `absent` для ее удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные-теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка		Идентификатор Azure-арендатора. Используется при аутентификации с помощью службы-принципала.
threshold необработанные данные		Порог политики (может быть максимальным значением или списком разрешенных значений).

Примечания

Примечание

Для аутентификации в 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: Create DevTest Lab Policy
  azure_rm_devtestlabpolicy:
    resource_group: myResourceGroup
    lab_name: myLab
    policy_set_name: myPolicySet
    name: myPolicy
    fact_name: user_owned_lab_vm_count
    threshold: 5

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/policySets/ myPolicySet/policies/myPolicy

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом 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.9/modules/azure_rm_devtestlabpolicy_module.html