azure.azcollection.azure_rm_containerregistry – Управление реестром Azure Container Registry

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_containerregistry.

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

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

Обзор

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

Требования

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

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.
admin_user_enabled логическое	Варианты: нет ← да	Если включено, вы можете использовать имя записи в реестре в качестве имени пользователя и ключ доступа администратора в качестве пароля для входа в реестр контейнеров Docker.
api_profile строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое	Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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`.
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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

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

Примеры

- name: Create an azure container registry
  azure_rm_containerregistry:
    name: myRegistry
    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: myRegistry
    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		всегда	Теги, назначенные ресурсу. Словарь пар строка:строка.

Авторы

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.10/collections/azure/azcollection/azure_rm_containerregistry_module.html