Private Endpoint Connections - List By Service

Hizmet:: Search Management

API Sürümü:: 2025-05-01

Verilen hizmetteki tüm özel uç nokta bağlantılarının listesini alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Belirtilen kaynak grubuyla ilişkili Azure AI Search hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string (uuid)	Bu isteği tanımlayan istemci tarafından oluşturulan BIR GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.

Yanıtlar

Name	Tür	Description
200 OK	PrivateEndpointConnectionListResult	İstek başarılı oldu.
Other Status Codes	CloudError	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ListPrivateEndpointConnectionsByService

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByServicePager("rg1", "mysearchservice", 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 = armsearch.PrivateEndpointConnectionsClientListByServiceResponse{
		// 	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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 				Properties: &armsearch.PrivateEndpointConnectionProperties{
		// 					PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/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

Örnek yanıt

Durum kodu:: 200

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

Tanımlar

Name	Description
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
createdByType	Kaynağı oluşturan kimliğin türü.
PrivateEndpointConnection	Azure AI Search hizmetine yönelik mevcut bir özel uç nokta bağlantısını açıklar.
PrivateEndpointConnectionListResult	Özel uç nokta bağlantılarının listesini içeren yanıt.
PrivateEndpointConnectionProperties	Arama hizmetine var olan özel uç nokta bağlantısının özelliklerini açıklar.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Özel uç noktaya var olan bir Azure Özel Bağlantı hizmeti bağlantısının geçerli durumunu açıklar.
PrivateLinkServiceConnectionProvisioningState	Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı, Tamamlanmamış veya İptal Edildi değerleridir.
PrivateLinkServiceConnectionStatus	Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CloudError

Nesne

API hatası hakkında bilgi içerir.

Name	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
message	string	Neyin yanlış gittiğini gösteren hatanın kısa bir açıklaması (ayrıntılar/hata ayıklama bilgileri için 'error.message' özelliğine bakın).

CloudErrorBody

Nesne

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Name	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe yerleştirilmiş hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

PrivateEndpointConnection

Nesne

Azure AI Search hizmetine yönelik mevcut bir özel uç nokta bağlantısını açıklar.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties	PrivateEndpointConnectionProperties	Azure AI Search hizmetine var olan özel uç nokta bağlantısının özelliklerini açıklar.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Nesne

Özel uç nokta bağlantılarının listesini içeren yanıt.

Name	Tür	Description
nextLink	string	Özel uç nokta bağlantılarının sonraki sayfasını sorgulamak için kullanılabilecek istek URL'si. İstenen özel uç nokta bağlantılarının toplam sayısı sayfa boyutu üst sınırını aştığında döndürülür.
value	PrivateEndpointConnection[]	Özel uç nokta bağlantılarının listesi.

PrivateEndpointConnectionProperties

Nesne

Arama hizmetine var olan özel uç nokta bağlantısının özelliklerini açıklar.

Name	Tür	Description
groupId	string	Özel bağlantı hizmetinin ait olduğu Azure kaynağının grup kimliği.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Özel uç noktaya var olan bir Azure Özel Bağlantı hizmeti bağlantısının geçerli durumunu açıklar.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı, Tamamlanmamış veya İptal Edildi değerleridir.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Nesne

Microsoft.Network sağlayıcısından özel uç nokta kaynağı.

Name	Tür	Description
id	string	Microsoft.Network sağlayıcısından gelen özel uç nokta kaynağının kaynak kimliği.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Nesne

Özel uç noktaya var olan bir Azure Özel Bağlantı hizmeti bağlantısının geçerli durumunu açıklar.

Name	Tür	Default value	Description
actionsRequired	string	None	Gerekli olabilecek ek eylemlerin açıklaması.
description	string		Özel bağlantı hizmeti bağlantı durumunun açıklaması.
status	PrivateLinkServiceConnectionStatus		Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.

PrivateLinkServiceConnectionProvisioningState

Numaralandırma

Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı, Tamamlanmamış veya İptal Edildi değerleridir.

Değer	Description
Updating	Özel bağlantı hizmeti bağlantısı, tamamen işlevsel olması için diğer kaynaklarla birlikte oluşturulma sürecindedir.
Deleting	Özel bağlantı hizmeti bağlantısı siliniyor.
Failed	Özel bağlantı hizmeti bağlantısı sağlanamadı veya silinemedi.
Succeeded	Özel bağlantı hizmeti bağlantısı sağlamayı tamamladı ve onay için hazır.
Incomplete	Özel bağlantı hizmeti bağlantı kaynağı için sağlama isteği kabul edildi, ancak oluşturma işlemi henüz başlamadı.
Canceled	Özel bağlantı hizmeti bağlantı kaynağı için sağlama isteği iptal edildi.

PrivateLinkServiceConnectionStatus

Numaralandırma

Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.

Değer	Description
Pending	Özel uç nokta bağlantısı oluşturuldu ve onay bekliyor.
Approved	Özel uç nokta bağlantısı onaylandı ve kullanıma hazır.
Rejected	Özel uç nokta bağlantısı reddedildi ve kullanılamaz.
Disconnected	Özel uç nokta bağlantısı hizmetten kaldırıldı.

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.