модуль azure.azcollection.azure_rm_containerinstance_info — получение сведений об экземпляре контейнера Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем также потребуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_containerinstance_info.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Получение сведений об экземпляре контейнера.
Требования
На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.
- 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. |
tags list / элементы=string | Ограничивает результаты указанными тегами. Формат тегов: «key:value». |
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 specific Container Instance facts
azure_rm_containerinstance_info:
resource_group: myResourceGroup
name: myContainer
- name: List Container Instances in a specified resource group name
azure_rm_containerinstance_info:
resource_group: myResourceGroup
tags:
- key
- key:value
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
container_groups complex | Список словарей Container Instance. Возвращается: всегда |
|
containers complex |
Контейнеры в группе контейнеров. Возвращается: всегда Пример: |
|
commands list / elements=string |
Список команд для выполнения в экземпляре контейнера в форме exec. Возвращается: всегда Пример: |
|
cpu integer |
Требуемое количество ядер ЦП для контейнеров. Возвращается: всегда Пример: |
|
environment_variables complex |
Список переменных окружения контейнера. Возвращается: при успешном выполнении |
|
name string |
Имя переменной окружения. Возвращается: при успешном выполнении |
|
value string |
Значение переменной окружения. Возвращается: при успешном выполнении |
|
image string |
Имя образа контейнера. Возвращается: всегда Пример: |
|
memory float |
Требуемый объем памяти для контейнеров в ГБ. Возвращается: всегда Пример: |
|
name string |
Имя экземпляра контейнера. Возвращается: всегда Пример: |
|
ports list / elements=string |
Список портов, доступных в группе контейнеров. Возвращается: всегда Пример: |
|
volume_mounts list / elements=string |
Список томов, подключенных к экземпляру контейнера Возвращается: если к экземпляру контейнера подключены тома Пример: |
|
dns_name_label string |
Метка DNS-имени для IP-адреса. Возвращается: всегда Пример: |
|
id string | Идентификатор ресурса. Возвращается: всегда Пример: |
|
identity complex |
Удостоверение сервера. Возвращается: при наличии |
|
type string |
Тип управляемого удостоверения Возвращается: всегда Пример: |
|
user_assigned_identities complex |
Назначенные пользователем управляемые удостоверения и их параметры Возвращается: всегда |
|
id dictionary |
Словарь идентификаторов назначенных пользователем удостоверений, связанных с ресурсом Возвращается: всегда |
|
ip_address string |
IP-адрес экземпляра контейнера. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
os_type string |
Тип ОС контейнеров. Возвращается: всегда Пример: |
|
ports list / elements=string |
Список портов, доступных в экземпляре контейнера. Возвращается: всегда Пример: |
|
resource_group string |
Группа ресурсов, в которой находится контейнер. Возвращается: всегда Пример: |
|
subnet_ids list / elements=string |
Идентификаторы ресурсов подсетей для группы контейнеров. Возвращается: всегда Пример: |
|
tags dictionary |
Теги, назначенные ресурсу. Словарь пар строка:строка. Возвращается: при успешном выполнении Пример: |
|
volumes list / elements=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_containerinstance_info_module.html