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 | Значение по умолчанию: null | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
| admin_user_enabled boolean |
| Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора в качестве пароля для docker login в ваш контейнерный реестр. |
| api_profile - добавлен в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags boolean |
| Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source - добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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 |
| Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но когда используется прокси HTTPS или доступ к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также можно установить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id - | Azure client ID. Используется при аутентификации с сервисным принципалом. | |
| 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 client secret. Используется при аутентификации с сервисным принципалом. | |
| sku - |
| Указывает используемый SKU. В настоящее время может быть Basic, Standard или Premium. |
| state - |
| Утверждает состояние контейнерного реестра. Используйте 'present' для создания или обновления контейнерного реестра и 'absent' для его удаления. |
| subscription_id - | Ваш идентификатор подписки Azure. | |
| tags - | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. | |
| tenant - | Идентификатор Azure-аренды. Используется при аутентификации с сервисным принципалом. |
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью сервисного принципала или пользователя 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 в среде.
Примеры
- name: Create an azure container registry
azure_rm_containerregistry:
name: testacr1
location: eastus
resource_group: testrg
state: present
admin_user_enabled: true
sku: Premium
tags:
Release: beta1
Environment: Production
- name: Remove an azure container registry
azure_rm_containerregistry:
name: testacr2
resource_group: testrg
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/00000000-0000-0000-0000-000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry | |
| location string | всегда | Расположение ресурса Пример: westus | |
| login_server string | всегда | Сервер входа в реестр Пример: myregistry.azurecr.io | |
| name string | всегда | Имя реестра Пример: myregistry | |
| provisioning_state string | всегда | Состояние подготовки Пример: Succeeded | |
| sku string | всегда | SKU Пример: Standard | |
| 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.7/modules/azure_rm_containerregistry_module.html
