azure.azcollection.azure_rm_containerinstance – Управление экземпляром Azure Container Instance

Примечание

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

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_containerinstance.

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

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

Обзор

Создание, обновление и удаление экземпляра Azure Container Instance.

Требования

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

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.
append_tags булево			Варианты: no да ←	Управление тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. При стандартном формате теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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`.
containers строка				Список контейнеров. Необходимо при создании.
	commands список / элементы=строка			Список команд для выполнения внутри экземпляра контейнера в форме exec. При обновлении существующего контейнера все существующие команды будут заменены новыми.
	cpu вещественное число		По умолчанию: 1	Требуемое количество ядер процессора контейнеров.
	environment_variables словарь			Список переменных среды контейнера. При обновлении существующего контейнера все существующие переменные будут заменены новыми.
		is_secure булево	Варианты: no да	Является ли переменная защищенной.
		name строка		Имя переменной среды.
		value строка		Значение переменной среды.
	image строка / обязательно			Имя образа контейнера.
	memory вещественное число		По умолчанию: 1.5	Требуемая память контейнеров в ГБ.
	name строка / обязательно			Имя экземпляра контейнера.
	ports список / элементы=строка			Список портов, открытых в группе контейнеров.
dns_name_label строка				Метка имени DNS для IP-адреса.
force_update булево			Варианты: нет ← да	Принудительное обновление существующего экземпляра контейнера. Любое обновление приведёт к удалению и повторному созданию существующих контейнеров.
ip_address строка			Варианты: public none ←	Тип IP-адреса группы контейнеров. Значение по умолчанию — `none`, и создание экземпляра без публичного IP.
location строка				Действительное местоположение Azure. По умолчанию — местоположение группы ресурсов.
name строка / обязательно				Имя группы контейнеров.
os_type строка			Варианты: linux ← windows	Тип операционной системы контейнеров.
password строка				Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
ports список / элементы=строка				Список портов, открытых в группе контейнеров. Этот параметр устарел, используйте параметр ports внутри containers.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
registry_login_server строка				Сервер входа в реестр образов контейнеров.
registry_password строка				Пароль для входа в реестр образов контейнеров.
registry_username строка				Имя пользователя для входа в реестр образов контейнеров.
resource_group строка / обязательно				Имя группы ресурсов.
restart_policy строка			Варианты: always on_failure never	Политика перезапуска всех контейнеров в группе контейнеров.
secret строка				Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state строка			Варианты: absent present ←	Утверждение состояния экземпляра контейнера. Используйте `present`, чтобы создать или обновить экземпляр контейнера, и `absent`, чтобы удалить его.
subscription_id строка				Ваш идентификатор подписки Azure.
tags словарь				Словарь пар «строка:строка» для назначения в качестве метаданных объекту. Метаданные тегов объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
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: 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	всегда	Состояние подготовки контейнера. Пример: Создание

Авторы

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_module.html