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			Варианты: авто cli credential_file env msi	Определяет источник учетных данных для аутентификации. Если не указано, используется переменная среды 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			Варианты: ignore validate	Управление проверкой сертификатов для 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 -			Варианты: public none ←	Тип IP-адреса группы контейнеров (по умолчанию 'none')
location -				Действительное расположение Azure. По умолчанию соответствует расположению группы ресурсов.
name - / обязательно				Имя группы контейнеров.
os_type -			Варианты: linux ← windows	Тип ОС контейнеров.
password -				Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не службой-принципалом.
ports -				Список портов, экспонированных в группе контейнеров.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
registry_login_server -				Сервер входа в реестр образов контейнеров.
registry_password -				Пароль для входа на сервер реестра образов контейнеров.
registry_username -				Имя пользователя для входа на сервер реестра образов контейнеров.
resource_group - / обязательно				Имя группы ресурсов.
restart_policy строка добавлено в 2.8			Варианты: всегда при_ошибке никогда	Политика перезапуска всех контейнеров в группе контейнеров.

секрет строка		Секрет клиента Azure. Используется при аутентификации с помощью Служебного принципала.
состояние -	Варианты: отсутствует присутствует ←	Утверждение состояния экземпляра контейнера. Используйте `present` для создания или обновления экземпляра контейнера и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
теги словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
арендатор строка		Идентификатор арендатора 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как войти с помощью команды az login.

Примеры

- name: Create sample container group
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: mynewcontainergroup
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1.5
        ports:
          - 80
          - 81

Возвращаемые значения

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

Ключ	Возвращаемое	Описание
id строка	всегда	Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89
ip_address строка	если адрес общедоступный	Общедоступный IP-адрес созданной группы контейнеров. Пример: 175.12.233.11
provisioning_state строка	всегда	Состояние подготовки контейнера. Пример: Создание

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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_module.html