azure.azcollection.azure_rm_rediscache – Управление экземпляром Azure Cache for Redis

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.1.2: of azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection			URL-адрес авторизации Azure AD. Используется при аутентификации с использованием имени пользователя/пароля и собственной авторизацией ADFS.
api_profile строка добавлено в 0.0.1 azure.azcollection		Значение по умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение		Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection		Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения `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.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection		Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули будут проверять сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection		Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
enable_non_ssl_port логическое значение		Варианты: нет ← да	При значении enable_non_ssl_port=true будет включен порт 6379 сервера Redis без SSL.
location строка			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
maxfragmentationmemory_reserved строка			Настраивает объем памяти в МБ, резервируемый для учета фрагментации памяти. Дополнительную информацию см. в https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.
maxmemory_policy строка		Варианты: volatile_lru allkeys_lru volatile_random allkeys_random volatile_ttl noeviction	Настраивает политику удаления из кэша. Дополнительную информацию см. в https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.
maxmemory_reserved строка			Настраивает объем памяти в МБ, резервируемый для операций, не связанных с кэшем. Дополнительную информацию см. в https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.
name строка / обязательно			Уникальное имя Azure Cache for Redis для создания или обновления.
notify_keyspace_events строка			Позволяет клиентам получать уведомления о возникновении определенных событий. Дополнительную информацию см. в https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.
password строка			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
reboot строка			Перезагрузка указанных узлов Redis. Возможны потери данных.
	reboot_type строка	Варианты: primary secondary all ←	Узлы Redis, которые нужно перезагрузить.
	shard_id целое число		Если включена кластеризация, идентификатор фрагмента, который нужно перезагрузить.
regenerate_key строка			Перегенерировать ключи доступа к кешу Redis.
	key_type строка	Варианты: primary secondary	Ключ Redis для перегенерации.
resource_group строка / обязательно			Имя группы ресурсов, к которой принадлежит ресурс.
secret строка			Секретный ключ клиента Azure. Используется при аутентификации с главным принципом службы.
shard_count целое число			Количество фрагментов, которые будут созданы при sku=premium.
sku строка			Информация о SKU Azure Cache for Redis.
	name строка / обязательно	Варианты: basic standard premium	Тип Azure Cache for Redis для развертывания.
	size строка / обязательно	Варианты: C0 C1 C2 C3 C4 C5 C6 P1 P2 P3 P4	Размер 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.
state строка		Варианты: absent present ←	Утверждение состояния Azure Cache for Redis. Используйте `present`, чтобы создать или обновить Azure Cache for Redis, и `absent`, чтобы удалить его.
static_ip строка			Статический 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 строка			Ваш идентификатор подписки Azure.

Теги словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
арендатор строка		Идентификатор арендатора Azure. Используется при аутентификации с помощью службы-принципала.
настройки_арендатора словарь		Словарь настроек арендатора.
ждать_развертывание логическое	Варианты: нет да ←	Ожидать, пока состояние развертывания экземпляра Azure Cache for Redis станет Succeeded. Azure Cache for Redis может потребоваться несколько минут для завершения развертывания после создания/обновления/перезапуска. Установите этот параметр в `true` для ожидания состояния provisioning_state. Установите в `false` , если состояние provisioning_state не имеет значения. Время ожидания проверки составляет 60 минут.

Примечания

Примечание

Для аутентификации с 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 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"

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

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

Ключ	Возвращаемое	Описание
имя_хоста строка	при state=present	Имя хоста Azure Cache for Redis. Пример: myredis.redis.cache.windows.net
id строка	всегда	Идентификатор Azure Cache for Redis. Пример: /subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis

Авторы

Yunge Zhu(@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_rediscache_module.html