azure_rm_aks_facts – Получение фактов службы Azure Kubernetes
Новая версия 2.6.
Описание
- Получить факты для конкретной службы Azure Kubernetes или всех служб Azure Kubernetes.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 - | Ограничить результаты определенной группой ресурсов. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не служебным принципалом. | |
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |
| resource_group - | Группа ресурсов для поиска необходимого Azure Kubernetes Service | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| show_kubeconfig - добавлено в 2.8 |
| Отобразить kubeconfig кластера AKS. Обратите внимание, что операция потребует больше сетевого трафика, не рекомендуется при перечислении AKS. |
| subscription_id string | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов - 'ключ' или 'ключ:значение'. | |
| tenant string | Идентификатор клиента 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 facts for one Azure Kubernetes Service
azure_rm_aks_facts:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all Azure Kubernetes Services
azure_rm_aks_facts:
- name: Get facts by tags
azure_rm_aks_facts:
tags:
- testing
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| azure_aks список | всегда | Список словарей Azure Kubernetes Service. |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_aks_facts_module.html