Spec-Zone.ru › Ansible 2.7

azure_rm_appserviceplan – Управление планом службы приложений

Новое в версии 2.7.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Создание, обновление и удаление экземпляра плана службы приложений.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
-
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
-
добавлено в 2.6
 По умолчанию:
null
URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile
-
добавлено в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
boolean
    Варианты:
  • no
  • да ←
Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source
-
добавлено в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, которая по умолчанию равна auto если переменная не определена.
auto будет следовать умолчанию порядка приоритета параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.
При установке в cli, учетные данные будут получены из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.
msi было добавлено в Ansible 2.6.
cert_validation_mode
-
добавлено в 2.5
    Варианты:
  • validate
  • ignore
Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
-
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment
-
добавлено в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
is_linux
boolean
    Варианты:
  • нет ←
  • да
Определяет, необходимо ли размещать веб-приложение на Linux-рабочей среде.
location
-
Расположение ресурса. Если не установлено, используется расположение из группы ресурсов по умолчанию.
name
- / обязательно
Уникальное имя плана службы приложений для создания или обновления.
number_of_workers
-
Количество рабочих процессов для распределения.
password
-
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
-
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
- / обязательно
Имя группы ресурсов, к которой относится ресурс.
secret
-
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
sku
-
Ценовые пакеты, например, F1, D1, B1, B2, B3, S1, P1, P1V2 и т.д.
Для получения подробной информации см. https://azure.microsoft.com/ru-ru/pricing/details/app-service/plans/.
Для плана службы приложений Linux см. https://azure.microsoft.com/ru-ru/pricing/details/app-service/linux/.
state
-
    Варианты:
  • absent
  • present ←
Утвердить состояние плана службы приложений.
Используйте 'present' для создания или обновления плана службы приложений и 'absent' для его удаления.
subscription_id
-
Идентификатор вашей подписки Azure.
tags
-
Словарь пар ключ-значение типа строка:строка, назначаемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant
-
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя 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 в среде.

Примеры

- name: Create a windows app service plan
  azure_rm_appserviceplan:
    name: "windowsplan1"
    resource_group: "appserviceplan_rg"
    location: "eastus"
    sku: S1

- name: Create a linux app service plan
  azure_rm_appserviceplan:
    resource_group: "appserviceplan_rg"
    name: "linuxplan1"
    location: "eastus"
    sku: S1
    is_linux: true
    number_of_workers: 1

- name: update sku of existing windows app service plan
  azure_rm_appserviceplan:
    name: "windowsplan2"
    resource_group: "appserviceplan_rg"
    location: "eastus"
    sku: S2

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
azure_appserviceplan
словарь
 всегда
Факты о текущем состоянии плана службы приложений

Пример:
{'id': '/subscriptions/<subs_id>/resourceGroups/ansiblewebapp1_plan/providers/Microsoft.Web/serverfarms/win_appplan11'}


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Yunge Zhu(@yungezz)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_appserviceplan_module.html

Spec-Zone.ru

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