Модуль azure.azcollection.azure_rm_rediscache_info — получение сведений об экземпляре Azure Cache for Redis
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробную информацию см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_rediscache_info.
Добавлено в 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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра сертификации Azure AD. Используется для аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для использования в случаях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации отключается. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Ограничить результаты указанным экземпляром Azure Cache for Redis. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string / обязательный | Группа ресурсов, в которой нужно найти требуемый экземпляр Azure Cache for Redis. |
return_access_keys boolean | Указывает, нужно ли возвращать ключи доступа Azure Cache for Redis. Варианты:
|
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=string | Ограничить результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение». |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен в конец файла с закрытым ключом. Используется при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или сценария с помощью
az login. - Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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: Get Azure Cache for Redis by name
azure_rm_rediscache_info:
resource_group: myResourceGroup
name: myRedis
- name: Get Azure Cache for Redis with access keys by name
azure_rm_rediscache_info:
resource_group: myResourceGroup
name: myRedis
return_access_keys: true
- name: Get Azure Cache for Redis in specific resource group
azure_rm_rediscache_info:
resource_group: myResourceGroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
rediscaches complex | Список экземпляров Azure Cache for Redis. Возвращается: всегда |
|
access_keys dictionary |
Ключи доступа Azure Cache for Redis. Возвращается: если return_access_keys=true |
|
primary string |
Текущий основной ключ, который клиенты могут использовать для аутентификации в кэше Redis. Возвращается: всегда Пример: |
|
secondary string |
Текущий дополнительный ключ, который клиенты могут использовать для аутентификации в кэше Redis. Возвращается: всегда Пример: |
|
configuration dictionary |
Словарь конфигурации Redis. Возвращается: всегда Пример: |
|
enable_non_ssl_port boolean |
Указывает, включен ли порт сервера Redis без SSL (6379). Возвращается: всегда Пример: |
|
host_name string |
Имя хоста Redis. Возвращается: всегда Пример: |
|
id string |
Идентификатор Azure Cache for Redis. Возвращается: всегда Пример: |
|
location string |
Расположение Azure Cache for Redis. Возвращается: всегда Пример: |
|
minimum_tls_version string добавлено в azure.azcollection 1.10.0 |
Версия TLS, которую должны использовать клиенты при подключении. Возвращается: всегда Пример: |
|
name string |
Имя Azure Cache for Redis. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки кэша Redis. Возвращается: всегда Пример: |
|
public_network_access string добавлено в azure.azcollection 1.10.0 |
Разрешен ли доступ к общедоступной конечной точке для этого кэша. Возвращается: всегда Пример: |
|
redis_version string добавлено в azure.azcollection 1.10.0 |
Версия Redis. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов, к которой относится Azure Cache for Redis. Возвращается: всегда Пример: |
|
shard_count integer |
Количество сегментов в кластерном кэше уровня Premium. Возвращается: всегда Пример: |
|
sku dictionary |
Словарь сведений о SKU. Возвращается: всегда |
|
name string |
Имя SKU. Возвращается: всегда Пример: |
|
size string |
Размер Azure Cache for Redis. Возвращается: всегда Пример: |
|
static_ip string |
Статический IP-адрес. Возвращается: всегда Пример: |
|
subnet string |
Полный идентификатор ресурса подсети в виртуальной сети, в которой будет развернут Azure Cache for Redis. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
tenant_settings dictionary |
Словарь параметров клиента. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_rediscache_info_module.html