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

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

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 2.6			URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое		Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5		Варианты: авто 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		Варианты: ignore validate	Управляет поведением проверки сертификатов для конечных точек 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`.
enable_non_ssl_port логическое		Варианты: нет ← да	При значении true порт 6379 не-SSL сервера Redis будет включен.
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` или `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.

состояние -	Варианты: отсутствует наличие ←	Утвердите состояние кэша Azure Redis. Используйте `present` для создания или обновления кэша Azure Redis и `absent` для его удаления.
статический_ip -		Статический IP-адрес. Требуется при развертывании кэша Azure Redis внутри существующей виртуальной сети Azure.
подсеть -		Подсеть в виртуальной сети для развертывания кэша Azure Redis. Это может быть идентификатор ресурса подсети, например, /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network\|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 Это может быть словарь, содержащий `name`, `virtual_network_name` и `resource_group`. `name`. Имя подсети. `resource_group`. Имя группы ресурсов подсети. `virtual_network_name`. Имя виртуальной сети, к которой принадлежит эта подсеть.
идентификатор_подписки строка		Ваш идентификатор подписки Azure.
теги словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
арендатор строка		Идентификатор арендатора Azure. Используется при аутентификации с помощью принципала службы.
настройки_арендатора -		Словарь настроек арендатора.
ожидание_развертывания логическое	Варианты: нет да ←	Ожидание, пока состояние развертывания экземпляра кэша Azure Redis станет Успешно. После создания/обновления/перезагрузки кэша Azure Redis требуется несколько минут, чтобы он был готов к использованию. Установите этот параметр в значение true, чтобы дождаться состояния развертывания. Установите в значение false, если состояние развертывания не имеет значения. Таймаут ожидания опроса составляет 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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"

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

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

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

Статус

Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
Этот модуль поддерживается сообществом 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.8/modules/azure_rm_rediscache_module.html