azure_rm_rediscache_info – Получение фактов экземпляра Azure Cache for Redis

Новая в версии 2.9.

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

Обзор

Получить факты для экземпляра Azure Cache for Redis.

Псевдонимы: azure_rm_rediscache_facts

Требования

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

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.
auth_source строка добавлен в 2.5	Варианты: auto 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`.
name -		Ограничить результаты определенным Azure Cache for Redis.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Группа ресурсов для поиска необходимого Azure Cache for Redis.
return_access_keys логическое значение	Варианты: нет ← да	Указывает, нужно ли возвращать ключи доступа к Azure Cache for Redis.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
subscription_id строка		Ваш идентификатор подписки Azure.
tags -		Ограничить результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации с 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: 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 словарь		при return_access_keys=true	Ключи доступа Azure Cache for Redis.
		primary строка	всегда	Текущий первичный ключ, который клиенты могут использовать для аутентификации кэш Redis. Пример: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=
		secondary строка	всегда	Текущий вторичный ключ, который клиенты могут использовать для аутентификации кэша Redis. Пример: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=
	configuration словарь		всегда	Словарь конфигурации Redis. Пример: maxmeory_reserved
	enable_non_ssl_port логическое		всегда	Указывает, включен ли порт Redis-сервера без SSL (6379).
	host_name строка		всегда	Имя хоста Redis. Пример: testRedis.redis.cache.windows.net
	id строка		всегда	Идентификатор Azure Cache for Redis. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis
	location строка		всегда	Расположение Azure Cache for Redis. Пример: WestUS
	name строка		всегда	Имя Azure Cache for Redis. Пример: myRedis
	provisioning_state строка		всегда	Состояние подготовки кэша Redis. Пример: Creating
	resource_group строка		всегда	Имя группы ресурсов, к которой относится Azure Cache for Redis. Пример: myResourceGroup
	shard_count целое число		всегда	Количество фрагментов в кэше Premium Cluster. Пример: 1
	sku словарь		всегда	Словарь информации SKU.
		name строка	всегда	Имя SKU. Пример: standard
		size строка	всегда	Размер Azure Cache for Redis. Пример: C1
	static_ip строка		всегда	Статический IP-адрес. Пример: 10.75.0.11
	subnet строка		всегда	Полный идентификатор подсети в виртуальной сети для развертывания Azure Cache for Redis. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet']
	tags словарь		всегда	Теги ресурсов. Пример: {'key1': 'value1'}
	tenant_settings словарь		всегда	Словарь настроек клиента. Пример: {'key1': 'value1'}

Состояние

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