Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "latest"

auth_source

string

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

msi был добавлен в Ansible 2.6.

Варианты:

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

cert_validation_mode

string

added in 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

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

name

string

Ограничивает результаты для определенного Azure Cache for Redis.

password

string

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

profile

string

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

resource_group

string / required

Группа ресурсов для поиска нужного Azure Cache for Redis.

return_access_keys

boolean

Указывает, следует ли возвращать ключи доступа Azure Cache for Redis.

Варианты:

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

secret

string

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

subscription_id

string

Ваш идентификатор подписки Azure.

tags

list / elements=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.
  • Для аутентификации через сервисный принципал передайте 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.

Возвращается: всегда

Пример: "X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx="

secondary

string

Текущий вторичный ключ, который клиенты могут использовать для аутентификации кэша Redis.

Возвращается: всегда

Пример: "X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx="

configuration

dictionary

Словарь конфигурации Redis.

Возвращается: всегда

Пример: "maxmeory_reserved"

enable_non_ssl_port

boolean

Указывает, включен ли порт сервера Redis без SSL (6379).

Возвращается: всегда

Пример: false

host_name

string

Имя хоста Redis.

Возвращается: всегда

Пример: "testRedis.redis.cache.windows.net"

id

string

Идентификатор Azure Cache for Redis.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"

location

string

Расположение Azure Cache for Redis.

Возвращается: всегда

Пример: "WestUS"

minimum_tls_version

string

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

Версия TLS, с которой должны подключаться клиенты.

Возвращается: всегда

Пример: "1.2"

name

string

Имя Azure Cache for Redis.

Возвращается: всегда

Пример: "myRedis"

provisioning_state

string

Состояние подготовки кэша Redis.

Возвращается: всегда

Пример: "Creating"

public_network_access

string

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

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

Возвращается: всегда

Пример: "Enabled"

redis_version

string

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

Версия Redis.

Возвращается: всегда

Пример: "6.0.14"

resource_group

string

Имя группы ресурсов, к которой принадлежит Azure Cache for Redis.

Возвращается: всегда

Пример: "myResourceGroup"

shard_count

integer

Количество шардов в кэше кластера Premium.

Возвращается: всегда

Пример: 1

sku

dictionary

Словарь информации о SKU.

Возвращается: всегда

имя

строка

Имя SKU.

Возвращается: всегда

Пример: "standard"

размер

строка

Размер Azure Cache for Redis.

Возвращается: всегда

Пример: "C1"

статический_ip

строка

Статический IP-адрес.

Возвращается: всегда

Пример: "10.75.0.11"

подсеть

строка

Полный идентификатор ресурса подсети в виртуальной сети для развертывания Azure Cache for Redis.

Возвращается: всегда

Пример: "['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet']"

метки

словарь

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

настройки_арендатора

словарь

Словарь настроек арендатора.

Возвращается: всегда

Пример: {"key1": "value1"}

Авторы

  • Yunge Zhu (@yungezz)

Ссылки на сборку

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_rediscache_info_module.html

Spec-Zone.ru

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