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 | По умолчанию: null | 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 boolean |
| Получить учетные данные для реестра контейнеров. |
| secret - | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| subscription_id - | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant - | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, задавать переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя 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 в среде.
Примеры
- name: Get instance of Registry
azure_rm_containerregistry_facts:
resource_group: sampleresourcegroup
name: sampleregistry
- name: List instances of Registry
azure_rm_containerregistry_facts:
resource_group: sampleresourcegroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| реестры сложный | всегда | Список словарей, содержащих факты о реестрах. | ||
| admin_user_enabled логический | всегда | Включён ли администраторский пользователь. Пример: True | ||
| credentials сложный | Учетные данные, поля будут пусты, если администраторский пользователь не включён для ACR | |||
| password строка | если реестр существует и admin_user_enabled установлено | Значение пароля Пример: pass1value | ||
| password2 строка | если реестр существует и admin_user_enabled установлено | Значение password2 Пример: pass2value | ||
| username строка | если реестр существует и admin_user_enabled установлено | Имя пользователя для реестра контейнеров. Пример: zim | ||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr ies/myRegistry | ||
| location строка | всегда | Расположение ресурса. После создания его изменить нельзя. Пример: westus | ||
| login_server строка | всегда | Сервер входа для реестра. Пример: acrd08521b.azurecr.io | ||
| name строка | всегда | Имя ресурса. Пример: myRegistry | ||
| provisioning_state строка | всегда | Состояние подготовки реестра контейнеров Пример: Succeeded | ||
| sku строка | всегда | Имя SKU реестра контейнеров. Пример: classic | ||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/azure_rm_containerregistry_facts_module.html