atlas privateEndpoints azure 接口描述
返回为项目指定的 Azure 私有端点接口的详细信息。
要使用此命令，您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas privateEndpoints azure interfaces describe <privateEndpointResourceId> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
privateEndpointResourceId | 字符串 | true | 用于标识 Azure 中的 Azure 私有端点接口的唯一字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--endpointServiceId | 字符串 | true | 唯一的 24 字符字母数字字符串，用于标识 Atlas 中的私有端点。 |
-h，--help | false | 描述帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
ID IP ADDRESS STATUS ERROR <PrivateEndpointResourceId> <PrivateEndpointIPAddress> <Status> <ErrorMessage>
示例
# Return the JSON-formatted details of the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: atlas privateEndpoints azure interfaces describe /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --endpointServiceId 5f4fc14da2b47835a58c63a2