Private Endpoint Connections - Get

Servizio:

Search Management

Versione API:

2024-03-01-preview

Ottiene i dettagli della connessione dell'endpoint privato al servizio di ricerca nel gruppo di risorse specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
privateEndpointConnectionName	path	True	string	Nome della connessione dell'endpoint privato al servizio di ricerca di intelligenza artificiale di Azure con il gruppo di risorse specificato.
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione corrente. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
searchServiceName	path	True	string	Nome del servizio di ricerca di intelligenza artificiale di Azure associato al gruppo di risorse specificato. Criterio di espressione regolare: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
api-version	query	True	string	Versione dell'API da usare per ogni richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	Valore GUID generato dal client che identifica la richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	La definizione della connessione all'endpoint privato è stata recuperata correttamente e si trova nella risposta.
Other Status Codes	CloudError	HTTP 404 (Non trovato): non è stato possibile trovare la sottoscrizione, il gruppo di risorse, il servizio di ricerca o la connessione all'endpoint privato.

Sicurezza

azure_auth

Specifica un flusso di concessione implicita, come supportato in Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

PrivateEndpointConnectionGet

Esempio di richiesta

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

dotnet

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/GetPrivateEndpointConnection.json
// this example is just showing the usage of "PrivateEndpointConnections_Get" 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
string privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
NullableResponse<SearchPrivateEndpointConnectionResource> response = await collection.GetIfExistsAsync(privateEndpointConnectionName);
SearchPrivateEndpointConnectionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
PrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
PrivateEndpointConnection	Descrive una connessione dell'endpoint privato esistente al servizio di ricerca di intelligenza artificiale di Azure.
PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca.
PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.
PrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
PrivateLinkServiceConnectionStatus	Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

CloudError

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
message	string	Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/di debug fare riferimento alla proprietà "error.message").

CloudErrorBody

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

PrivateEndpoint

Risorsa endpoint privato dal provider Microsoft.Network.

Nome	Tipo	Descrizione
id	string	ID risorsa della risorsa endpoint privato del provider Microsoft.Network.

PrivateEndpointConnection

Descrive una connessione dell'endpoint privato esistente al servizio di ricerca di intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties	PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca di intelligenza artificiale di Azure.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca.

Nome	Tipo	Descrizione
groupId	string	ID gruppo della risorsa di Azure per cui è destinato il servizio di collegamento privato.
privateEndpoint	PrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.

PrivateLinkServiceConnectionProvisioningState

Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.

Nome	Tipo	Descrizione
Canceled	string	La richiesta di provisioning per la risorsa di connessione al servizio di collegamento privato è stata annullata.
Deleting	string	La connessione al servizio di collegamento privato è in corso di eliminazione.
Failed	string	Impossibile eseguire il provisioning o l'eliminazione della connessione al servizio collegamento privato.
Incomplete	string	La richiesta di provisioning per la risorsa di connessione al servizio collegamento privato è stata accettata, ma il processo di creazione non è ancora iniziato.
Succeeded	string	Il provisioning della connessione al servizio collegamento privato è stato completato ed è pronto per l'approvazione.
Updating	string	La connessione al servizio di collegamento privato è in corso di creazione insieme ad altre risorse affinché sia completamente funzionante.

PrivateLinkServiceConnectionState

Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.

Nome	Tipo	Valore predefinito	Descrizione
actionsRequired	string	None	Descrizione di eventuali azioni aggiuntive che possono essere necessarie.
description	string		Descrizione dello stato di connessione del servizio di collegamento privato.
status	PrivateLinkServiceConnectionStatus		Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

PrivateLinkServiceConnectionStatus

Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

Nome	Tipo	Descrizione
Approved	string	La connessione all'endpoint privato è approvata ed è pronta per l'uso.
Disconnected	string	La connessione all'endpoint privato è stata rimossa dal servizio.
Pending	string	La connessione all'endpoint privato è stata creata ed è in attesa di approvazione.
Rejected	string	La connessione all'endpoint privato è stata rifiutata e non può essere usata.