azure_rm_containerregistry_info – Получение фактов о реестре контейнеров Azure
Новая в версии 2.9.
Описание
- Получить факты о реестре контейнеров.
Псевдонимы: azure_rm_containerregistry_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| adfs_authority_url строка добавлено в 2.6 | URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и вашей собственной авторизацией ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать Azure Stack. |
| 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. |
| 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| registries complex | всегда | Список словарей, содержащих факты о реестрах. | ||
| admin_user_enabled boolean | всегда | Включён ли администраторский пользователь. Пример: True | ||
| credentials complex | когда retrieve_credentials установлено и admin_user_enabled установлено на ACR | Учётные данные, поля будут пустыми, если администраторский пользователь не включён для ACR. | ||
| password string | при существовании реестра и установке admin_user_enabled | Значение пароля. Пример: pass1value | ||
| password2 string | при существовании реестра и установке admin_user_enabled | Значение password2. Пример: pass2value | ||
| username string | при существовании реестра и установке admin_user_enabled | Имя пользователя для реестра контейнеров. Пример: zim | ||
| id string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr ies/myRegistry | ||
| location string | всегда | Расположение ресурса. Его нельзя изменить после создания ресурса. Пример: westus | ||
| login_server string | всегда | Сервер входа в реестр. Пример: acrd08521b.azurecr.io | ||
| name string | всегда | Имя ресурса. Пример: myRegistry | ||
| provisioning_state string | всегда | Состояние подготовки реестра контейнеров. Пример: Succeeded | ||
| sku string | всегда | Имя SKU реестра контейнеров. Пример: Premium | ||
| tags dictionary | Теги, назначенные ресурсу. Словарь пар «строка:строка». Пример: {'tag1': 'abc'} | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/azure_rm_containerregistry_info_module.html