该 assuredworkloads1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Assuredworkloads 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而不受您外壳功能的限制。错误将打印到标准错误，并导致程序的退出代码不为零。

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

有关 Assuredworkloads API 的其他所有信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-assuredworkloads1-cli

在 GitHub 上查找源代码。

用法

此文档是从修订版 20240222 的 Assuredworkloads API 生成的。CLI 的版本为 5.0.4。

assuredworkloads1 [options]
        organizations
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-workloads-analyze-workload-move <target> [-p <v>]... [-o <out>]
                locations-workloads-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workloads-delete <name> [-p <v>]... [-o <out>]
                locations-workloads-enable-resource-monitoring <name> [-p <v>]... [-o <out>]
                locations-workloads-get <name> [-p <v>]... [-o <out>]
                locations-workloads-list <parent> [-p <v>]... [-o <out>]
                locations-workloads-mutate-partner-permissions <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workloads-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workloads-restrict-allowed-resources <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workloads-violations-acknowledge <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workloads-violations-get <name> [-p <v>]... [-o <out>]
                locations-workloads-violations-list <parent> [-p <v>]... [-o <out>]
  assuredworkloads1 --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 文件中，文件名以 assuredworkloads1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息，请参阅以下段落。

身份验证

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

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

首次使用作用域时，系统会要求用户授权。根据 CLI 的说明授予权限或拒绝。

如果用户验证了作用域，相关信息将被存储在配置目录中，格式为JSON，例如：~/.google-service-cli/assuredworkloads1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

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

为了使CLI更易于使用，而无需强迫任何人注册自己的应用程序，CLI自带了一个默认应用程序密钥，相应地进行了配置。这也意味着全球范围内的重度使用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/assuredworkloads1-secret.json，前提是已为它启用了所需的assuredworkloads API。此类密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON处下载，并直接使用。

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

调试

尽管CLI尽最大努力提供可用的错误消息，但有时可能需要知道导致特定问题的确切原因。这是通过允许所有客户端服务器通信以标准错误输出。

--debug标志将以Debug表示的形式将错误打印到标准错误。

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