Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_autoscale — Управление настройками автоматического масштабирования Azure

Примечание

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

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

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

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

Новое в azure.azcollection 0.1.2

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

Описание

  • Создание, удаление настроек автоматического масштабирования.

Требования

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

  • 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"

append_tags

boolean

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

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

Choices:

  • false
  • true ← (default)

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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "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.

Choices:

  • false ← (default)
  • true

enabled

boolean

Указывает, включена ли автоматическая масштабирование для ресурса.

Choices:

  • false
  • true ← (default)

location

string

Расположение ресурса.

log_mode

string

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

log_path

string

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

name

string / required

Имя ресурса.

notifications

list / elements=dictionary

Коллекция уведомлений.

custom_emails

список / элементы=строка

Список пользовательских адресов электронной почты. Это значение может быть нулевым или пустым, в этом случае этот атрибут будет проигнорирован.

send_to_subscription_administrator

псевдонимы: email_admin

логическое

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

Варианты:

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

send_to_subscription_co_administrators

псевдонимы: email_co_admin

логическое

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

Варианты:

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

webhooks

список / элементы=строка

Список адресов webhook-уведомлений.

password

строка

Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory вместо служебного принципала.

profile

строка

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

profiles

список / элементы=словарь

Коллекция профилей автоматического масштабирования, определяющих различные параметры масштабирования для разных периодов времени.

Максимум 20 профилей могут быть указаны.

count

строка / обязательно

Количество экземпляров, которое будет установлено, если метрики недоступны для оценки.

По умолчанию используется только в том случае, если текущее количество экземпляров меньше значения по умолчанию.

fixed_date_end

строка

Конкретная конечная дата и время для профиля.

Этот элемент не используется, если используется элемент Повторность.

fixed_date_start

строка

Конкретная начальная дата и время для профиля.

Этот элемент не используется, если используется элемент Повторность.

fixed_date_timezone

строка

Конкретная временная зона для даты и времени профиля.

Этот элемент не используется, если используется элемент Повторность.

max_count

строка

Максимальное количество экземпляров для ресурса.

Фактическое максимальное количество экземпляров ограничено ядрами, доступными в подписке.

min_count

строка

Минимальное количество экземпляров для ресурса.

name

строка / обязательно

Имя профиля.

recurrence_days

список / элементы=строка

Дни, в которые повторяются времена начала профиля.

Этот элемент не используется, если используется элемент FixedDate.

recurrence_frequency

строка

Частота, с которой должен вступать в силу профиль расписания.

Если это значение Week, то каждый день недели будет иметь тот же набор профилей.

Этот элемент не используется, если используется элемент FixedDate.

Варианты:

  • "None" ← (по умолчанию)
  • "Second"
  • "Minute"
  • "Hour"
  • "Day"
  • "Week"
  • "Month"
  • "Year"

recurrence_hours

список / элементы=строка

Часы, в которые повторяются времена начала профиля.

Этот элемент не используется, если используется элемент FixedDate.

recurrence_mins

список / элементы=строка

Минуты, в которые повторяются времена начала профиля.

Этот элемент не используется, если используется элемент FixedDate.

recurrence_timezone

строка

Временная зона для повторяющихся времен начала профиля.

Этот элемент не используется, если используется элемент FixedDate.

END_OF_DOCUMENT_MARKER

правила

список / элементы=словарь

Коллекция правил, предоставляющих триггеры и параметры для действия масштабирования.

Можно указать не более 10 правил.

cooldown

число с плавающей точкой

Время ожидания (в минутах) с момента последнего действия масштабирования до выполнения этого действия.

Должно быть в диапазоне от 1 до 10080.

direction

строка

Указывает, увеличивает или уменьшает ли действие масштабирования количество экземпляров.

Варианты:

  • "Increase"
  • "Decrease"

metric_name

строка / обязательно

Имя метрики, определяющей, за чем следит правило.

metric_resource_uri

строка

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

operator

строка

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

Варианты:

  • "Equals"
  • "NotEquals"
  • "GreaterThan" ← (по умолчанию)
  • "GreaterThanOrEqual"
  • "LessThan"
  • "LessThanOrEqual"

statistic

строка

Способ объединения метрик из нескольких экземпляров.

Варианты:

  • "Average" ← (по умолчанию)
  • "Min"
  • "Max"
  • "Sum"

порог

число с плавающей точкой

Порог метрики, срабатывающий действие масштабирования.

По умолчанию: 70.0

временная_агрегация

строка

Способ объединения собранных данных во времени.

Варианты:

  • "Average" ← (по умолчанию)
  • "Minimum"
  • "Maximum"
  • "Total"
  • "Count"

временной_размер

