azure_rm_containerregistry - Управление Azure Container Registry.
Новая версия 2.5.
Обзор
- Создание, обновление и удаление Azure Container Registry.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| admin_user_enabled | Значение по умолчанию: no | Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора в качестве пароля для входа в Docker в ваш реестр контейнеров. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags | Значение по умолчанию: yes | Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, которые не найдены в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также может быть задан через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек конечных взаимодействий. По умолчанию все модули будут проверять сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack, возможно, потребуется отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки конечного взаимодействия для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| location | Значение по умолчанию: местоположение_группы_ресурсов | Действительное местоположение Azure. По умолчанию используется местоположение группы ресурсов. |
| name обязательно | Значение по умолчанию: None | Имя реестра контейнеров. |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов, в которой существует или будет создан реестр контейнеров. | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| sku |
| Определяет SKU для использования. В настоящее время может быть Basic, Standard или Premium. |
| state |
| Утверждает состояние реестра контейнеров. Используйте 'present' для создания или обновления реестра контейнеров и 'absent' для его удаления. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | Значение по умолчанию: None | Словарь пар строка:строка для назначения в качестве метаданных объекту. Теги метаданных объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | Значение по умолчанию: None | Идентификатор клиента 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 bool | всегда | Включён ли административный пользователь Пример: True | |
| credentials complex | всегда | Пароли, определённые для реестра | |
| password2 str | при наличии реестра и установлено значение admin_user_enabled | Значение password2 Пример: pass2value | |
| password str | при наличии реестра и установлено значение admin_user_enabled | Значение password Пример: pass1value | |
| id str | всегда | Идентификатор ресурса Пример: /subscriptions/00000000-0000-0000-0000-000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry | |
| location str | всегда | Расположение ресурса Пример: westus | |
| login_server str | всегда | Сервер входа в реестр Пример: myregistry.azurecr.io | |
| name str | всегда | Имя реестра Пример: myregistry | |
| provisioning_state str | всегда | Состояние подготовки Пример: Succeeded | |
| sku str | всегда | SKU Пример: Standard | |
| tags dict | всегда | Теги | |
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратной совместимости интерфейса.
Автор
- 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.5/modules/azure_rm_containerregistry_module.html
