#google-cloud #resource-manager #google #cli #resources #google-api #cloudresourcemanager

app google-cloudresourcemanager2-cli

一个用于与云资源管理器(协议v2)交互的完整库

10个稳定版本 (3个主要版本)

5.0.4+20240303 2024年3月5日
3.1.0+20220306 2022年4月26日
2.0.4+20210328 2021年4月15日
1.0.14+20200629 2020年7月10日
1.0.8+20181008 2018年10月14日

#cloudresourcemanager 中排名4

Download history 12/week @ 2024-03-10 87/week @ 2024-03-31 2/week @ 2024-04-07

每月下载量206

MIT许可协议

350KB
4.5K SLoC

cloudresourcemanager2 命令行界面(CLI)允许您在终端中舒适地使用Google Cloud Resource Manager服务的大多数功能。

默认情况下,所有输出都打印到标准输出,但可以使用标志将其重定向到文件,而不依赖于您的shell功能。错误将打印到标准错误,并将程序退出代码设置为非零。

如果请求数据结构,这些数据结构将以格式化的JSON返回,以便作为其他工具的输入使用。

有关Cloud Resource Manager API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudresourcemanager2-cli

github上找到源代码。

用法

本文档是根据云资源管理器API在修订版20240303中生成的。CLI版本为5.0.4

cloudresourcemanager2 [options]
        folders
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                search (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                undelete <name> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                get <name> [-p <v>]... [-o <out>]
  cloudresourcemanager2 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中,文件名以cloudresourcemanager2开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数API都需要用户对请求进行身份验证。如果是这种情况,作用域决定了授予的权限集。这些的粒度通常不超过只读完全访问

如果未设置,系统将自动选择最小的可行范围,例如在调用只读方法时,它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围均在相应方法的 CLI 文档中有说明。

首次使用范围时,用户会被要求授权。根据 CLI 的说明授予权限或拒绝。

如果用户已验证了范围,则相关信息将作为 JSON 存储在配置目录中,例如 ~/.google-service-cli/cloudresourcemanager2-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销授予的认证,请参阅官方文档

应用程序密钥

为了允许任何应用程序使用 Google 服务,它需要使用 Google 开发者控制台 进行注册。然后逐个启用应用程序可能使用的 API。大多数 API 可以免费使用,并且有每日配额。

为了在不强迫任何人为自己的应用程序注册的情况下更舒适地使用 CLI,CLI 配置了一个默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题: ~/.google-service-cli/cloudresourcemanager2-secret.json,假设已为它启用了所需的 cloudresourcemanager API。这样的密钥文件可以在 Google 开发者控制台APIs & auth -> Credentials -> Download JSON 下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息,请参阅官方文档

调试

尽管 CLI 尽最大努力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端服务器通信直接输出到标准错误来完成的。

--debug 标志将错误打印到标准错误,使用 Debug 表示形式。

您可以考虑将标准错误重定向到文件,以便于使用,例如 cloudresourcemanager2 --debug <resource> <method> [options] 2>debug.txt

依赖关系

~20–31MB
~585K SLoC