azure_rm_containerregistry – Управление Azure Container Registry

Новое в версии 2.5.

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

Описание

Создание, обновление и удаление Azure Container Registry.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
admin_user_enabled логическое значение	Варианты: нет ← да	Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора в качестве пароля для входа в реестр контейнеров с помощью docker.
api_profile строка добавлен в 2.5	Значение по умолчанию: "последняя"	Выбирает профиль 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 строка		ID клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment строка добавлен в 2.4	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки конечного подключения для обнаружения метаданных (требуется для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
location -		Действительное расположение Azure. По умолчанию равно расположению группы ресурсов.
name - / обязательно		Имя реестра контейнеров.
password -		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов, в которой существует или будет создан реестр контейнеров.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
sku -	Варианты: Basic Standard ← Premium	Указывает используемую SKU. В настоящее время может быть Basic, Standard или Premium.
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 an azure container registry
  azure_rm_containerregistry:
    name: testacr1
    location: eastus
    resource_group: myResourceGroup
    admin_user_enabled: true
    sku: Premium
    tags:
        Release: beta1
        Environment: Production

- name: Remove an azure container registry
  azure_rm_containerregistry:
    name: testacr2
    resource_group: myResourceGroup
    state: absent

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

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

Ключ		Возвращаемое значение	Описание
admin_user_enabled boolean		всегда	Включен ли администраторский пользователь Пример: True
credentials complex		всегда	Пароли, определённые для реестра
	password string	если реестр существует и `admin_user_enabled` задано	значение пароля Пример: pass1value
	password2 string	если реестр существует и `admin_user_enabled` задано	значение password2 Пример: pass2value
id string		всегда	Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry
location string		всегда	Расположение ресурса Пример: westus
login_server string		всегда	Сервер входа в реестр Пример: myregistry.azurecr.io
name string		всегда	Имя реестра Пример: myregistry
provisioning_state string		всегда	Состояние подготовки Пример: Успешно
sku string		всегда	SKU Пример: Стандартный
tags dictionary		всегда	Теги, назначенные ресурсу. Словарь пар строка:строка.

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Yawei Wang (@yaweiw)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_containerregistry_module.html