Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_aksversion_info — получение доступных версий Kubernetes, поддерживаемых службой 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_aksversion_info.

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

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

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

  • Получение доступных версий Kubernetes, поддерживаемых службой 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.

allow_preview

boolean

Указывает, находится ли версия Kubernetes в предварительной версии.

Если allow_preview=True, возвращается текущий статус предварительной версии для текущей версии Kubernetes.

Если allow_preview=False, возвращается версия Kubernetes, которая уже не находится в текущем состоянии предварительной версии.

Если параметр не задан allow_preview, возвращаются все доступные версии Kubernetes.

Варианты:

  • false
  • true

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; в противном случае используется подписка Azure 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"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

location

string / обязательный

Получение версий, доступных для создания управляемого кластера Kubernetes.

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.

secret

string

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

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

version

string

Получение версий обновления, доступных для указанной версии управляемого кластера Kubernetes.

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 current preview versions for AKS in location eastus
  azure_rm_aksversion_info:
    location: eastus
    allow_preview: true
- name: Get available versions for AKS in location eastus
  azure_rm_aksversion_info:
    location: eastus
- name: Get  available versions an AKS can be upgrade to
  azure_rm_aksversion_info:
    location: eastis
    version: 1.11.6

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

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

Ключ

Описание

azure_aks_versions

list / элементы=string

Список поддерживаемых версий Kubernetes.

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

Авторы

  • Yuwei Zhou (@yuwzho)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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