Модуль azure.azcollection.azure_rm_containerregistry — Управление реестром Azure Container Registry

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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 Container Registry.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

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 added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
admin_user_enabled boolean	Если включено, вы можете использовать имя реестра в качестве имени пользователя и ключ доступа администратора в качестве пароля для входа в docker в ваш реестр контейнеров. Варианты: `false` ← (default) `true`
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
append_tags boolean	Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом виде любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (default)
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Может быть также установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, он будет читать профиль из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с субъектом безопасности или управляемой идентификацией (msi). Может быть также установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (default) `true`
identity dictionary added in azure.azcollection 2.4.0	Идентификатор для реестра контейнеров.
type string	Тип управляемой идентификации Варианты: `"SystemAssigned"` `"UserAssigned"` `"None"` ← (default)
user_assigned_identities dictionary	Назначенные пользователем управляемые идентификаторы и их параметры По умолчанию: `{}`

append boolean	Если список идентификаторов нужно добавить к текущим идентификаторам (true) или заменить текущие идентификаторы (false) Варианты: `false` `true` ← (по умолчанию)
id список / элементы=строка	Список идентификаторов назначенных пользователем идентификаторов, связанных с реестром контейнеров По умолчанию: `[]`
location строка	Допустимое расположение azure. По умолчанию используется расположение группы ресурсов.
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка / обязательный	Имя реестра контейнеров.
password строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group строка / обязательный	Имя группы ресурсов, в которой существует или будет создан реестр контейнеров.
secret строка	Секретный ключ Azure клиента. Используется при аутентификации с принципалом службы.
sku строка	Указывает SKU для использования. В настоящее время может быть `Basic`, `Standard` или `Premium`. Варианты: `"Basic"` `"Standard"` ← (по умолчанию) `"Premium"`
state строка	Утверждение состояния реестра контейнеров. Используйте `present` для создания или обновления реестра контейнеров и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток уникальности закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с принципалом службы. Требуется, если задан x509_certificate_path.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания принципала службы в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, задавать переменные окружения, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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	Значение password2. Возвращается: при существовании реестра и при установке `admin_user_enabled` Пример: `"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	Состояние подготовки. Возвращается: всегда Пример: `"Succeeded"`
sku string	Имя SKU реестра контейнеров. Возвращается: всегда Пример: `"Standard"`
tags dictionary	Теги, назначенные ресурсу. Словарь пар строка:строка. Возвращается: всегда

Авторы

Yawei Wang (@yaweiw)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_containerregistry_module.html