Модуль azure.azcollection.azure_rm_containerregistry — управление реестром контейнеров Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_containerregistry.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание, обновление и удаление реестра контейнеров Azure.
Требования
Следующие требования должны быть выполнены на хосте, на котором запускается этот модуль.
- python >= 2.7
- На хосте, на котором запускается этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором запускаются модули из azure.azcollection
- Полные инструкции по установке доступны по адресу 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. |
admin_user_enabled boolean | Если параметр включен, для входа в реестр контейнеров с помощью docker можно использовать имя реестра в качестве имени пользователя, а ключ доступа пользователя-администратора — в качестве пароля. Возможные значения:
|
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле tags каноническим или значения добавляются к существующим тегам. Если поле каноническое, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Возможные значения:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Возможные значения:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Возможные значения:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра авторизации с адреса https://login.microsoft.com/ для проверки центра авторизации. Если задано значение **True**, проверка центра авторизации отключается. Поэтому крайне важно убедиться, что настроенный узел центра авторизации является допустимым и надежным. Задается через профиль файла учетных данных или переменную среды Возможные значения:
|
identity dictionary | Удостоверение для этого ресурса. |
|
type string |
Тип управляемого удостоверения Возможные значения:
|
|
user_assigned_identities dictionary |
Назначенные пользователем управляемые удостоверения и их параметры По умолчанию: |
|
append boolean |
Следует ли добавлять список удостоверений к текущим удостоверениям (true) или заменять текущие удостоверения (false) Возможные значения:
|
|
id list / elements=string |
Список идентификаторов, назначенных пользователем и связанных с этим ресурсом По умолчанию: |
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. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string / обязательный | Имя группы ресурсов, в которой находится или будет создан реестр контейнеров. |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
sku string | Задает используемый SKU. В настоящее время может принимать значение Возможные значения:
|
state 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. |
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: 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 | Включён ли пользователь-администратор. Возвращается: всегда Пример: |
credentials complex | Пароли, заданные для реестра. Возвращается: всегда |
|
password string |
Значение пароля. Возвращается: если реестр существует и задано Пример: |
|
password2 string |
Значение password2. Возвращается: если реестр существует и задано Пример: |
id string | Идентификатор ресурса. Возвращается: всегда Пример: |
location string | Расположение ресурса. Возвращается: всегда Пример: |
login_server string | Сервер входа в реестр. Возвращается: всегда Пример: |
name string | Имя реестра. Возвращается: всегда Пример: |
provisioning_state string | Состояние подготовки. Возвращается: всегда Пример: |
sku string | Имя SKU реестра контейнеров. Возвращается: всегда Пример: |
tags dictionary | Теги, присвоенные ресурсу. Словарь пар строка:строка. Возвращается: всегда |
Ссылки на коллекцию
© 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_containerregistry_module.html