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

ad_user

string

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

adfs_authority_url

string

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

URL-адрес центра Azure AD. Используется для аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.

api_profile

string

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

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

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

auth_source

string

добавлено в 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, на хост-компьютере должен быть включен модуль MSI и он должен являться ресурсом Azure. Если ресурсу предоставлен доступ к нескольким подпискам, для указания идентификатора подписки можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

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

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

Варианты:

• "ignore"
• "validate"

client_id

string

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

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

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

Для облачных сред, отличных от общедоступного облака США: имя среды (определенное в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. В процессе обнаружения экземпляра метаданные центра извлекаются с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому необходимо убедиться, что настроенный узел центра является действительным и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

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

enable_non_ssl_port

boolean

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

Варианты:

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

identity

dictionary

Удостоверение объекта

type

string

Тип управляемого удостоверения

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

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

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

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

id

list / elements=string

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

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

location

string

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

log_mode

string

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

log_path

string

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

maxfragmentationmemory_reserved

integer

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

Подробнее см. https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.

maxmemory_policy

string

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

Подробнее см. https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.

Варианты:

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

maxmemory_reserved

integer

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

Подробнее см. https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.

minimum_tls_version

string

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

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

Варианты:

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

name

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

Уникальное имя создаваемого или обновляемого кэша Azure для Redis.

notify_keyspace_events

string

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

Подробнее см. https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings.

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только токен в исходном виде.

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

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

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

profile

string

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

public_network_access

string

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

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

Варианты:

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

reboot

dictionary

Перезагрузить указанные узлы Redis. Это может привести к потере данных.

reboot_type

string

Узлы Redis, которые нужно перезагрузить.

Варианты:

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

shard_id

string

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

redis_version

string

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

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

Варианты:

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

regenerate_key

dictionary

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

key_type

string

Ключ Redis, который нужно создать повторно.

Варианты:

• "primary"
• "secondary"

resource_group

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

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

secret

string

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

shard_count

integer

Количество создаваемых сегментов при значении sku=premium.

sku

dictionary / обязательный

Сведения о SKU кэша Azure для Redis.

name

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

Тип развертываемого кэша Azure для Redis.

Варианты:

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

size

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

Размер развертываемого кэша Azure для 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 для Redis.

Используйте present для создания или обновления кэша Azure для Redis и absent для его удаления.

Варианты:

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

static_ip

string

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

subnet

any

Подсеть виртуальной сети, в которой будет развернут кэш 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. Имя виртуальной сети, к которой относится эта подсеть.

subscription_id

string

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

tags

dictionary

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

Теги метаданных объекта будут обновлены с использованием указанных значений.

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

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

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

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

tenant

string

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

tenant_settings

dictionary

Словарь параметров клиента.

thumbprint

string

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

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

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

Обязателен, если задано значение x509_certificate_path.

wait_for_provisioning

boolean

Ожидать, пока значение provisioning_state экземпляра Azure Cache for Redis не станет равным Succeeded.

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

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

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

Варианты:

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

x509_certificate_path

path

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

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Закрытый ключ должен быть добавлен после сертификата.

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

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"