Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_ddosprotectionplan — Управление планом защиты от DDoS-атак

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. раздел Требования.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_ddosprotectionplan.

Новинка в azure.azcollection 1.7.0

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

Описание

  • Создание, обновление и удаление экземпляра плана защиты от DDoS-атак.

Требования

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

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты python, указанные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

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

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

Когда установлено в auto (по умолчанию), приоритет имеет параметры модуля -> env -> credential_file -> cli.

Когда установлено в env, учетные данные будут считываться из переменных среды

Когда установлено в credential_file, профиль будет считываться из ~/.azure/credentials.

Когда установлено в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

Когда установлено в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если ресурс имеет доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Также может быть установлено через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает извлечение метаданных узла из https://login.microsoft.com/ для проверки подлинности узла. Установив это значение в **True**, проверка подлинности узла отключается. В результате важно убедиться, что настроенный узел узла является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

location

string

Расположение ресурса. Если не задано, по умолчанию будет использоваться расположение из группы ресурсов.

log_mode

string

родительский аргумент.

log_path

string

родительский аргумент.

name

string / required

Уникальное имя плана службы приложений для создания или обновления.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

строка / обязательно

Имя группы ресурсов, к которой принадлежит ресурс.

secret

строка

Секрет Azure клиента. Используется при аутентификации с помощью управляющего принципа.

state

строка

Утверждение состояния плана защиты от DDoS.

Используйте present для создания или обновления плана защиты от DDoS и absent для его удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

строка

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные теги объекта будут обновлены с предоставленными значениями.

Для удаления тегов установите опцию append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

строка

Идентификатор Azure-аренды. Используется при аутентификации с помощью управляющего принципа.

thumbprint

строка

добавлен в azure.azcollection 1.14.0

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью управляющего принципа.

Требуется, если определён x509_certificate_path.

x509_certificate_path

путь

добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания управляющего принципа в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с помощью управляющего принципа.

Примечания

Примечание

  • Для аутентификации с Azure можно передавать параметры, устанавливать переменные окружения, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с 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 DDoS protection plan"
  azure_rm_ddosprotectionplan:
    resource_group: rg
    location: eastus
    name: ddosplan
- name: Delete DDoS protection plan
  azure_rm_ddosprotectionplan:
    resource_group: rg
    name: ddosplan
    state: absent

Возвращаемые значения

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

Ключ

Описание

state

словарь

Текущее состояние плана защиты от DDoS.

Возвращаемое значение: всегда

Пример: {"etag": "W/60ac0480-44dd-4881-a2ed-680d20b3978e", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/ddosProtectionPlans/ddosplan", "location": "eastus", "name": "ddosplan", "provisioning_state": "Succeeded", "resource_guid": null, "tags": {"a": "b"}, "type": "Microsoft.Network/ddosProtectionPlans", "virtual_networks": []}

Авторы

  • Praveen Ghuge (@praveenghuge)
  • Karl Dasan (@ikarldasan)

Ссылки на коллекцию

  • Система отслеживания задач
  • Домашняя страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_ddosprotectionplan_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API