你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

App Service Environments - Get Private Endpoint Connection List

Service:

App Service

API Version:

2022-03-01

获取与托管环境关联的专用终结点列表的说明

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections?api-version=2022-03-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用服务环境的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	PrivateEndpointConnectionCollection	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Gets the list of private endpoints associated with a hosting environment.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections?api-version=2022-03-01

Java

import com.azure.core.util.Context;

/** Samples for AppServiceEnvironments GetPrivateEndpointConnectionList. */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json
     */
    /**
     * Sample code: Gets the list of private endpoints associated with a hosting environment.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsTheListOfPrivateEndpointsAssociatedWithAHostingEnvironment(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .webApps()
            .manager()
            .serviceClient()
            .getAppServiceEnvironments()
            .getPrivateEndpointConnectionList("test-rg", "test-ase", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json
func ExampleEnvironmentsClient_NewGetPrivateEndpointConnectionListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armappservice.NewEnvironmentsClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewGetPrivateEndpointConnectionListPager("test-rg",
		"test-ase",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Gets the list of private endpoints associated with a hosting environment
 *
 * @summary Description for Gets the list of private endpoints associated with a hosting environment
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json
 */
async function getsTheListOfPrivateEndpointsAssociatedWithAHostingEnvironment() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "test-rg";
  const name = "test-ase";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.appServiceEnvironments.listPrivateEndpointConnectionList(
    resourceGroupName,
    name
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

getsTheListOfPrivateEndpointsAssociatedWithAHostingEnvironment().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "fa38656c-034e-43d8-adce-fe06ce039c98",
      "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections",
      "properties": {
        "provisioningState": "Pending",
        "privateEndpoint": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Disconnecting",
          "description": "Please approve my connection, thanks!",
          "actionsRequired": "None"
        },
        "ipAddresses": []
      }
    }
  ]
}

定义

名称	说明
ArmIdWrapper	ARM 资源 ID 的包装器
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
PrivateEndpointConnectionCollection
PrivateLinkConnectionState	专用链接连接的状态
RemotePrivateEndpointConnectionARMResource	远程专用终结点连接 ARM 资源。

ArmIdWrapper

ARM 资源 ID 的包装器

名称	类型	说明
id	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

PrivateEndpointConnectionCollection

名称	类型	说明
nextLink	string	指向下一页资源的链接。
value	RemotePrivateEndpointConnectionARMResource[]	资源的集合。

PrivateLinkConnectionState

专用链接连接的状态

名称	类型	说明
actionsRequired	string	Actions要求专用链接连接
description	string	专用链接连接的说明
status	string	专用链接连接的状态

RemotePrivateEndpointConnectionARMResource

远程专用终结点连接 ARM 资源。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.ipAddresses	string[]	映射到远程专用终结点的专用 IPAddresses
properties.privateEndpoint	ArmIdWrapper	远程专用终结点连接的 PrivateEndpoint
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	专用链接连接的状态
properties.provisioningState	string
type	string	资源类型。