gcp_iam_service_account_info – Сбор информации о GCP ServiceAccount
Новое в версии 2.8.
Обзор
- Сбор информации о GCP ServiceAccount
- Этот модуль назывался
gcp_iam_service_account_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: gcp_iam_service_account_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов к API. | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON Service Account, представленное либо в виде словаря, либо в виде JSON-строки. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON Service Account, если выбран тип serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге сценариев не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a service account
gcp_iam_service_account_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание | |
|---|---|---|---|
| resources сложный | всегда | Список ресурсов | |
| displayName строка | успех | Пользовательское описание учетной записи сервиса. | |
| email строка | успех | Адрес электронной почты учетной записи сервиса. | |
| name строка | успех | Имя учетной записи сервиса. | |
| oauth2ClientId строка | успех | OAuth2 идентификатор клиента для учетной записи сервиса. | |
| projectId строка | успех | Идентификатор проекта, которому принадлежит учетная запись сервиса. | |
| uniqueId строка | успех | Уникальный и стабильный идентификатор учетной записи сервиса. | |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_iam_service_account_info_module.html