azure_rm_containerinstance_facts – Получение фактов о контейнерных экземплярах Azure
Новая версия 2.8.
Описание
- Получить факты о контейнерном экземпляре.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url строка добавлено в 2.6 | URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и вашей собственной службой ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source строка добавлено в 2.5 |
| Управление источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode строка добавлено в 2.5 |
| Управление поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "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_facts:
resource_group: myResourceGroup
name: container_group_name
- name: List Container Instances in a specified resource group name
azure_rm_containerinstance_facts:
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'} | ||||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_containerinstance_facts_module.html
