Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_rediscache — Управление экземпляром Azure Cache for Redis

Примечание

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

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

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

Для использования в playbook укажите: azure.azcollection.azure_rm_rediscache.

Новинка в azure.azcollection 0.1.2

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

Обзор

  • Создание, обновление и удаление экземпляра Azure Cache for Redis.

Требования

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

  • 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

enable_non_ssl_port

boolean

При установке enable_non_ssl_port=true будет включен не-SSL порт сервера Redis 6379.

Choices:

  • false ← (default)
  • true

identity

dictionary

added in azure.azcollection 2.7.0

Идентификатор для WebApp.

type

string

Тип управляемой идентификации

Choices:

  • "SystemAssigned"
  • "UserAssigned"
  • "SystemAssigned, UserAssigned"
  • "None" ← (default)

user_assigned_identities

dictionary

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

Default: {}

append

boolean

Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false)

Выбор:

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

id

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

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

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

location

строка

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

log_mode

строка

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

log_path

строка

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

maxfragmentationmemory_reserved

целое число

Настраивает объем памяти в МБ, резервируемой для компенсации фрагментации памяти.

Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/azure/redis-cache/cache-configure#advanced-settings.

maxmemory_policy

строка

Настраивает политику удаления из кэша.

Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/azure/redis-cache/cache-configure#advanced-settings.

Выбор:

  • "volatile_lru"
  • "allkeys_lru"
  • "volatile_random"
  • "allkeys_random"
  • "volatile_ttl"
  • "noeviction"

maxmemory_reserved

целое число

Настраивает объем памяти в МБ, резервируемый для операций, не связанных с кэшем.

Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/azure/redis-cache/cache-configure#advanced-settings.

minimum_tls_version

строка

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

Требовать от клиентов использование указанной версии TLS.

Выбор:

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

name

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

Уникальное имя Azure Cache for Redis для создания или обновления.

notify_keyspace_events

строка

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

Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/azure/redis-cache/cache-configure#advanced-settings.

password

строка

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

profile

строка

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

public_network_access

строка

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

Разрешено ли общедоступное подключение к кэшу.

Выбор:

  • "Enabled" ← (по умолчанию)
  • "Disabled"

reboot

словарь

Перезагрузить указанный(ые) узел(ы) Redis. Возможна потеря данных.

reboot_type

строка

Какой(ие) узел(ы) Redis перезагрузить.

Выбор:

  • "primary"
  • "secondary"
  • "all"

shard_id

строка

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

redis_version

строка

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

Основная версия Redis.

Выбор:

  • "4"
  • "6" ← (по умолчанию)

regenerate_key

словарь

Перегенерировать ключи доступа к кэшу Redis.

key_type

string

Ключ Redis для повторной генерации.

Выбор:

  • "primary"
  • "secondary"

resource_group

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

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

secret

string

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

shard_count

целое число

Количество фрагментов, которые нужно создать при sku=premium.

sku

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

Информация о SKU Azure Cache for Redis.

name

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

Тип Azure Cache for Redis для развертывания.

Выбор:

  • "basic"
  • "standard"
  • "premium"

size

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

Размер Azure Cache for Redis для развертывания.

При sku=basic или sku=standard разрешенные значения: C0, C1, C2, C3, C4, C5, C6.

При sku=premium разрешенные значения: P1, P2, P3, P4.

См. https://docs.microsoft.com/en-us/rest/api/redis/redis/create#sku для списка разрешенных значений.

Выбор:

  • "C0"
  • "C1"
  • "C2"
  • "C3"
  • "C4"
  • "C5"
  • "C6"
  • "P1"
  • "P2"
  • "P3"
  • "P4"

state

string

Утверждение состояния Azure Cache for Redis.

Используйте present, чтобы создать или обновить Azure Cache for Redis, и absent, чтобы удалить его.

Выбор:

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

static_ip

string

Статический IP-адрес. Требуется при развертывании Azure Cache for Redis внутри существующей виртуальной сети Azure.

subnet

любой

Подсеть в виртуальной сети для развертывания Azure Cache for Redis.

Это может быть идентификатор ресурса подсети, например /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1.

Это может быть словарь, содержащий name, virtual_network_name и resource_group.

name. Имя подсети.

resource_group. Имя группы ресурсов подсети.

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

subscription_id

string

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

tags

словарь

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

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

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

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

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

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

tenant

string

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

tenant_settings

словарь

Словарь настроек аренды.

thumbprint

string

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

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

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

Необходим, если определен x509_certificate_path.

wait_for_provisioning

булево

Ожидать завершения подготовки экземпляра Azure Cache for Redis.

Azure Cache for Redis может занимать несколько минут, чтобы подготовиться к использованию после создания/обновления/перезагрузки.

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

Время ожидания опроса — 60 минут.

Выбор:

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

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. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

См. также

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

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

Примеры

- name: Create an Azure Cache for Redis
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: basic
      size: C1

- name: Scale up the Azure Cache for Redis
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: standard
      size: C1
    tags:
      testing: foo

- name: Force reboot the redis cache
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedisCache
    reboot:
      reboot_type: all

- name: Create Azure Cache for Redis with subnet
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: premium
      size: P1
    subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirt
                ualNetwork/subnets/mySubnet"

- name: Regenerate primary Redis key
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    regenerate_key:
      key_type: primary

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

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

Ключ

Описание

host_name

string

Имя хоста Azure Cache for Redis.

Возвращается: при state=present

Пример: "myredis.redis.cache.windows.net"

id

string

Идентификатор Azure Cache for Redis.

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

Пример: "/subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"

Авторы

  • Yunge Zhu(@yungezz)

Ссылки на сборку

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

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

Spec-Zone.ru

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