модуль azure.azcollection.azure_rm_akscredentials_info — Список сведений об учетных данных службы Azure Kubernetes Service

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_akscredentials_info.

Добавлено в azure.azcollection 2.3.0

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

Краткое описание

Список сведений об учетных данных Azure Kubernetes Service.

Требования

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

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 добавлено в azure.azcollection 0.0.1	URL-адрес центра сертификации Azure AD. Используйте при аутентификации с именем пользователя и паролем, если у вас есть собственный центр сертификации ADFS.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в 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 добавлено в 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 добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
cluster_name string / обязательный	Служба Azure Kubernetes Service или все службы Azure Kubernetes Service.
disable_instance_discovery boolean добавлено в 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	Родительский аргумент.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), напрямую используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую. Можно также задать с помощью переменной среды `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Можно также задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
resource_group string / обязательный	Группа ресурсов, в которой следует искать нужную службу Azure Kubernetes Service.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
show_admin_credentials boolean	Определяет, следует ли выводить учетные данные администратора кластера. Варианты: `false` ← (по умолчанию) `true`
show_monitor_credentials boolean	Определяет, следует ли выводить учетные данные пользователя для мониторинга кластера. Варианты: `false` ← (по умолчанию) `true`
show_user_credentials boolean	Определяет, следует ли выводить учетные данные пользователя кластера. Варианты: `false` ← (по умолчанию) `true`
subscription_id string	Идентификатор вашей подписки Azure.
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.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации с помощью субъекта-службы передайте 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 managecluster admin credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluter_name
    show_admin_credentials: true

- name: Get managecluster user credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluster_name
    show_user_credentials: true

- name: Get managecluster monitor user credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluster_name
    show_monitor_credentials: true

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

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

Ключ	Описание
cluster_credentials complex	Список учетных данных пользователя, администратора или пользователя мониторинга управляемого кластера Возвращается: всегда
cluster_name string	Служба Azure Kubernetes Service или все службы Azure Kubernetes Service. Возвращается: всегда Пример: `"testcluster01"`
name string	Имя учетных данных. Возвращается: всегда
resource_group string	Группа ресурсов, в которой следует искать нужную службу Azure Kubernetes Service. Возвращается: всегда
value string	Файл конфигурации Kubernetes в кодировке Base64. Возвращается: всегда Пример: `"apiVersion: ************************"`

Авторы

xuzhang3 (@xuzhang3)
Fred Sun (@Fred-sun)

Ссылки на коллекцию

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