Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Чтобы использовать его в playbook, укажите: community.azure.azure_rm_rediscache_info.

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

Описание

  • Получение фактов экземпляра 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 могут быть использованы для указания идентификатора подписки, если их несколько, в противном случае используется подписка по умолчанию Azure 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
  community.azure.azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis

- name: Get Azure Cache for Redis with access keys by name
  community.azure.azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis
    return_access_keys: true

- name: Get Azure Cache for Redis in specific resource group
  community.azure.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 Cache.

Пример:
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_rediscache_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API