Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_firewallpolicy – Создание, удаление или обновление указанного правила межсетевого экрана.

Примечание

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

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

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

Для использования в книге сценариев укажите: azure.azcollection.azure_rm_firewallpolicy.

Новая функция в azure.azcollection 1.13.0

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

Описание

  • Создает, удаляет или обновляет заданное правило межсетевого экрана в указанной группе ресурсов.

Требования

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

  • 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

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

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

Choices:

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

base_policy

string

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

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

string / обязательно

Имя группы ресурсов.

secret

string

Секретный ключ Azure. Используется при аутентификации с помощью службы-принципала.

state

string

Утверждение состояния политики брандмауэра. Используйте present для создания или обновления и absent для удаления.

Варианты:

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

subscription_id

string

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

tags

словарь

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

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

Чтобы удалить теги, установите опцию append_tags в значение false.

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

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

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

tenant

string

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

threat_intel_mode

string

Режим работы Threat Intel.

Варианты:

  • "alert" ← (по умолчанию)
  • "deny"
  • "off"

threat_intel_whitelist

словарь

Белый список ThreatIntel для политики брандмауэра.

append_fqdns

boolean

Флаг, указывающий, нужно ли добавлять FQDN.

Варианты:

  • false
  • true ← (по умолчанию)

append_ip_addresses

boolean

Флаг, указывающий, нужно ли добавлять IP-адреса.

Варианты:

  • false
  • true ← (по умолчанию)

fqdns

список / элементы=строка

Список FQDN для белого списка ThreatIntel.

ip_addresses

список / элементы=строка

Список IP-адресов для белого списка ThreatIntel.

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, или войти в систему перед выполнением задач или плейбука с помощью 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 a Firewall Policy
  azure_rm_firewallpolicy:
    resource_group: myAzureResourceGroup
    name: myfirewallpolicy
    base_policy: firewallparentpolicy
    threat_intel_mode: alert
    threat_intel_whitelist:
      ip_addresses:
        - 10.0.0.1
        - 10.0.0.2
      fqdns:
        - "*.microsoft.com"
        - "*.azure.com"
    state: present

- name: Update Firewall Policy
  azure_rm_firewallpolicy:
    resource_group: myAzureResourceGroup
    name: myfirewallpolicy
    base_policy: firewallparentpolicy
    threat_intel_mode: deny
    threat_intel_whitelist:
      ip_addresses:
        - 10.0.0.1
      fqdns:
        - "*.microsoft.com"
    state: present
    tags:
      key1: "value1"

- name: Delete Firewall Policy
  azure_rm_firewallpolicy:
    resource_group: myAzureResourceGroup
    name: myfirewallpolicy
    state: absent

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

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

Ключ

Описание

state

сложный

Текущее состояние политики брандмауэра.

Возвращается: всегда

base_policy

словарь

Родительская политика брандмауэра, из которой наследуются правила.

Возвращается: всегда

Пример: {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyAzureResourceGroup/providers/ Microsoft.Network/firewallPolicies/firewallparentpolicy"}

child_policies

список / элементы=словарь

Список ссылок на дочерние политики брандмауэра.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyAzureResourceGroup/providers/ Microsoft.Network/firewallPolicies/childpolicy1"}]

etag

строка

Значение etag политики брандмауэра.

Возвращается: всегда

Пример: "7cb2538e-0e52-4435-8979-4f417e7269d1"

firewalls

список / элементы=словарь

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

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/providers/ Microsoft.Network/azureFirewalls/azurefirewall"}]

id

строка

Идентификатор политики брандмауэра.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyAzureResourceGroup/providers/ Microsoft.Network/firewallPolicies/myfirewallpolicy"

location

строка

Регион Azure, где находится ресурс.

Возвращается: всегда

Пример: "eastus"

name

строка

Имя политики брандмауэра.

Возвращается: всегда

Пример: "myfirewallpolicy"

provisioning_state

строка

Состояние подготовки ресурса.

Возвращается: всегда

Пример: "Succeeded"

rule_collection_groups

список / элементы=словарь

Список ссылок на группы правил FirewallPolicyRuleCollectionGroups.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyAzureResourceGroup/providers/ Microsoft.Network/firewallPolicies/myfirewallpolicy/ ruleCollectionGroups/DefaultNetworkRuleCollectionGroup"}]

tags

список / элементы=строка

Теги ресурса.

Возвращается: всегда

Пример: [{"key1": "value1"}]

threat_intel_mode

строка

Режим работы для угроз по интеллектуальным данным.

Возвращается: всегда

Пример: "Alert"

threat_intel_whitelist

словарь

Список разрешенных угроз по интеллектуальным данным для политики брандмауэра.

Возвращается: всегда

Пример: {"fqdns": ["*.microsoft.com", "*.azure.com"], "ip_addresses": ["10.0.0.1", "10.0.0.2"]}

type

строка

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/FirewallPolicies"

Авторы

  • Aparna Patil (@aparna-patil)

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

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

© 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_firewallpolicy_module.html

Spec-Zone.ru

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