Модуль azure.azcollection.azure_rm_webapp — управление экземплярами веб-приложений

ad_user

string

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

adfs_authority_url

string

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

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

always_on

boolean

Поддерживает приложение загруженным, даже если трафик отсутствует.

Варианты:

• false
• true

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, будут удалены из метаданных объекта.

Варианты:

• 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. В противном случае используется подписка Azure 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_affinity_enabled

boolean

Определяет, отправлять ли файлы cookie привязки сеанса, направляющие запросы клиента в рамках одного сеанса к одному и тому же экземпляру.

Варианты:

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

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"

container_settings

dictionary

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

name

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

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

Чтобы создать приложение с несколькими контейнерами, имя должно быть «COMPOSE|» или «KUBE|», за которыми следует конфигурация в кодировке base64.

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, python, dotnetcore и node.

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

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

Варианты:

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

settings

dictionary

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

java_container

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

Имя контейнера Java.

Поддерживается только при frameworks=java. Примеры значений: Tomcat, JavaSE, RedHat.

java_container_version

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

Версия контейнера Java.

Поддерживается только при frameworks=java.

Примеры значений для Tomcat, 8.5, 9.0, 10.0, 10.1.

version

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

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

Пример поддерживаемого значения для net_framework: v4.8 для .NET 4.8 и v3.5 для .NET 3.5.

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

Примеры поддерживаемых значений для python: 3.8, 3.9, 3.10, 3.11, 3.12.

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

Примеры поддерживаемых значений для dotnetcore: 8, 7, 6.

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

Примеры поддерживаемых значений для java: 21, 17, 11 и 8.

ftps_state

string

Состояние службы FTP/FTPS.

Варианты:

• "AllAllowed"
• "FtpsOnly"
• "Disabled"

http20_enabled

boolean

Настраивает веб-сайт для подключения клиентов по протоколу HTTP 2.0.

Варианты:

• false
• true

https_only

boolean

Настраивает веб-сайт на прием только HTTPS-запросов.

Варианты:

• false
• true

identity

dictionary

Удостоверение объекта

type

string

Тип управляемого удостоверения

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

Назначенные пользователем управляемые удостоверения и их параметры

По умолчанию: {}

append

boolean

Добавлять ли список удостоверений к текущим удостоверениям (true) или заменять текущие удостоверения (false)

Варианты:

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

id

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

Список идентификаторов назначенных пользователем удостоверений, связанных с объектом

По умолчанию: []

location

string

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

log_mode

string

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

log_path

string

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

min_tls_version

string

Минимальная версия шифрования TLS, необходимая для приложения.

Варианты:

• "1.0"
• "1.1"
• "1.2"

name

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

Уникальное имя создаваемого или обновляемого приложения. Для создания или обновления слота развертывания используйте параметр {slot}.

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, а не субъекта-службы.

plan

any

План службы приложений. Обязателен при создании.

Может быть именем существующего плана службы приложений в той же группе ресурсов, что и веб-приложение.

Может быть идентификатором ресурса существующего плана службы приложений. Например: /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>.

Может быть словарем, содержащим пять параметров, описанных ниже.

name — имя плана службы приложений.

resource_group — группа ресурсов плана службы приложений.

sku — SKU плана службы приложений; допустимые значения перечислены на странице https://azure.microsoft.com/en-us/pricing/details/app-service/linux/.

is_linux — является ли план службы приложений планом Linux. По умолчанию используется False.

number_of_workers — количество рабочих узлов плана службы приложений.

profile

string

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

purge_app_settings

boolean

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

Варианты:

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

resource_group

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

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

scm_type

string

Тип репозитория источника развертывания, например LocalGit, GitHub.

Список поддерживаемых значений приведен по адресу https://docs.microsoft.com/en-us/rest/api/appservice/webapps/createorupdate#scmtype.

secret

string

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

site_auth_settings

dictionary

Параметры конфигурации функции аутентификации и авторизации Azure App Service.

aad_claims_authorization

string

Возвращает строку JSON, содержащую параметры ACL Azure AD.

additional_login_params

string

Параметры входа, передаваемые конечной точке авторизации OpenID Connect при входе пользователя.

Каждый параметр должен иметь формат «key=value».

allowed_audiences

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

Допустимые значения аудитории, учитываемые при проверке JWT, выданных Azure Active Directory.

allowed_external_redirect_urls

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

Внешние URL-адреса, на которые можно перенаправлять пользователя при входе в приложение или выходе из него.

Обратите внимание, что строка запроса URL-адреса игнорируется.

