Модуль google.cloud.gcp_vertexai_metadata_store — создание ресурса GCP VertexAI.MetadataStore
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать этот модуль в плейбуке, укажите: google.cloud.gcp_vertexai_metadata_store.
Краткое описание
- Экземпляр хранилища метаданных. Содержит набор метаданных, доступных для запросов.
Требования
Следующие требования необходимы на хосте, где выполняется этот модуль.
- python >= 3.8
- requests >= 2.18.4
- google-auth >= 2.25.1
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа, используемый для аутентификации. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
description string | Описание MetadataStore. |
encryption_spec dictionary | Спецификация ключа шифрования, управляемого клиентом, для MetadataStore. Если задано, этот MetadataStore и все его подресурсы будут защищены этим ключом. |
|
kms_key_name string |
Идентификатор ресурса Cloud KMS ключа шифрования, управляемого клиентом и используемого для защиты ресурса. Формат: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. Ключ должен находиться в том же регионе, где создается ресурс. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API. |
name string | Имя MetadataStore. Значение может содержать до 60 символов; допустимые символы: [a-z0-9_]. Первый символ не может быть цифрой. |
project string | Проект Google Cloud Platform, который следует использовать. |
region string | Регион MetadataStore. Например, us-central1. |
scopes list / элементы=string | Массив используемых областей доступа. |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрана serviceaccount. |
state string | Должен ли ресурс существовать в GCP. Варианты:
|
Примечания
Примечание
- Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.metadataStores
- Руководство по официальной документации: https://cloud.google.com/vertex-ai/docs
- Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать 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. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения в плейбуке не заданы.
- Параметры
service_account_email,service_account_file,service_account_fileиaccess_tokenявляются взаимоисключающими.
Примеры
- name: Create Metadata Store
google.cloud.gcp_vertexai_metadata_store:
state: present
name: "{{ resource_name }}"
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
register: _mymds
- name: Delete Metadata Store
google.cloud.gcp_vertexai_metadata_store:
state: absent
name: "{{ resource_name }}"
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Был ли изменен ресурс. Возвращается: всегда |
createTime string | Метка времени создания MetadataStore в формате RFC3339 UTC «Zulu», с точностью до наносекунд и максимум девятью десятичными знаками. Возвращается: при успешном выполнении |
state dictionary | Сведения о состоянии MetadataStore. Возвращается: при успешном выполнении |
|
diskUtilizationBytes string |
Объем дискового пространства, используемого MetadataStore, в байтах. Возвращается: при успешном выполнении |
updateTime string | Метка времени последнего обновления MetadataStore в формате RFC3339 UTC «Zulu», с точностью до наносекунд и максимум девятью десятичными знаками. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_vertexai_metadata_store_module.html