Модуль azure.azcollection.azure_rm_openshiftmanagedcluster_info — получение сведений об управляемом кластере Azure Red Hat OpenShift
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем необходимы дополнительные компоненты. Подробную информацию см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_openshiftmanagedcluster_info.
Добавлено в azure.azcollection 1.11.0
Краткое описание
- Создание, обновление и удаление экземпляра управляемого кластера Azure Red Hat OpenShift.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. При обнаружении экземпляра метаданные центра извлекаются с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра действителен и заслуживает доверия. Задается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя ресурса. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC. Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
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: List all Azure Red Hat OpenShift Managed Clusters for a given subscription
azure_rm_openshiftmanagedcluster_info:
- name: List all Azure Red Hat OpenShift Managed Clusters for a given resource group
azure_rm_openshiftmanagedcluster_info:
resource_group: myResourceGroup
- name: Get Azure Red Hat OpenShift Managed Clusters
azure_rm_openshiftmanagedcluster_info:
resource_group: myResourceGroup
name: myAzureFirewall
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id string | Идентификатор ресурса. Возвращается: всегда Пример: |
location string | Расположение ресурса. Возвращается: всегда Пример: |
name string | Имя ресурса. Возвращается: всегда Пример: |
properties complex | Свойства управляемого кластера OpenShift. Возвращается: всегда |
|
apiserverProfile complex |
Конфигурация API-сервера. Возвращается: всегда |
|
visibility string |
Видимость API-сервера. Возвращается: всегда Пример: |
|
clusterProfile complex |
Конфигурация кластера OpenShift. Возвращается: всегда |
|
domain string |
Домен кластера. Возвращается: всегда Пример: |
|
fipsValidatedModules string |
Используются ли криптографические модули, проверенные на соответствие FIPS Возвращается: всегда Пример: |
|
resourceGroupId string |
Идентификатор группы ресурсов кластера. Возвращается: всегда Пример: |
|
version string |
Версия OpenShift. Возвращается: всегда Пример: |
|
ingressProfiles list / elements=string |
Конфигурация входящего трафика. Возвращается: всегда Пример: |
|
masterProfile complex |
Конфигурация виртуальных машин ведущих узлов OpenShift. Возвращается: всегда |
|
disk_encryption_set_id string |
Идентификатор связанного DiskEncryptionSet, если применимо. Возвращается: при успешном выполнении |
|
encryptionAtHost string |
Зашифрованы ли виртуальные машины ведущих узлов на стороне узла. Возвращается: всегда Пример: |
|
subnetId string |
Идентификатор ресурса Azure для подсети ведущих узлов (неизменяемый). Возвращается: всегда Пример: |
|
vmSize string |
Размер виртуальных машин агентов (неизменяемый). Возвращается: всегда Пример: |
|
networkProfile complex |
Конфигурация сетевого взаимодействия OpenShift. Возвращается: всегда |
|
outboundType string |
Тип исходящего трафика, используемый для трафика на выход. Возвращается: всегда Пример: |
|
podCidr string |
Диапазон CIDR для подов OpenShift. Возвращается: всегда Пример: |
|
preconfiguredNSG string |
Указывает, предварительно ли подключены к подсетям группы безопасности сети (NSG) Возвращается: всегда Пример: |
|
serviceCidr string |
Диапазон CIDR для служб OpenShift. Возвращается: всегда Пример: |
|
provisioningState string |
Текущее состояние развертывания или подготовки, которое отображается только в ответе. Возвращается: всегда Пример: |
|
servicePrincipalProfile complex |
Субъект-служба. Возвращается: всегда |
|
clientId string |
Идентификатор клиента субъекта-службы. Возвращается: всегда Пример: |
|
workerProfiles complex |
Конфигурация виртуальных машин кластера OpenShift. Возвращается: всегда |
|
count integer |
Количество агентов (виртуальных машин) для размещения контейнеров Docker. Возвращается: всегда Пример: |
|
diskSizeGB integer |
Размер диска в ГБ. Возвращается: всегда Пример: |
|
encryptionAtHost string |
Зашифрованы ли виртуальные машины рабочих узлов на стороне узла. Возвращается: всегда Пример: |
|
name string |
Уникальное имя профиля пула в контексте подписки и группы ресурсов. Возвращается: всегда Пример: |
|
subnetId string |
Идентификатор подсети для пула рабочих узлов. Возвращается: всегда Пример: |
|
vmSize string |
Размер виртуальных машин агентов. Возвращается: всегда Пример: |
type string | Тип ресурса. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_openshiftmanagedcluster_info_module.html