更新连接到一个联合设置的一个组织配置。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forum/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
语法
atlas federatedAuthentication federationSettings connectedOrgConfigs update [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--federationSettingsId | 字符串 | true | 唯一的 24-十六进制数字string ,用于标识联合设置。 |
--file | 字符串 | true | 定义连接的组织配置的JSON配置文件的路径。注意: JSON文件中不支持的字段将被忽略。要学习;了解有关连接组织配置文件格式的详情,请参阅 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig 中的请求正文。 |
-h,--help | false | 更新帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
# Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json