Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_webappaccessrestriction – Управление ограничениями сетевого доступа веб-приложения

Примечание

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

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_webappaccessrestriction.

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

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

Обзор

  • Добавление, удаление или обновление ограничений сетевого доступа для веб-приложения.

Требования

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

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

Параметры

Параметр

Комментарии

ad_user

строка

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

adfs_authority_url

строка

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

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

api_profile

строка

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

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

По умолчанию: "latest"

auth_source

строка

добавлен в 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"
END_OF_DOCUMENT_MARKER

tag

string

Описание правила ограничения доступа по IP.

Варианты:

  • "Default"
  • "XffProxy"
  • "ServiceTag"

vnet_subnet_resource_id

string

Идентификатор ресурса подсети виртуальной сети.

Должен быть указан только один из параметров: ip_adress или vnet_subnet_resource_id.

Параметр vnet_subnet_resource_id не может использоваться одновременно с параметрами subnet_traffic_tag или vnet_traffic_tag.

vnet_traffic_tag

integer

(внутренне) Тег трафика Vnet.

log_mode

string

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

log_path

string

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

name

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

Имя веб-приложения.

password

string

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

profile

string

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

resource_group

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

Группа ресурсов веб-приложения.

scm_ip_security_restrictions

list / элементы=словарь

Ограничения доступа SCM веб-приложения. Если scm_ip_security_restrictions_use_main установлено в true, ограничения SCM будут настроены, но не будут использоваться.

action

string

Действие трафика для ограничения доступа.

Варианты:

  • "Allow" ← (по умолчанию)
  • "Deny"

description

string

Описание ограничения доступа.

ip_address

string

Адрес IPv4 (с маской подсети) для ограничения доступа.

name

string

Название ограничения доступа.

priority

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

Числовой приоритет ограничения доступа.

subnet_traffic_tag

integer

(внутренне) Теги трафика подсети.

tag

string

Описание правила ограничения доступа по IP.

Варианты:

  • "Default"
  • "XffProxy"
  • "ServiceTag"

vnet_subnet_resource_id

string

Идентификатор ресурса подсети виртуальной сети.

Должен быть указан только один из параметров: ip_adress или vnet_subnet_resource_id.

Параметр vnet_subnet_resource_id не может использоваться одновременно с параметрами subnet_traffic_tag или vnet_traffic_tag.

vnet_traffic_tag

integer

(внутренне) Тег трафика Vnet.

scm_ip_security_restrictions_use_main

boolean

Установите в значение true, чтобы ограничения доступа HTTP также применялись к сайту SCM. Если также применяются scm_ip_security_restrictions, они будут настроены, но не будут использоваться.

Варианты:

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

secret

string

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

state

string

Состояние ограничений доступа. Используйте present для создания или обновления и absent для удаления.

Варианты:

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

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

x509_certificate_path

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: Configure web app access restrictions.
  azure.azcollection.azure_rm_webappaccessrestriction:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    ip_security_restrictions:
      - name: "Datacenter 1"
        action: "Allow"
        ip_address: "1.1.1.1/24"
        priority: 1
      - name: "Datacenter 2"
        action: "Allow"
        ip_address: "2.2.2.2/24"
        priority: 2
      - name: "Datacenter 3"
        action: Allow
        priority: 3
        description: "for test 02"
        tag: XffProxy
        vnet_subnet_resource_id: "{{ subnet_output.state.id }}"
    scm_ip_security_restrictions_use_main: true

- name: Delete web app network access restrictions.
  azure.azcollection.azure_rm_webappaccessrestriction:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    state: "absent"

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

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

Ключ

Описание

ip_security_restrictions

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

Ограничения доступа по HTTP к веб-приложению.

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

action

строка

Действие по ограничению доступа к трафику.

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

Пример: "Allow"

description

строка

Описание ограничения доступа.

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

Пример: "my-access-restriction-description"

ip_address

строка

IP-адрес ограничения доступа.

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

Пример: "1.1.1.1/32"

name

строка

Имя ограничения доступа.

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

Пример: "my-access-restriction"

priority

целое число

Числовой приоритет ограничения доступа.

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

Пример: 1

subnet_traffic_tag

целое число

(внутреннее) Теги трафика подсети.

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

Пример: "int"

tag

строка

Описание правила ограничения IP.

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

Пример: "default"

vnet_subnet_resource_id

строка

Идентификатор ресурса подсети виртуальной сети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/subnet01"

vnet_traffic_tag

целое число

(внутреннее) Тег трафика VNET.

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

Пример: 3

scm_ip_security_restrictions

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

Ограничения доступа к SCM веб-приложения.

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

action

строка

Действие по ограничению доступа к трафику.

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

Пример: "Allow"

description

строка

Описание ограничения доступа.

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

Пример: "my-access-restriction-description"

ip_address

строка

IP-адрес ограничения доступа.

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

Пример: "1.1.1.1/32"

name

строка

Имя ограничения доступа.

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

Пример: "my-access-restriction"

priority

целое число

Числовой приоритет ограничения доступа.

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

Пример: 1

subnet_traffic_tag

целое число

(внутреннее) Теги трафика подсети.

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

Пример: "int"

тег

строка

Описание правила ограничения IP.

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

Пример: "default"

vnet_subnet_resource_id

строка

Идентификатор ресурса подсети виртуальной сети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/subnet01"

vnet_traffic_tag

целое число

(внутреннее) тег трафика Vnet.

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

Пример: 3

scm_ip_security_restrictions_use_main

булево

Используются ли ограничения доступа HTTP для доступа SCM?

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

Пример: false

Авторы

  • Ross Bender (@l3ender)

Ссылки на сборку

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

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

Spec-Zone.ru

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