модуль azure.azcollection.azure_rm_webappslot — управление слотом веб-приложения Azure

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"

app_settings

dictionary

Настройка параметров приложения слота веб-приложения. Подпараметры задаются в формате пар «ключ — значение».

app_state

string

Запуск/остановка/перезапуск слота.

Варианты:

• "started" ← (по умолчанию)
• "stopped"
• "restarted"

append_tags

boolean

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

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

Варианты:

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

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"

auto_swap_slot_name

any

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

Задайте имя целевого слота для автоматического переключения.

Задайте значение False, чтобы отключить автоматическое переключение слотов.

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"

configuration_source

string

Исходный слот, конфигурацию которого следует клонировать при создании слота. Чтобы указать рабочий слот, используйте имя веб-приложения.

container_settings

dictionary

Параметры контейнера слота веб-приложения.

name

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

Имя контейнера, например imagename:tag.

registry_server_password

string

Пароль сервера реестра контейнеров.

registry_server_url

string

URL-адрес сервера реестра контейнеров, например mydockerregistry.io.

registry_server_user

string

Имя пользователя сервера реестра контейнеров.

deployment_source

dictionary

Источник развертывания Git.

branch

string

Имя ветки репозитория.

url

string

URL-адрес репозитория — источника развертывания.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

frameworks

list / элементы=dictionary

Набор параметров платформы выполнения. Каждый параметр представляет собой словарь.

Дополнительную информацию см. на странице https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview.

name

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

Имя платформы.

Список поддерживаемых платформ для веб-приложений Windows и Linux различается.

По состоянию на июнь 2018 года веб-приложения Windows поддерживают java, net_framework, php, python и node.

Веб-приложения Windows поддерживают одновременное использование нескольких платформ.

По состоянию на июнь 2018 года веб-приложения Linux поддерживают java, ruby, php, dotnetcore и node.

Веб-приложения Linux поддерживают только одну платформу.

Платформа Java несовместима с другими платформами.

Варианты:

• "java"
• "net_framework"
• "php"
• "python"
• "ruby"
• "dotnetcore"
• "node"

settings

dictionary

Список параметров платформы.

java_container

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

Имя контейнера Java. Поддерживается только некоторыми платформами java, например Tomcat, Jetty.

java_container_version

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

Версия контейнера Java. Поддерживается только некоторыми платформами java.

Для Tomcat, например 8.0, 8.5, 9.0. Для Jetty, например 9.1, 9.3.

version

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

Версия платформы. Список поддерживаемых значений для веб-приложений Linux см. на странице https://aka.ms/linux-stacks.

Примеры поддерживаемых значений для net_framework: v4.0 для .NET 4.6 и v3.0 для .NET 3.5.

Примеры поддерживаемых значений для php: 5.5, 5.6, 7.0.

Примеры поддерживаемых значений для python: 5.5, 5.6, 7.0.

Примеры поддерживаемых значений для node: 6.6, 6.9.

Примеры поддерживаемых значений для dotnetcore: 1.0, 1.1, 1.2.

Пример поддерживаемого значения для ruby: 2.3.

Пример поддерживаемого значения для java: 1.9 для веб-приложения Windows и 1.8 для веб-приложения Linux.

location

string

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

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.

purge_app_settings

boolean

Удалить все существующие параметры приложения. Заменить параметры приложения слота значениями app_settings.

Варианты:

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

resource_group

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

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

secret

string

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

startup_file

string

Файл запуска слота.

Применимо только к слотам веб-приложений Linux.

state

string

Состояние слота развертывания веб-приложения.

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

Варианты:

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

subscription_id

string

Идентификатор вашей подписки Azure.

swap

dictionary

Переключение слотов развертывания веб-приложения.

action

string

Типы переключения.

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

swap завершает переключение.

reset сбрасывает переключение.

Варианты:

• "preview" ← (по умолчанию)
• "swap"
• "reset"

preserve_vnet

boolean

True сохраняет виртуальную сеть слота при переключении. В противном случае — False.

Варианты:

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

target_slot

string

Имя целевого слота для переключения. Если задано значение None, выполняется переключение с рабочим слотом.

tags

dictionary

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

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

Чтобы удалить теги, задайте для параметра append_tags значение false.

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

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

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

tenant

string

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

thumbprint

string

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

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

Используйте при аутентификации с субъектом-службой.

Обязательно, если задан x509_certificate_path.

webapp_name

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

Имя веб-приложения, которому принадлежит этот слот развертывания.

x509_certificate_path

путь

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

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

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

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

id

строка

Идентификатор текущего слота.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/testapp/slots/stage1"