Модуль google.cloud.gcp_storage_default_object_acl – создание GCP DefaultObjectACL

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_storage_default_object_acl.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Ресурсы DefaultObjectAccessControls представляют списки контроля доступа (ACL), применяемые к новому объекту в сегменте Google Cloud Storage, если для этого объекта не был указан ACL. ACL позволяют задать, кто и в какой мере имеет доступ к содержимому сегмента.
Сущности можно назначить одну из двух ролей: READER могут получать объект, однако свойство acl им не раскрывается.
OWNER имеют права READER и могут получать свойство acl, обновлять объект и вызывать все методы objectAccessControls для объекта. Владелец объекта всегда имеет роль OWNER.
Дополнительные сведения см. в разделе «Контроль доступа». Обратите внимание, что этот API использует роли READER и OWNER вместо READ и FULL_CONTROL.

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учётных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учётных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
bucket dictionary / обязательный	Имя сегмента.
entity string / обязательный	Сущность, которой предоставлено разрешение, в одном из следующих форматов: * user-{{userId}} * user-{{email}} (например, «user-liz@example.com») * group-{{groupId}} * group-{{email}} (например, «group-example@googlegroups.com») * domain-{{domain}} (например, «domain-example.com») * project-team-{{projectId}} * allUsers * allAuthenticatedUsers.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не уверены в его назначении. Он изменяет только строку User Agent для любых запросов API.
object string	Объект, к которому применяется ACL.
project string	Проект Google Cloud Platform, который необходимо использовать.
role string / обязательный	Разрешение на доступ для сущности. Допустимые варианты: «OWNER», «READER»
scopes list / elements=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла сервисной учётной записи — в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты сервисной учётной записи, используемый, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу сервисной учётной записи, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls
Официальная документация: https://cloud.google.com/storage/docs/access-control/create-manage-lists
Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a bucket
  google.cloud.gcp_storage_bucket:
    name: "{{ resource_name }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: bucket

- name: create a default object acl
  google.cloud.gcp_storage_default_object_acl:
    bucket: "{{ bucket }}"
    entity: OWNER:user-alexstephen@google.com
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
bucket dictionary	Имя сегмента. Возвращается: при успешном выполнении
domain string	Домен, связанный с сущностью. Возвращается: при успешном выполнении
email string	Адрес электронной почты, связанный с сущностью. Возвращается: при успешном выполнении
entity string	Сущность, которой предоставлено разрешение, в одном из следующих форматов: * user-{{userId}} * user-{{email}} (например, «user-liz@example.com») * group-{{groupId}} * group-{{email}} (например, «group-example@googlegroups.com») * domain-{{domain}} (например, «domain-example.com») * project-team-{{projectId}} * allUsers * allAuthenticatedUsers. Возвращается: при успешном выполнении
entityId string	Идентификатор сущности. Возвращается: при успешном выполнении
projectTeam complex	Команда проекта, связанная с сущностью. Возвращается: при успешном выполнении
projectNumber string	Команда проекта, связанная с сущностью. Возвращается: при успешном выполнении
team string	Команда. Возвращается: при успешном выполнении
role string	Разрешение на доступ для сущности. Возвращается: при успешном выполнении

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_storage_default_object_acl_module.html