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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

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

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

Новое в версии 0.1.2: of 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_containerregistry_info_module.html