Private Endpoint Connections - List By Service

서비스:

Search Management

API 버전:

2023-11-01

지정된 서비스의 모든 프라이빗 엔드포인트 연결 목록을 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?api-version=2023-11-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	현재 구독 내의 리소스 그룹의 이름입니다. Azure Resource Manager API 또는 포털에서 이 값을 가져올 수 있습니다.
searchServiceName	path	True	string	지정된 리소스 그룹과 연결된 검색 서비스의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독의 고유 식별자입니다. Azure Resource Manager API, 명령줄 도구 또는 포털에서 이 값을 가져올 수 있습니다.
api-version	query	True	string	각 요청에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string (uuid)	이 요청을 식별하는 클라이언트에서 생성된 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다.

응답

Name	형식	Description
200 OK	PrivateEndpointConnectionListResult	작업이 성공했습니다. 응답에는 지정된 서비스에 대한 모든 프라이빗 엔드포인트 연결 목록이 포함됩니다.
Other Status Codes	CloudError	작업 중에 예기치 않은 오류가 발생했습니다.

보안

azure_auth

Microsoft Entra ID OAuth2 권한 부여 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ListPrivateEndpointConnectionsByService

샘플 요청

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01

Java

/**
 * Samples for PrivateEndpointConnections ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * ListPrivateEndpointConnectionsByService.json
     */
    /**
     * Sample code: ListPrivateEndpointConnectionsByService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPrivateEndpointConnectionsByService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateEndpointConnections().listByService("rg1",
            "mysearchservice", null, com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python list_private_endpoint_connections_by_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_endpoint_connections.list_by_service(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
if __name__ == "__main__":
    main()

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 armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
func ExamplePrivateEndpointConnectionsClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByServicePager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateEndpointConnectionListResult = armsearch.PrivateEndpointConnectionListResult{
		// 	Value: []*armsearch.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 			Properties: &armsearch.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
		// 					Description: to.Ptr(""),
		// 					ActionsRequired: to.Ptr("None"),
		// 					Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusApproved),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of all private endpoint connections in the given service.
 *
 * @summary Gets a list of all private endpoint connections in the given service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
 */
