модуль azure.azcollection.azure_rm_containerregistrytag — импорт или удаление тегов в реестре контейнеров Azure

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_containerregistrytag.

Добавлено в azure.azcollection 1.12.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

Импорт или удаление тегов в реестре контейнеров Azure.

Требования

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

python >= 2.7
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены на узле, выполняющем модули из azure.azcollection, с помощью pip
Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Описание
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"`
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"`
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта функция предназначена для ситуаций, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. При установке значения True проверка центра сертификации отключается. Поэтому важно убедиться в достоверности и надежности настроенного узла центра сертификации. Задается в профиле файла учетных данных или с помощью переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Возможные значения: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string	Имя тега. Если параметр не указан при state=present, будет использоваться имя исходного тега. Если параметр не указан при state=absent, будет удален весь репозиторий.
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`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.
profile string	Профиль безопасности из файла ~/.azure/credentials.
registry string / обязательный	Имя реестра контейнеров.
repository_name string	Имя репозитория в реестре. Обязателен, если state = `absent`. Если параметр не указан при state=present, будет использоваться имя исходного репозитория.
resource_group string	Группа ресурсов реестра.
secret string	Секрет клиента Azure. Используйте при аутентификации с субъектом-службой.
source_image dictionary	Сведения об исходном образе. Обязателен при state=present.
credentials dictionary	Учетные данные для исходного реестра.
password string	Пароль для исходного реестра.
username string	Имя пользователя для исходного реестра.
name string	Имя тега. По умолчанию: `"latest"`
registry_uri string	Адрес исходного реестра.
repository string / обязательный	Имя репозитория исходного образа.
state string	Состояние тега реестра контейнеров. Используйте `present` для создания или обновления тега реестра контейнеров и `absent` для удаления тега реестра контейнеров. Возможные значения: `"present"` ← (по умолчанию) `"absent"`
subscription_id string	Идентификатор вашей подписки Azure.
tenant string	Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с субъектом-службой. Обязателен, если задан x509_certificate_path.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен в конец закрытого ключа. Используйте при аутентификации с субъектом-службой.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему до запуска задач или плейбука с помощью az login.
Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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: Import a tag
  azure_rm_containerregistrytag:
    registry: myRegistry
    source_image:
      registry_uri: docker.io
      repository: library/hello-world
      name: latest

- name: Import a tag to a different name
  azure_rm_containerregistrytag:
    registry: myRegistry
    repository_name: app1
    name: v1
    source_image:
      registry_uri: docker.io
      repository: library/hello-world
      name: latest

- name: Delete all tags in repository
  azure_rm_containerregistrytag:
    registry: myRegistry
    repository_name: myRepository
    state: absent

- name: Delete specific tag in repository
  azure_rm_containerregistrytag:
    registry: myRegistry
    repository_name: myRepository
    name: myTag
    state: absent

Авторы

Ross Bender (@l3ender)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_containerregistrytag_module.html