azure_rm_rediscache_facts – Получение фактов экземпляра Azure Cache for Redis
Новая версия с 2.8.
Обзор
- Получение фактов для экземпляра Azure Cache for Redis.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная окружения 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 |
| Управляет поведением проверки сертификата для 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_facts:
resource_group: myResourceGroup
name: myRedis
- name: Get Azure Cache for Redis with access keys by name
azure_rm_rediscache_facts:
resource_group: myResourceGroup
name: myRedis
return_access_keys: true
- name: Get Azure Cache for Redis in specific resource group
azure_rm_rediscache_facts:
resource_group: myResourceGroup
Значения возврата
Общие значения возврата описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| rediscaches сложный | всегда | Список экземпляров Azure Cache for Redis. | ||
| access_keys словарь | когда return_access_keys истинно. | Ключи доступа к 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 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 список | Список тегов. Пример: ['foo'] | |||
| tenant_settings словарь | Словарь настроек клиента. | |||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/azure_rm_rediscache_facts_module.html
