azure_rm_containerregistry_facts – Получение фактов о реестре контейнеров Azure
Новая версия с 2.7.
Описание
- Получение фактов о реестре контейнеров.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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_facts:
resource_group: myResourceGroup
name: sampleregistry
- name: List instances of Registry
azure_rm_containerregistry_facts:
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 реестра контейнеров. Пример: classic | ||
| tags словарь | Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'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.8/modules/azure_rm_containerregistry_facts_module.html