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

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_webappvnetconnection.

Новая версия в 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 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"`
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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in 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 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`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / required	Имя веб-приложения.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / required	Группа ресурсов веб-приложения.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с главным субъектом безопасности.

состояние строка	Состояние подключения виртуальной сети. Используйте `present` для создания или обновления и `absent` для удаления. Выбори: `"absent"` `"present"` ← (по умолчанию)
подсеть строка	Имя подсети виртуальной сети. Требуется при добавлении или обновлении.
id_подписки строка	Ваш идентификатор подписки Azure.
арендатор строка	Идентификатор аренды Azure. Используйте при аутентификации с помощью принципала службы.
отпечаток_ключа строка добавлен в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью принципала службы. Требуется, если определён x509_certificate_path.
имя_вн строка	Имя виртуальной сети. Требуется при добавлении или обновлении.
группа_ресурсов_вн строка	Имя группы ресурсов для виртуальной сети. По умолчанию использует значение основной `resource_group`.
путь_к_сертификату_x509 путь добавлен в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединён к частному ключу. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
Для аутентификации через принципала службы передайте id_подписки, идентификатор_клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы данные учетных данных можно сохранить в ~/.azure/credentials. Это ini файл, содержащий раздел [default] и следующие ключи: id_подписки, идентификатор_клиента, секрет и арендатор или id_подписки, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: Configure web app with virtual network
  azure.azcollection.azure_rm_webappvnetconnection:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    vnet_name: "MyVnetName"
    subnet: "MySubnetName"

- name: Configure web app with virtual network in different resource group
  azure.azcollection.azure_rm_webappvnetconnection:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    vnet_name: "MyVnetName"
    subnet: "MySubnetName"
    vnet_resource_group: "MyOtherResourceGroup"

- name: Delete web app virtual network
  azure.azcollection.azure_rm_webappvnetconnection:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    state: "absent"

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

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

Ключ	Описание
connection сложное	Подключение виртуальной сети веб-приложения. Возвращается: всегда
id строка	Идентификатор подключения виртуальной сети веб-приложения. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp/virtualNetworkConnections/yyy-yyy_subnet"`
name строка	Имя подключения виртуальной сети веб-приложения. Возвращается: всегда Пример: `"yyy-yyy_subnet"`
subnet_name строка	Имя подсети, подключенной к веб-приложению. Возвращается: всегда Пример: `"mySubnet"`
vnet_name строка	Имя виртуальной сети, подключенной к веб-приложению. Возвращается: всегда Пример: `"myVnet"`
vnet_resource_group строка	Имя группы ресурсов, в которой находится виртуальная сеть. Возвращается: всегда Пример: `"myResourceGroup"`
vnet_resource_id строка	Идентификатор виртуальной сети/подсети, подключенной к веб-приложению. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"`

Авторы

Росс Бендер (@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_webappvnetconnection_module.html