Модуль google.cloud.gcp_resourcemanager_project — создание проекта GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Допустимые значения:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр влияет только на строку User Agent во всех запросах к API. |
id string / обязательный | Уникальный идентификатор проекта, назначаемый пользователем. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов и начинаться с буквы. Дефисы в конце запрещены. |
labels dictionary | Метки, связанные с этим проектом. Ключи меток должны содержать от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9]*[a-z0-9])?`. Значения меток должны содержать от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9]*[a-z0-9])?)?`. С одним ресурсом можно связать не более 256 меток. Клиентам следует хранить метки в таком формате, как JSON, который не зависит от запрета определенных символов. |
name string | Отображаемое имя проекта, назначаемое пользователем. Оно должно содержать от 4 до 30 символов. Разрешены строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и восклицательный знак. |
parent dictionary | Родительская организация. |
|
id string |
Идентификатор организации. |
|
type string |
Должно быть organization. |
project string | Проект Google Cloud Platform, который будет использоваться. |
scopes list / elements=string | Массив используемых областей доступа. |
service_account_contents jsonarg | Содержимое JSON-файла сервисного аккаунта: словарь или представляющая его JSON-строка. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбрано serviceaccount. |
state string | Должен ли указанный объект существовать в GCP. Допустимые значения:
|
Примеры
- 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 string | Время создания. Возвращается: при успешном выполнении |
id string | Уникальный идентификатор проекта, назначаемый пользователем. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов и начинаться с буквы. Дефисы в конце запрещены. Возвращается: при успешном выполнении |
labels dictionary | Метки, связанные с этим проектом. Ключи меток должны содержать от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9]*[a-z0-9])?`. Значения меток должны содержать от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9]*[a-z0-9])?)?`. С одним ресурсом можно связать не более 256 меток. Клиентам следует хранить метки в таком формате, как JSON, который не зависит от запрета определенных символов. Возвращается: при успешном выполнении |
lifecycleState string | Состояние жизненного цикла проекта. Возвращается: при успешном выполнении |
name string | Отображаемое имя проекта, назначаемое пользователем. Оно должно содержать от 4 до 30 символов. Разрешены строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и восклицательный знак. Возвращается: при успешном выполнении |
number integer | Уникальный номер, идентифицирующий проект. Возвращается: при успешном выполнении |
parent complex | Родительская организация. Возвращается: при успешном выполнении |
|
id string |
Идентификатор организации. Возвращается: при успешном выполнении |
|
type string |
Должно быть organization. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_resourcemanager_project_module.html