azure.azcollection.azure_rm_containerinstance_info – Получение данных о контейнерных экземплярах Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Получение данных о контейнерном экземпляре.

Требования

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

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 строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
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 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

Значения возврата

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

Ключевые параметры				Возвращаемое значение	Описание
container_groups сложный				всегда	Список словарей экземпляров контейнеров.
	containers сложный			всегда	Контейнеры внутри группы контейнеров. Пример: containers
		commands список / элементы=строка		всегда	Список команд для выполнения внутри экземпляра контейнера в формате exec. Пример: ['pip install abc']
		cpu целое число		всегда	Требуемое количество ядер процессора для контейнеров. Пример: 1
		environment_variables сложный		успех	Список переменных окружения контейнера.
			name строка	успех	Имя переменной окружения.
			value строка	успех	Значение переменной окружения.
		image строка		всегда	Имя образа контейнера. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer
		memory вещественное число		всегда	Требуемая оперативная память контейнеров в ГБ. Пример: 1.5
		name строка		всегда	Имя экземпляра контейнера. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer
		ports список / элементы=строка		всегда	Список портов, экспонированных внутри группы контейнеров. Пример: [80, 81]
	dns_name_label строка			всегда	Метка имени DNS для IP-адреса. Пример: mydomain
	id строка			всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/contain erGroups/myContainer
	ip_address строка			всегда	IP-адрес экземпляра контейнера. Пример: 173.15.18.1
	location строка			всегда	Расположение ресурса. Пример: westus
	name строка			всегда	Имя ресурса. Пример: mycontainers
	os_type строка			всегда	Тип операционной системы контейнеров. Пример: linux
	ports список / элементы=строка			всегда	Список портов, экспонированных экземпляром контейнера. Пример: [80, 81]
	resource_group строка			всегда	Группа ресурсов, где находится контейнер. Пример: testrg
	tags словарь			успех	Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}

Авторы

Zim Kalinowski (@zikalino)

© 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/azure/azcollection/azure_rm_containerinstance_info_module.html