модуль azure.azcollection.azure_rm_containerinstance — управление экземпляром контейнера Azure

acr_identity

string

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

Удостоверение, используемое для доступа к серверу реестра.

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

По умолчанию: "latest"

append_tags

boolean

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

В каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

auth_source

string

добавлено в 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; в противном случае будет использоваться подписка Azure CLI по умолчанию.

Если задано значение msi, хост-компьютер должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в 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

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

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

По умолчанию: "AzureCloud"

containers

list / elements=dictionary

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

Обязателен при создании.

commands

list / elements=string

Список команд в формате exec для выполнения в экземпляре контейнера.

При обновлении существующего контейнера все существующие команды будут заменены новыми.

cpu

float

Необходимое количество ядер ЦП для контейнеров.

По умолчанию: 1.0

environment_variables

list / elements=dictionary

Список переменных окружения контейнера.

При обновлении существующего контейнера все существующие переменные будут заменены новыми.

is_secure

boolean

Является ли переменная защищенной.

Варианты:

• false
• true

name

string / обязательный

Имя переменной окружения.

value

string / обязательный

Значение переменной окружения.

image

string / обязательный

Имя образа контейнера.

memory

float

Необходимый объем памяти для контейнеров в ГБ.

По умолчанию: 1.5

name

string / обязательный

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

ports

list / elements=integer

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

volume_mounts

list / elements=dictionary

Точки подключения томов для экземпляра контейнера

mount_path

string / обязательный

Путь в контейнере, по которому должен быть подключен том

name

string / обязательный

Имя точки подключения тома

read_only

boolean

Флаг, указывающий, подключен ли том только для чтения

Варианты:

• false
• true

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации отключается. Поэтому крайне важно убедиться, что настроенный узел центра сертификации действителен и заслуживает доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

dns_name_label

string

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

force_update

boolean

Принудительное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров.

Варианты:

• false ← (по умолчанию)
• true

identity

dictionary

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

Удостоверение сервера.

type

string

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

Варианты:

• "SystemAssigned"
• "SystemAssigned, UserAssigned"
• "UserAssigned"

По умолчанию: "None"

user_assigned_identities

dictionary

Назначенные пользователем управляемые удостоверения и их параметры

По умолчанию: {}

id

list / elements=string

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

По умолчанию: []

ip_address

string

Тип IP-адреса группы контейнеров.

По умолчанию задано значение none, при этом экземпляр создается без общедоступного IP-адреса.

Варианты:

• "public"
• "none" ← (по умолчанию)
• "private"

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

name

string / обязательный

Имя группы контейнеров.

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по удостоверению рабочей нагрузки.

Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по удостоверению рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

os_type

string

Тип операционной системы контейнеров.

Варианты:

• "linux" ← (по умолчанию)
• "windows"
• "Linux"
• "Windows"

password

string

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

ports

list / elements=integer

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

Этот параметр устарел; используйте ports в разделе containers“.

По умолчанию: []

profile

string

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

registry_login_server

string

Сервер входа в реестр образов контейнеров.

registry_password

string

Пароль для входа на сервер реестра образов контейнеров.

registry_username

string

Имя пользователя для входа на сервер реестра образов контейнеров.

resource_group

string / обязательный

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

restart_policy

string

Политика перезапуска для всех контейнеров в группе контейнеров.

Варианты:

• "always"
• "on_failure"
• "never"

secret

string

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

state

string

Задайте требуемое состояние экземпляра контейнера. Используйте present для создания или обновления экземпляра контейнера и absent для его удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subnet_ids

list / elements=string

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

Использование нескольких подсетей пока не поддерживается. Можно использовать только одну подсеть.

subscription_id

string

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

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с использованием всех указанных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан параметр x509_certificate_path.

volumes

list / elements=dictionary

Список томов, которые могут быть подключены контейнерами в этой группе контейнеров.

azure_file

dictionary

Том Azure File

read_only

boolean

Флаг, указывающий, доступна ли общая папка Azure File, подключенная как том, только для чтения

Варианты:

• false
• true

share_name

string / обязательный

Имя общей папки Azure File, подключаемой в качестве тома

storage_account_key

string / обязательный

Ключ доступа к учетной записи хранения, используемый для доступа к общей папке Azure File

storage_account_name

string / обязательный

Имя учетной записи хранения, содержащей общую папку Azure File

empty_dir

dictionary

Том пустого каталога

git_repo

dictionary

Том репозитория Git

directory

string

Имя целевого каталога

repository

string / обязательный

URL репозитория

revision

string

Хеш коммита для указанной ревизии

name

string / обязательный

Имя тома

secret

dictionary

Том секретов

x509_certificate_path

path

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

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

Закрытый ключ должен следовать за сертификатом.

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

containers

list / elements=dictionary

Контейнеры в группе контейнеров.

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

Пример: [{"commands": null, "cpu": 1.0, "environment_variables": null, "image": "httpd", "memory": 1.0, "name": "mycontainer1", "ports": [80, 81], "volume_mounts": [{"mount_path": "/data/files", "name": "filesharevolume", "read_only": false}]}]

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

Состояние подготовки контейнера.

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

Пример: "Creating"

volumes

list / elements=dictionary

Список томов, подключенных контейнерами в группе контейнеров

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

azure_file

dictionary

Сведения о томе общей папки Azure File

Возвращается: если запрошен том типа общей папки Azure File

Пример: {"read_only": null, "share_name": "acishare", "storage_account_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "storage_account_name": "mystorageaccount"}

empty_dir

dictionary

Сведения о томе пустого каталога

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

Пример: {}

git_repo

dictionary

Сведения о томе репозитория Git

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

Пример: {"directory": null, "repository": "https://github.com/Azure-Samples/aci-helloworld.git", "revision": null}

name

string

Имя тома

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

Пример: "filesharevolume"

secret

dictionary

Сведения о томе секретов

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

Пример: {}