为指定的 Azure 私有端点创建新接口。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forum/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
要了解有关如何使用 Atlas CLI 设置私有端点的更多信息,请参阅 Atlas CLI 标签页上的教程:https: //www.mongodb.com/zh-cn/docs/atlas/security-cluster-private-endpoint/。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
atlas privateEndpoints azure interfaces create <endpointServiceId> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
endpointServiceId | 字符串 | true | 唯一的 24 字符字母数字字符串,用于标识 Atlas 中的私有端点。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-h,--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--privateEndpointId | 字符串 | true | 用于标识 Azure 中的 Azure 私有端点的唯一字符串。 Azure 仪表盘上私有端点的“属性”页面会在“资源 ID”字段中显示此属性。 |
--privateEndpointIpAddress | 字符串 | true | 在 Azure VNet 中创建的私有端点网络接口的私有 IP 地址。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Interface endpoint '<PrivateEndpointResourceId>' created.
示例
# Create a new interface for an Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint in Azure for the project with the ID 5e2211c17a3e5a48f5497de3: atlas privateEndpoints azure interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint --projectId 5e2211c17a3e5a48f5497de3 --privateEndpointIpAddress 192.0.2.5 --output json