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 | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственного центра авторизации ADFS. | |
| admin_user_enabled булево |
| Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора в качестве пароля для входа в Docker в ваш реестр контейнеров. |
| api_profile строка добавлено в 2.5 | Значение по умолчанию: "последняя" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags булево |
| Используйте для управления тем, является ли поле тегов стандартным или просто добавляет теги к существующим тегам. Когда стандартный, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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, или войти в систему перед запуском задач или сценария с
az login. - Аутентификация также возможна с помощью службы-принципала или пользователя 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 в среде.
См. также
См. также
- Вход с помощью 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 | всегда | Включён ли административный пользователь. Пример: True | |
| credentials complex | всегда | Пароли, определённые для реестра. | |
| password string | при существовании реестра и при установленном admin_user_enabled | Значение пароля. Пример: pass1value | |
| password2 string | при существовании реестра и при установленном admin_user_enabled | Значение password2. Пример: pass2value | |
| id string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry | |
| location string | всегда | Расположение ресурса. Пример: westus | |
| login_server string | всегда | Сервер входа в реестр. Пример: myregistry.azurecr.io | |
| name string | всегда | Имя реестра. Пример: myregistry | |
| provisioning_state string | всегда | Состояние подготовки. Пример: Успешно | |
| sku string | всегда | Имя SKU реестра контейнеров. Пример: Стандартный | |
| tags dictionary | всегда | Метки, назначенные ресурсу. Словарь пар «строка:строка». | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_containerregistry_module.html
