Private Endpoint Connections - Get

Layanan:: Search Management

Versi API:: 2025-05-01

Mendapatkan detail koneksi titik akhir privat ke layanan pencarian di grup sumber daya yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
privateEndpointConnectionName	path	True	string	Nama koneksi titik akhir privat ke layanan Pencarian Azure AI dengan grup sumber daya yang ditentukan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nama layanan Azure AI Search yang terkait dengan grup sumber daya yang ditentukan.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateEndpointConnection	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

PrivateEndpointConnectionGet

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?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/GetPrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_Get() {
	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)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "rg1", "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.PrivateEndpointConnectionsClientGetResponse{
	// 	PrivateEndpointConnection: &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

Respon sampel

Kode status:: 200

{
  "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"
    }
  }
}

Definisi

Nama	Deskripsi
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
createdByType	Jenis identitas yang membuat sumber daya.
PrivateEndpointConnection	Menjelaskan koneksi titik akhir privat yang ada ke layanan Azure AI Search.
PrivateEndpointConnectionProperties	Menjelaskan properti koneksi titik akhir privat yang ada ke layanan pencarian.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Sumber daya titik akhir privat dari penyedia Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Menjelaskan status koneksi layanan Azure Private Link yang ada saat ini ke titik akhir privat.
PrivateLinkServiceConnectionProvisioningState	Status provisi koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau Dibatalkan.
PrivateLinkServiceConnectionStatus	Status koneksi layanan tautan privat. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

Objek

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
message	string	Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk informasi detail/penelusuran kesalahan merujuk ke properti 'error.message').

CloudErrorBody

Objek

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	Berisi kesalahan berlapis yang terkait dengan kesalahan ini.
message	string	Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.
target	string	Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key