auth_file_path

string

Путь к файлу конфигурации с параметрами аутентификации.

Если указан относительный путь, он будет отсчитываться от корневого каталога сайта.

client_id

string

Идентификатор клиента этого приложения — стороны, полагающейся на проверку подлинности (relying party), также известный как client_id.

client_secret

string

Секрет клиента этого приложения — стороны, полагающейся на проверку подлинности (в Azure Active Directory он также называется ключом).

client_secret_certificate_thumbprint

string

Альтернатива секрету клиента — отпечаток сертификата, используемого для подписи.

Это свойство заменяет секрет клиента. Оно также является необязательным.

client_secret_setting_name

string

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

config_version

string

Версия ConfigVersion используемой в текущем приложении функции аутентификации и авторизации.

Значение этого параметра может управлять поведением плоскости управления аутентификацией и авторизацией.

default_provider

string

Поставщик аутентификации по умолчанию, используемый при настройке нескольких поставщиков.

Варианты:

• "AzureActiveDirectory"
• "Facebook"
• "Google"
• "MicrosoftAccount"
• "Twitter"
• "Github"

enabled

boolean

Включить или отключить функцию аутентификации и авторизации для текущего приложения.

Варианты:

• false
• true

facebook_app_id

string

Идентификатор приложения Facebook, используемого для входа.

facebook_app_secret

string

Секрет приложения Facebook, используемого для входа через Facebook.

facebook_app_secret_setting_name

string

Имя параметра приложения, содержащего секрет приложения, используемый для входа через Facebook.

facebook_o_auth_scopes

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

Области OAuth 2.0, запрашиваемые для входа через Facebook.

git_hub_client_id

string

Идентификатор клиента приложения GitHub, используемого для входа.

git_hub_client_secret

string

Секрет клиента приложения GitHub, используемого для входа через GitHub.

git_hub_client_secret_setting_name

string

Имя параметра приложения, содержащего секрет клиента приложения GitHub, используемого для входа через GitHub.

git_hub_o_auth_scopes

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

Области OAuth 2.0, запрашиваемые при аутентификации для входа через GitHub.

Этот параметр является необязательным.

google_client_id

string

Идентификатор клиента OpenID Connect веб-приложения Google.

google_client_secret

string

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

google_client_secret_setting_name

string

Имя параметра приложения, содержащего секрет клиента, связанный с веб-приложением Google.

google_o_auth_scopes

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

Области OAuth 2.0, запрашиваемые при аутентификации для входа через Google.

Этот параметр является необязательным. Если он не задан, по умолчанию используются области «openid», «profile» и «email».

is_auth_from_file

string

Если is_auth_from_file=true, параметры конфигурации аутентификации следует считывать из файла.

Варианты:

• "true"
• "false"

issuer

string

URI издателя OpenID Connect, представляющий сущность, которая выдает токены доступа для этого приложения.

kind

string

Тип ресурса.

microsoft_account_client_id

string

Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для аутентификации.

Этот параметр необходим для включения аутентификации с помощью учетной записи Microsoft.

microsoft_account_client_secret

string

Секрет клиента OAuth 2.0, созданный для приложения, используемого для аутентификации.

microsoft_account_client_secret_setting_name

string

Имя параметра приложения, содержащего секрет клиента OAuth 2.0, созданный для приложения, используемого для аутентификации.

microsoft_account_o_auth_scopes

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

Области OAuth 2.0, запрашиваемые при аутентификации с помощью учетной записи Microsoft.

runtime_version

string

Версия RuntimeVersion используемой в текущем приложении функции аутентификации и авторизации.

token_refresh_extension_hours

float

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

token_store_enabled

boolean

Использовать ли хранилище токенов App Service.

Варианты:

• false
• true

twitter_consumer_key

string

Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа.

twitter_consumer_secret

string

Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа.

Этот параметр необходим для включения входа через Twitter.

twitter_consumer_secret_setting_name

string

Имя параметра приложения, содержащего секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа.

unauthenticated_client_action

string

Действие, выполняемое при попытке неаутентифицированного клиента получить доступ к приложению.

Варианты:

• "RedirectToLoginPage"
• "AllowAnonymous"

startup_file

string

Файл запуска веб-приложения.

Используется только для веб-приложений Linux.

state

string

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

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

Варианты:

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

subscription_id

string

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

tags

dictionary

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

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

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

В настоящее время в тегах зон Azure DNS и служб 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.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

id

string

Идентификатор текущего веб-приложения.

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

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