community.azure.azure_rm_aks_info – Получение фактов о службе Azure Kubernetes

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_aks_info.

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

Описание

Получение фактов о конкретной службе Azure Kubernetes или всех службах Azure Kubernetes.

Требования

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

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 строка		Ограничивает результаты конкретной группой ресурсов.
password строка		Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Группа ресурсов для поиска нужной службы Azure Kubernetes.
secret строка		Секрет клиента Azure. Используется при аутентификации служебным принципалом.
show_kubeconfig строка	Варианты: user admin	Показать kubeconfig кластера AKS. Обратите внимание, что операция потребует больше сетевого трафика; не рекомендуется при перечислении AKS.
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 facts for one Azure Kubernetes Service
  community.azure.azure_rm_aks_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all Azure Kubernetes Services
  community.azure.azure_rm_aks_info:

- name: Get facts by tags
  community.azure.azure_rm_aks_info:
    tags:
      - testing

Возвращаемые значения

Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
azure_aks список / элементы=строка	всегда	Список словарей Azure Kubernetes Service.

Авторы

Yuwei Zhou (@yuwzho)

© 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_aks_info_module.html