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 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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 |
| Управляет поведением проверки сертификата для 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 булево |
| При установке enable_non_ssl_port=true, порт 6379 для сервера Redis без SSL будет включен. | |
| location - | Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию. | ||
| 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. | |
| maxmemory_reserved - | Настраивает объем памяти в МБ, зарезервированный для операций, не связанных с кэшем. Дополнительные сведения см. в https://docs.microsoft.com/ru-ru/azure/redis-cache/cache-configure#advanced-settings. | ||
| 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. | ||
| reboot - | Перезагрузка указанного(ых) узла(ов) Redis. Возможна потеря данных. | ||
| reboot_type - |
| Узел(ы) Redis для перезагрузки. | |
| shard_id целое число | Если кластеризация включена, идентификатор фрагмента для перезагрузки. | ||
| regenerate_key - | Перегенерировать ключи доступа к кэшу Redis. | ||
| key_type - |
| Ключ Redis для перегенерации. | |
| resource_group - / обязательно | Имя группы ресурсов, к которой принадлежит ресурс. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| shard_count целое число | Количество фрагментов, которые будут созданы при sku=premium. | ||
| sku - | Информация о SKU Azure Cache for Redis. | ||
| name - / обязательно |
| Тип Azure Cache for Redis для развертывания. | |
| размер - / обязательно |
| Размер 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. | |
| состояние - |
| Утверждение состояния Azure Cache for Redis. Используйте present для создания или обновления Azure Cache for Redis и absent для его удаления. | |
| статический_ip - | Статический IP-адрес. Требуется при развертывании Azure Cache for Redis внутри существующей виртуальной сети Azure. | ||
| подсеть - | Подсеть в виртуальной сети, в которой нужно развернуть Azure Cache for Redis. Это может быть идентификатор ресурса подсети, например, /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1. Это может быть словарь, содержащий имя, имя_виртуальной_сети и имя_группы_ресурсов.
имя. Имя подсети.
имя_группы_ресурсов. Имя группы ресурсов подсети.
имя_виртуальной_сети. Имя виртуальной сети, к которой принадлежит эта подсеть. | ||
| идентификатор_подписки строка | Ваш идентификатор подписки Azure. | ||
| метки словарь | Словарь пар строка:строка для назначения метаданных объекту. Метаданные-метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. | ||
| арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью принципала службы. | ||
| настройки_арендатора словарь | Словарь настроек арендатора. | ||
| ожидание_развертывания логическое_значение |
| Ожидание завершения подготовки экземпляра Azure Cache for Redis, состояние provisioning_state которого равно Succeeded. На подготовку Azure Cache for Redis после создания/обновления/перезагрузки требуется несколько минут. Установите этот параметр в значение true, чтобы дождаться provisioning_state. Установите значение false, если состояние provisioning_state вас не интересует.Время ожидания опроса составляет 60 минут. | |
Примечания
Примечание
- Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему до запуска задач или книги сценариев с помощью
az login. - Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
- Для аутентификации через принципала службы передайте идентификатор подписки, идентификатор клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте пользователя ad и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: идентификатор подписки, идентификатор клиента, секрет и арендатор или идентификатор подписки, пользователь ad и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 Cache for Redis. Пример: myredis.redis.cache.windows.net |
| id строка | всегда | Идентификатор Azure Cache for Redis. Пример: /subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/azure_rm_rediscache_module.html
