Private Endpoint Connections - Get

Hizmet:

Search Management

API Sürümü:

2024-03-01-preview

Verilen kaynak grubundaki arama hizmetine yönelik özel uç nokta bağlantısının ayrıntılarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
privateEndpointConnectionName	path	True	string	Belirtilen kaynak grubuyla Azure AI Arama hizmeti özel uç nokta bağlantısının adı.
resourceGroupName	path	True	string	Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
searchServiceName	path	True	string	Belirtilen kaynak grubuyla ilişkili Azure AI Arama hizmeti adı. Normal ifade deseni: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
subscriptionId	path	True	string	Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
api-version	query	True	string	Her istek 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 GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.

Yanıtlar

Name	Tür	Description
200 OK	PrivateEndpointConnection	Özel uç nokta bağlantısının tanımı başarıyla alındı ve yanıtta.
Other Status Codes	CloudError	HTTP 404 (Bulunamadı): Abonelik, kaynak grubu, arama hizmeti veya özel uç nokta bağlantısı bulunamadı.

Güvenlik

azure_auth

Microsoft Identity platformunda desteklendiği gibi örtük bir verme akışı belirtir.

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

PrivateEndpointConnectionGet

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2024-03-01-preview

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python get_private_endpoint_connection.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.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        private_endpoint_connection_name="testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/GetPrivateEndpointConnection.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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/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("<subscription-id>", 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", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.PrivateEndpointConnection = 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 the details of the private endpoint connection to the search service in the given resource group.
 *
 * @summary Gets the details of the private endpoint connection to the search service in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/GetPrivateEndpointConnection.json
 */
async function privateEndpointConnectionGet() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.get(
    resourceGroupName,
    searchServiceName,
    privateEndpointConnectionName,
  );
  console.log(result);
}

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

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

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.
PrivateEndpoint	Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
PrivateEndpointConnection	Azure AI Arama hizmeti mevcut özel uç nokta bağlantısını açıklar.
PrivateEndpointConnectionProperties	Arama hizmetine var olan bir özel uç nokta bağlantısının özelliklerini 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ı, Tamamlanmadı veya İptal Edildi değerleridir.
PrivateLinkServiceConnectionState	Özel uç noktaya var olan bir Azure Özel Bağlantı hizmeti bağlantısının geçerli durumunu açıklar.
PrivateLinkServiceConnectionStatus	Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.

CloudError

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

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 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ı).

PrivateEndpoint

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.

PrivateEndpointConnection

Azure AI Arama hizmeti mevcut özel uç nokta bağlantısını açıklar.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties	PrivateEndpointConnectionProperties	Azure AI Arama hizmeti mevcut özel uç nokta bağlantısının özelliklerini açıklar.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Arama hizmetine var olan bir ö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	PrivateEndpoint	Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Ö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ı, Tamamlanmadı veya İptal Edildi değerleridir.

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ı, Tamamlanmadı veya İptal Edildi değerleridir.

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

PrivateLinkServiceConnectionState

Ö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.

PrivateLinkServiceConnectionStatus

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

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