число с плавающей точкой / обязательно

Детализация (минуты) метрик, за которыми следит правило.

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

Должно быть в диапазоне от 1 до 720.

временной_интервал

число с плавающей точкой / обязательно

Диапазон времени (в минутах), в течение которого собираются данные об экземплярах.

Это значение должно быть больше, чем задержка сбора метрик, которая может варьироваться в зависимости от ресурса.

Должно быть в диапазоне от 5 до 720.

тип

строка

Тип действия, который должен произойти, когда правило масштабирования срабатывает.

Варианты:

  • "PercentChangeCount"
  • "ExactCount"
  • "ChangeCount"

значение

строка

Количество экземпляров, участвующих в действии масштабирования.

Это значение должно быть 1 или больше.

группа_ресурсов

строка / обязательно

Группа ресурсов ресурса.

секрет

строка

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

состояние

строка

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

Варианты:

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

идентификатор_подписки

строка

Ваш идентификатор подписки Azure.

метки

словарь

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

Метаданные метки объекта будут обновлены любыми предоставленными значениями.

Чтобы удалить метки, установите параметр append_tags в значение false.

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

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

Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах.

цель

любое

Идентификатор ресурса, к которому нужно применить настройку масштабирования.

Это может быть строковый идентификатор ресурса.

Также это может быть словарь, содержащий name, subscription_id, namespace, types, resource_group ресурса.

арендатор

строка

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

отпечаток

строка

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

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

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

Требуется, если определено x509_certificate_path.

x509_certificate_path

путь

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

Путь к X509 сертификату, используемому для создания сервисного принципала в формате PEM.

Сертификат должен быть прикреплён к закрытому ключу.

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

Примечания

Примечание

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

См. также

См. также

Вход с помощью Azure CLI

Как выполнить аутентификацию, используя команду az login.

Примеры

- name: Create an auto scale
  azure_rm_autoscale:
    target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
    enabled: true
    profiles:
      - count: '1'
        recurrence_days:
          - Monday
        name: Auto created scale condition
        recurrence_timezone: China Standard Time
        recurrence_mins:
          - '0'
        min_count: '1'
        max_count: '1'
        recurrence_frequency: Week
        recurrence_hours:
          - '18'
    name: scale
    resource_group: myResourceGroup

- name: Create an auto scale with complicated profile
  azure_rm_autoscale:
    target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets
               /myVmss"
    enabled: true
    profiles:
      - count: '1'
        recurrence_days:
          - Monday
        name: Auto created scale condition 0
        rules:
          - time_aggregation: Average
            time_window: 10
            direction: Increase
            metric_name: Percentage CPU
            metric_resource_uri: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtua
                                lMachineScaleSets/vmss"
            value: '1'
            threshold: 70
            cooldown: 5
            time_grain: 1
            statistic: Average
            operator: GreaterThan
            type: ChangeCount
        max_count: '1'
        recurrence_mins:
          - '0'
        min_count: '1'
        recurrence_timezone: China Standard Time
        recurrence_frequency: Week
        recurrence_hours:
          - '6'
    notifications:
      - email_admin: true
        email_co_admin: false
        custom_emails:
          - yuwzho@microsoft.com
    name: scale
    resource_group: myResourceGroup

- name: Delete an Azure Auto Scale Setting
  azure_rm_autoscale:
    state: absent
    resource_group: myResourceGroup
    name: scale

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

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

Ключ

Описание

состояние

словарь

Текущее состояние ресурса.

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

Пример: {"changed": false, "enabled": true, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.insights/autoscalesettings/scale", "location": "eastus", "name": "scale", "notifications": [{"custom_emails": ["yuwzho@microsoft.com"], "send_to_subscription_administrator": true, "send_to_subscription_co_administrators": false, "webhooks": []}], "profiles": [{"count": "1", "max_count": "1", "min_count": "1", "name": "Auto created scale condition 0", "recurrence_days": ["Monday"], "recurrence_frequency": "Week", "recurrence_hours": ["6"], "recurrence_mins": ["0"], "recurrence_timezone": "China Standard Time", "rules": [{"cooldown": 5.0, "direction": "Increase", "metric_name": "Percentage CPU", "metric_resource_uri": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsof t.Compute/virtualMachineScaleSets/MyVmss", "operator": "GreaterThan", "statistic": "Average", "threshold": 70.0, "time_aggregation": "Average", "time_grain": 1.0, "time_window": 10.0, "type": "ChangeCount", "value": "1"}]}], "target": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScale Sets/myVmss"}

Авторы

  • Yuwei Zhou (@yuwzho)

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

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

© 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_autoscale_module.html

Spec-Zone.ru

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