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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_rediscache_info.

Добавлен в версии 0.1.2: в azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 0.0.1 в azure.azcollection		URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлен в 0.0.1 в azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 0.0.1 в azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `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`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для указания идентификатора подписки, если ресурс имеет доступ к нескольким подпискам; в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 в azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-эндпоинтов. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлен в 0.0.1 в azure.azcollection	Значение по умолчанию: "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, или войти перед запуском задач или выполнения playbook с помощью 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 сложный			всегда	Список экземпляров 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 булево		всегда	Указывает, включен ли не-SSL порт Redis сервера (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'}

Авторы

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.10/collections/azure/azcollection/azure_rm_rediscache_info_module.html