azure_rm_containerinstance – Управление экземпляром Azure Container Instance
Новая в версии 2.5.
Описание
- Создание, обновление и удаление экземпляра Azure Container Instance.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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. | ||
| append_tags логический тип |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | ||
| 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. | ||
| containers - | Список контейнеров. Требуется при создании. | |||
| commands список добавлено в 2.8 | Список команд для выполнения внутри экземпляра контейнера в формате exec. При обновлении существующего контейнера все существующие команды будут заменены новыми. | |||
| cpu вещественное число | По умолчанию: 1 | Необходимое количество ядер процессора для контейнеров. | ||
| environment_variables словарь добавлено в 2.8 | Список переменных среды контейнера. При обновлении существующего контейнера все существующие переменные будут заменены новыми. | |||
| is_secure логический тип |
| Является ли переменная защищенной. | ||
| name строка | Имя переменной среды. | |||
| value строка | Значение переменной среды. | |||
| image - / обязательно | Имя образа контейнера. | |||
| memory вещественное число | По умолчанию: 1.5 | Требуемая оперативная память контейнеров в ГБ. | ||
| name - / обязательно | Имя экземпляра контейнера. | |||
| ports список | Список портов, доступных в группе контейнеров. | |||
| dns_name_label строка добавлено в 2.8 | Метка имени DNS для IP-адреса. | |||
| force_update логический тип |
| Вынужденное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров. | ||
| ip_address - |
| Тип IP-адреса группы контейнеров. По умолчанию none и создание экземпляра без публичного IP-адреса. | ||
| location - | Действительное расположение Azure. По умолчанию используется расположение группы ресурсов. | |||
| name - / обязательно | Имя группы контейнеров. | |||
| os_type - |
| Тип операционной системы контейнеров. | ||
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | |||
| ports список | Список портов, доступных в группе контейнеров. Этот параметр устарел, используйте ports в containers". | |||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| registry_login_server - | Сервер входа в реестр образов контейнеров. | |||
| registry_password - | Пароль для входа в реестр образов контейнеров. | |||
| registry_username - | Имя пользователя для входа в реестр образов контейнеров. | |||
| resource_group - / обязательно | Имя группы ресурсов. | |||
| restart_policy string added in 2.8 |
| Политика перезапуска для всех контейнеров в группе контейнеров. | ||
| secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью службы принципала. | |||
| state - |
| Утверждение состояния экземпляра контейнера. Используйте present для создания или обновления экземпляра контейнера и absent для его удаления. | ||
| subscription_id string | Ваш идентификатор подписки Azure. | |||
| tags dictionary | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. | |||
| tenant string | Идентификатор 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: Create sample container group
azure_rm_containerinstance:
resource_group: myResourceGroup
name: myContainerInstanceGroup
os_type: linux
ip_address: public
containers:
- name: myContainer1
image: httpd
memory: 1.5
ports:
- 80
- 81
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89 |
| ip_address string | если адрес общедоступный | Общедоступный IP-адрес созданной группы контейнеров. Пример: 175.12.233.11 |
| provisioning_state string | всегда | Состояние подготовки контейнера. Пример: Создание |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_containerinstance_module.html
