该 policysimulator1 命令行界面 (CLI) 允许您在终端中方便地使用 Google 策略模拟器服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接导向文件，而不管您的 shell 功能如何。错误将打印到标准错误，并导致程序退出代码非零。

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

有关策略模拟器 API 的其他信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-policysimulator1-cli

在 GitHub 上查找源代码。

用法

本文档是根据修订版本 20240303 的 策略模拟器 API 生成的。CLI 版本为 5.0.4。

policysimulator1 [options]
        folders
                locations-org-policy-violations-previews-operations-get <name> [-p <v>]... [-o <out>]
                locations-replays-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-replays-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-list <name> [-p <v>]... [-o <out>]
                locations-replays-results-list <parent> [-p <v>]... [-o <out>]
        operations
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
        organizations
                locations-org-policy-violations-previews-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-org-policy-violations-previews-get <name> [-p <v>]... [-o <out>]
                locations-org-policy-violations-previews-list <parent> [-p <v>]... [-o <out>]
                locations-org-policy-violations-previews-operations-get <name> [-p <v>]... [-o <out>]
                locations-org-policy-violations-previews-org-policy-violations-list <parent> [-p <v>]... [-o <out>]
                locations-replays-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-replays-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-list <name> [-p <v>]... [-o <out>]
                locations-replays-results-list <parent> [-p <v>]... [-o <out>]
        projects
                locations-org-policy-violations-previews-operations-get <name> [-p <v>]... [-o <out>]
                locations-replays-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-replays-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-get <name> [-p <v>]... [-o <out>]
                locations-replays-operations-list <name> [-p <v>]... [-o <out>]
                locations-replays-results-list <parent> [-p <v>]... [-o <out>]
  policysimulator1 --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 文件中，文件名以 policysimulator1- 前缀开始。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。遵循 CLI 提供的说明来授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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