google.cloud.gcp_resourcemanager_project модуль — Создаёт GCP проект

Примечание

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

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

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

Для использования в книге задач укажите: google.cloud.gcp_resourcemanager_project.

Обзор
Требования
Параметры
Примеры
Значения возврата

Обзор

Представляет GCP проект. Проект — это контейнер для ACL, API, приложений App Engine, виртуальных машин и других ресурсов Google Cloud Platform.

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип credentials — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Это не должно быть установлено, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
id строка / обязательно	Уникальный идентификатор проекта, заданный пользователем. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов. Он должен начинаться с буквы. Конечные дефисы запрещены.
labels словарь	Теги, связанные с этим проектом. Ключи тегов должны иметь длину от 1 до 63 символов и должны соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9][a-z0-9])?`. Значения тегов должны иметь длину от 0 до 63 символов и должны соответствовать регулярному выражению `([a-z]([-a-z0-9][a-z0-9])?)?`. С данным ресурсом может быть связано не более 256 тегов. Клиенты должны хранить теги в представлении, например, JSON, которое не зависит от запрещенных символов.
name строка	Назначение имени проекта, заданное пользователем. Оно должно иметь длину от 4 до 30 символов. Разрешенные символы: строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и знак восклицания.
parent словарь	Родительская организация.
id строка	Идентификатор организации.
type строка	Должно быть organization.
project строка	Проект Google Cloud Platform, который нужно использовать.
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержимое JSON-файла учетной записи сервиса, либо в виде словаря, либо в виде JSON-строки, которая его представляет.
service_account_email строка	Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON-учетной записи сервиса, если serviceaccount выбран в качестве типа.
state строка	Определяет, должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примеры

- name: create a project
  google.cloud.gcp_resourcemanager_project:
    name: My Sample Project
    id: ansible-test-{{ 10000000000 | random }}
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    parent:
      type: organization
      id: 636173955921
    state: present

Значения возврата

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

Ключ	Описание
createTime строка	Время создания. Возвращаемое значение: успех
id строка	Уникальный, назначенный пользователем идентификатор проекта. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов. Он должен начинаться с буквы. Запрещены дефисы в конце. Возвращаемое значение: успех
labels словарь	Метки, связанные с этим проектом. Ключи меток должны иметь длину от 1 до 63 символов и должны соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9][a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и должны соответствовать регулярному выражению `([a-z]([-a-z0-9][a-z0-9])?)?`. Не более 256 меток могут быть связаны с данным ресурсом. Клиенты должны хранить метки в представлении, таком как JSON, которое не зависит от запрещенных символов. Возвращаемое значение: успех
lifecycleState строка	Состояние жизненного цикла проекта. Возвращаемое значение: успех
name строка	Назначенное пользователем отображаемое имя проекта. Оно должно иметь длину от 4 до 30 символов. Разрешенные символы: строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и восклицательный знак. Возвращаемое значение: успех
number целое число	Число, уникально определяющее проект. Возвращаемое значение: успех
parent сложное	Родительская организация. Возвращаемое значение: успех
id строка	Идентификатор организации. Возвращаемое значение: успех
type строка	Должно быть organization. Возвращаемое значение: успех

Авторы

Google Inc. (@googlecloudplatform)

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

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