azure_rm_containerregistry - Управление реестром контейнеров Azure.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление реестра контейнеров Azure.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 bool |
| Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора как пароль для docker login в ваш реестр контейнеров. |
| api_profile (добавлен в 2.5) | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags bool |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. Используйте при аутентификации с сервисным принципалом. | |
| 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. Используйте при аутентификации с сервисным принципалом. | |
| 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 bool | всегда | Включён ли администраторский пользователь Пример: True | |
| credentials complex | всегда | Пароли, определённые для реестра | |
| password str | если реестр существует и admin_user_enabled задано | Значение пароля Пример: pass1value | |
| password2 str | если реестр существует и admin_user_enabled задано | Значение password2 Пример: pass2value | |
| 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 | всегда | Теги | |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется как обратная совместимость.
Обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_containerregistry_module.html
