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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 string	Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта-службы.
adfs_authority_url string добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас собственный центр ADFS.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в 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"`
cert_validation_mode string добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment string добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра авторизации будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра авторизации с сайта https://login.microsoft.com/ для проверки центра авторизации. Если задать значение True, проверка центра авторизации будет отключена. Поэтому важно убедиться, что настроенный узел центра авторизации действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
ip_security_restrictions list / elements=dictionary	Ограничения HTTP-доступа к веб-приложению.
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	(внутренний параметр) Тег трафика виртуальной сети.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательный	Имя веб-приложения.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
resource_group string / обязательный	Группа ресурсов веб-приложения.
scm_ip_security_restrictions list / elements=dictionary	Ограничения доступа 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	(внутренний параметр) Тег трафика виртуальной сети.
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.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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 list / elements=dictionary	Ограничения HTTP-доступа к веб-приложению. Возвращается: всегда
action string	Действие с трафиком для ограничения доступа. Возвращается: всегда Пример: `"Allow"`
description string	Описание ограничения доступа. Возвращается: всегда Пример: `"my-access-restriction-description"`
ip_address string	IP-адрес для ограничения доступа. Возвращается: всегда Пример: `"1.1.1.1/32"`
name string	Название ограничения доступа. Возвращается: всегда Пример: `"my-access-restriction"`
priority integer	Числовой приоритет ограничения доступа. Возвращается: всегда Пример: `1`
subnet_traffic_tag integer	(внутреннее) Теги трафика подсети. Возвращается: всегда Пример: `"int"`
tag string	Описание правила ограничения IP-адресов. Возвращается: всегда Пример: `"default"`
vnet_subnet_resource_id string	Идентификатор ресурса подсети, связанной с виртуальной сетью. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/subnet01"`
vnet_traffic_tag integer	(внутреннее) Тег трафика виртуальной сети. Возвращается: всегда Пример: `3`
scm_ip_security_restrictions list / elements=dictionary	Ограничения доступа SCM к веб-приложению. Возвращается: всегда
action string	Действие с трафиком для ограничения доступа. Возвращается: всегда Пример: `"Allow"`
description string	Описание ограничения доступа. Возвращается: всегда Пример: `"my-access-restriction-description"`
ip_address string	IP-адрес для ограничения доступа. Возвращается: всегда Пример: `"1.1.1.1/32"`
name string	Название ограничения доступа. Возвращается: всегда Пример: `"my-access-restriction"`
priority integer	Числовой приоритет ограничения доступа. Возвращается: всегда Пример: `1`
subnet_traffic_tag integer	(внутреннее) Теги трафика подсети. Возвращается: всегда Пример: `"int"`
tag string	Описание правила ограничения IP-адресов. Возвращается: всегда Пример: `"default"`
vnet_subnet_resource_id string	Идентификатор ресурса подсети, связанной с виртуальной сетью. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/subnet01"`
vnet_traffic_tag integer	(внутреннее) Тег трафика виртуальной сети. Возвращается: всегда Пример: `3`
scm_ip_security_restrictions_use_main boolean	Используются ли ограничения HTTP-доступа для доступа SCM. Возвращается: всегда Пример: `false`

Авторы

Ross Bender (@l3ender)

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

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