Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_containerinstance_info — Получение фактов Azure Container Instance

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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

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

Описание

  • Получение фактов о Container Instance.

Требования

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

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
  • Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Parameter

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in 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

added in 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

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in 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

Родительский аргумент.

name

string

Имя контейнерного экземпляра.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string / required

Имя группы ресурсов.

secret

string

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

subscription_id

string

Ваш идентификатор подписки Azure.

Теги

список / элементы=строка

Ограничить результаты, указав теги. Формат тегов «ключ:значение».

арендатор

строка

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

отпечаток

строка

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

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

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

Требуется, если определен x509_certificate_path.

путь_к_сертификату_x509

путь

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

Путь к сертификату X509, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

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

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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
    tags:
      - key
      - key:value

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

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

Ключ

Описание

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]

volume_mounts

список / элементы=строка

Список томов, смонтированных в экземпляре контейнера

Возвращается: Если тома смонтированы в экземпляре контейнера

Пример: [{"mount_path": "/mnt/repo", "name": "myvolume1"}]

dns_name_label

строка

Метка имени DNS для IP-адреса.

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

Пример: "mydomain"

id

строка

Идентификатор ресурса.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/contain erGroups/myContainer"

identity

сложный

Идентификатор сервера.

Возвращается: при наличии

type

строка

Тип управляемого идентификатора.

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

Пример: "UserAssigned"

user_assigned_identities

сложный

Пользовательские управляемые идентификаторы и их параметры

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

id

словарь

Словарь идентификаторов назначенных пользователю идентификаторов, связанных с ресурсом

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

ip_address

строка

IP-адрес контейнерной инстанции.

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

Пример: "173.15.18.1"

location

строка

Расположение ресурса.

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

Пример: "westus"

name

строка

Имя ресурса.

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

Пример: "mycontainers"

os_type

строка

Тип ОС контейнеров.

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

Пример: "linux"

ports

список / элементы=строка

Список портов, открытых контейнерной инстанцией.

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

Пример: [80, 81]

resource_group

строка

Группа ресурсов, где существует контейнер.

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

Пример: "testrg"

subnet_ids

список / элементы=строка

Идентификаторы ресурсов подсети для группы контейнеров.

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

Пример: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnetrpfx/subnets/subrpfx"}]

tags

словарь

Метки, назначенные ресурсу. Словарь пар строка:строка.

Возвращается: успех

Пример: {"tag1": "abc"}

volumes

список / элементы=строка

Список томов, которые могут быть смонтированы контейнерными инстанциями

Возвращается: если у группы контейнеров есть тома

Пример: [{"git_repo": {"repository": "https://github.com/Azure-Samples/aci-helloworld.git"}, "name": "myvolume1"}]

Авторы

  • Zim Kalinowski (@zikalino)

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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