async function listPrivateEndpointConnectionsByService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateEndpointConnections.listByService(
    resourceGroupName,
    searchServiceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
// this example is just showing the usage of "PrivateEndpointConnections_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// get the collection of this SearchPrivateEndpointConnectionResource
SearchPrivateEndpointConnectionCollection collection = searchService.GetSearchPrivateEndpointConnections();

// invoke the operation and iterate over the result
await foreach (SearchPrivateEndpointConnectionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SearchPrivateEndpointConnectionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "type": "Microsoft.Search/searchServices/privateEndpointConnections",
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

정의

Name	Description
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
PrivateEndpoint	Microsoft.Network 공급자의 프라이빗 엔드포인트 리소스입니다.
PrivateEndpointConnection	검색 서비스에 대한 기존 프라이빗 엔드포인트 연결을 설명합니다.
PrivateEndpointConnectionListResult	프라이빗 엔드포인트 연결 목록을 포함하는 응답입니다.
PrivateEndpointConnectionProperties	검색 서비스에 대한 기존 프라이빗 엔드포인트 연결의 속성을 설명합니다.
PrivateLinkServiceConnectionProvisioningState	프라이빗 링크 서비스 연결의 프로비전 상태입니다. 유효한 값이 업데이트, 삭제, 실패, 성공 또는 불완전함
PrivateLinkServiceConnectionState	Azure 프라이빗 엔드포인트에 대한 기존 Private Link 서비스 연결의 현재 상태를 설명합니다.
PrivateLinkServiceConnectionStatus	프라이빗 링크 서비스 연결의 상태입니다. 유효한 값은 보류 중, 승인됨, 거부됨 또는 연결 끊김입니다.

CloudError

Object

API 오류에 대한 정보를 포함합니다.

Name	형식	Description
error	CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.

CloudErrorBody

Object

오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

PrivateEndpoint

Object

Microsoft.Network 공급자의 프라이빗 엔드포인트 리소스입니다.

Name	형식	Description
id	string	Microsoft.Network 공급자의 프라이빗 엔드포인트 리소스의 리소스 ID입니다.

PrivateEndpointConnection

Object

검색 서비스에 대한 기존 프라이빗 엔드포인트 연결을 설명합니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties	PrivateEndpointConnectionProperties	검색 서비스에 대한 기존 프라이빗 엔드포인트 연결의 속성을 설명합니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Object

프라이빗 엔드포인트 연결 목록을 포함하는 응답입니다.

Name	형식	Description
nextLink	string	프라이빗 엔드포인트 연결의 다음 페이지를 쿼리하는 데 사용할 수 있는 요청 URL입니다. 요청된 프라이빗 엔드포인트 연결의 총 수가 최대 페이지 크기를 초과하는 경우 반환됩니다.
value	PrivateEndpointConnection[]	프라이빗 엔드포인트 연결 목록입니다.

PrivateEndpointConnectionProperties

Object

검색 서비스에 대한 기존 프라이빗 엔드포인트 연결의 속성을 설명합니다.

Name	형식	Description
groupId	string	프라이빗 링크 서비스 연결에 사용할 리소스 공급자의 그룹 ID입니다.
privateEndpoint	PrivateEndpoint	Microsoft.Network 공급자의 프라이빗 엔드포인트 리소스입니다.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Azure 프라이빗 엔드포인트에 대한 기존 Private Link 서비스 연결의 현재 상태를 설명합니다.
provisioningState	PrivateLinkServiceConnectionProvisioningState	프라이빗 링크 서비스 연결의 프로비전 상태입니다. 유효한 값이 업데이트, 삭제, 실패, 성공 또는 불완전함

PrivateLinkServiceConnectionProvisioningState

열거형

프라이빗 링크 서비스 연결의 프로비전 상태입니다. 유효한 값이 업데이트, 삭제, 실패, 성공 또는 불완전함

값	Description
Canceled	프라이빗 링크 서비스 연결 리소스에 대한 프로비저닝 요청이 취소되었습니다.
Deleting	프라이빗 링크 서비스 연결이 삭제되는 중입니다.
Failed	프라이빗 링크 서비스 연결을 프로비전하거나 삭제하지 못했습니다.
Incomplete	프라이빗 링크 서비스 연결 리소스에 대한 프로비저닝 요청이 수락되었지만 생성 프로세스가 아직 시작되지 않았습니다.
Succeeded	프라이빗 링크 서비스 연결이 프로비저닝을 완료했으며 승인할 준비가 되었습니다.
Updating	프라이빗 링크 서비스 연결은 완전히 작동하기 위해 다른 리소스와 함께 생성되는 중입니다.

PrivateLinkServiceConnectionState

Object

Azure 프라이빗 엔드포인트에 대한 기존 Private Link 서비스 연결의 현재 상태를 설명합니다.

Name	형식	Default value	Description
actionsRequired	string	None	필요할 수 있는 추가 작업에 대한 설명입니다.
description	string		프라이빗 링크 서비스 연결 상태에 대한 설명입니다.
status	PrivateLinkServiceConnectionStatus		프라이빗 링크 서비스 연결의 상태입니다. 유효한 값은 보류 중, 승인됨, 거부됨 또는 연결 끊김입니다.

PrivateLinkServiceConnectionStatus

열거형

프라이빗 링크 서비스 연결의 상태입니다. 유효한 값은 보류 중, 승인됨, 거부됨 또는 연결 끊김입니다.

값	Description
Approved	프라이빗 엔드포인트 연결이 승인되었으며 사용할 준비가 된 것입니다.
Disconnected	프라이빗 엔드포인트 연결이 서비스에서 제거되었습니다.
Pending	프라이빗 엔드포인트 연결이 만들어졌으며 승인을 보류 중입니다.
Rejected	프라이빗 엔드포인트 연결이 거부되었으며 사용할 수 없습니다.