azure.azcollection.azure_rm_containerregistry_info – Получение фактов о реестре Azure Container Registry

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_containerregistry_info.

Новое в версии 0.1.2: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получение фактов о реестре контейнеров.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципала службы.
adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_profile строка добавлено в 0.0.1 из azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлено в 0.0.1 из azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `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.
cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-эндпоинтов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
cloud_environment строка добавлено в 0.0.1 из azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment` или адрес URL для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name строка		Имя реестра контейнеров.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципала службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / требуется		Имя группы ресурсов, к которой принадлежит реестр контейнеров.
retrieve_credentials логическое значение	Варианты: нет ← да	Получить учетные данные для реестра контейнеров.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Ограничить результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'.
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: Get instance of Registry
  azure_rm_containerregistry_info:
    resource_group: myResourceGroup
    name: myRegistry

- name: List instances of Registry
  azure_rm_containerregistry_info:
    resource_group: myResourceGroup

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
реестры сложный тип			всегда	Список словарей, содержащих сведения о реестрах.
	admin_user_enabled булево		всегда	Включён ли администраторский пользователь. Пример: True
	credentials сложный тип		при установке `retrieve_credentials` и `admin_user_enabled` на ACR	Учётные данные, поля будут пусты, если администраторский пользователь не включён для ACR.
		password строка	при наличии реестра и установке `admin_user_enabled`	Значение пароля. Пример: pass1value
		password2 строка	при наличии реестра и установке `admin_user_enabled`	Значение password2. Пример: pass2value
		username строка	при наличии реестра и установке `admin_user_enabled`	Имя пользователя для реестра контейнеров. Пример: zim
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr ies/myRegistry
	location строка		всегда	Расположение ресурса. После создания ресурса его изменить нельзя. Пример: westus
	login_server строка		всегда	Сервер входа для реестра. Пример: acrd08521b.azurecr.io
	name строка		всегда	Имя ресурса. Пример: myRegistry
	provisioning_state строка		всегда	Состояние подготовки реестра контейнеров. Пример: Успешно
	sku строка		всегда	Имя SKU реестра контейнеров. Пример: Премиум
	tags словарь		успех	Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}

Авторы

Zim Kalinowski (@zikalino)

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