Модуль community.general.scaleway_function_namespace_info – Получение информации о пространстве имён Scaleway Function

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в плейбуке, укажите: community.general.scaleway_function_namespace_info.

Добавлена в community.general 6.0.0

Обзор
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль возвращает информацию о пространстве имён функции на счете Scaleway.

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательный	Токен Scaleway OAuth.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name строка / обязательный	Имя пространства имён функции.
project_id строка / обязательный	Идентификатор проекта.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательный	Регион Scaleway для использования (например, `fr-par`). Доступные значения: `"fr-par"` `"nl-ams"` `"pl-waw"`
validate_certs булево	Проверять SSL-сертификаты Scaleway API. Доступные значения: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Возвратит подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании режима diff.

Примечания

Примечание

См. также документацию API по https://developer.scaleway.com/.
Если api_token не установлено в модуле, следующие переменные окружения могут быть использованы в порядке убывания приоритета SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Если нужно использовать другой api_url, можно также установить переменную окружения SCW_API_URL.

Примеры

- name: Get a function namespace info
  community.general.scaleway_function_namespace_info:
    project_id: '{{ scw_project }}'
    region: fr-par
    name: my-awesome-function-namespace
  register: function_namespace_info_task

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
function_namespace словарь	Информация о пространстве имён функции. Возвращается: всегда Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Ключ

Описание

function_namespace

словарь

Информация о пространстве имён функции.

Возвращается: всегда

Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Авторы

Guillaume MARTINEZ (@Lunik)

Ссылки на сборку

© 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/community/general/scaleway_function_namespace_info_module.html