Private Endpoint Connections - Update

Servizio:

Search Management

Versione API:

2023-11-01

Aggiornamenti una connessione endpoint privato al servizio di ricerca nel gruppo di risorse specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
privateEndpointConnectionName	path	True	string	Nome della connessione dell'endpoint privato al servizio di ricerca 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 associato al gruppo di risorse specificato.
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API Resource Manager di Azure, dagli strumenti da riga di comando 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.

Corpo della richiesta

Nome	Tipo	Descrizione
properties	PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	La definizione di connessione dell'endpoint privato esistente è stata aggiornata correttamente.
Other Status Codes	CloudError	HTTP 400 (richiesta non valida): il nome di connessione dell'endpoint privato specificato o la definizione di connessione dell'endpoint privato non è valido; Per informazioni dettagliate, vedere il codice di errore e il messaggio nella risposta. HTTP 404 (Non trovato): non è stato possibile trovare la sottoscrizione, il gruppo di risorse, il servizio di ricerca o la connessione all'endpoint privato. HTTP 409 (Conflitto): la sottoscrizione specificata è disabilitata.

Sicurezza

azure_auth

Microsoft Entra ID flusso di autorizzazione OAuth2.

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

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

PrivateEndpointConnectionUpdate

Esempio di richiesta

HTTP

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

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason"
    }
  }
}

Java

import com.azure.resourcemanager.search.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.search.models.PrivateEndpointConnectionProperties;
import com.azure.resourcemanager.search.models.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
import com.azure.resourcemanager.search.models.PrivateLinkServiceConnectionStatus;

/**
 * Samples for PrivateEndpointConnections Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection
     * .json
     */
    /**
     * Sample code: PrivateEndpointConnectionUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void privateEndpointConnectionUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateEndpointConnections().updateWithResponse("rg1",
            "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
            new PrivateEndpointConnectionInner()
                .withProperties(new PrivateEndpointConnectionProperties().withPrivateLinkServiceConnectionState(
                    new PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState()
                        .withStatus(PrivateLinkServiceConnectionStatus.REJECTED)
                        .withDescription("Rejected for some reason"))),
            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 update_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.update(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        private_endpoint_connection_name="testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
        private_endpoint_connection={
            "properties": {
                "privateLinkServiceConnectionState": {"description": "Rejected for some reason", "status": "Rejected"}
            }
        },
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.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/azcore/to"
	"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/UpdatePrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_Update() {
	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().Update(ctx, "rg1", "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", armsearch.PrivateEndpointConnection{
		Properties: &armsearch.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
				Description: to.Ptr("Rejected for some reason"),
				Status:      to.Ptr(armsearch.PrivateLinkServiceConnectionStatusRejected),
			},
		},
	}, &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("Rejected for some reason"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusRejected),
	// 		},
	// 	},
	// }
}

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 Updates a Private Endpoint connection to the search service in the given resource group.
 *
 * @summary Updates a Private Endpoint connection to the search service in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.json
 */
async function privateEndpointConnectionUpdate() {
  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 privateEndpointConnection = {
    properties: {
      privateLinkServiceConnectionState: {
        description: "Rejected for some reason",
        status: "Rejected",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.update(
    resourceGroupName,
    searchServiceName,
    privateEndpointConnectionName,
    privateEndpointConnection
  );
  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 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/UpdatePrivateEndpointConnection.json
// this example is just showing the usage of "PrivateEndpointConnections_Update" 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";
SearchPrivateEndpointConnectionData data = new SearchPrivateEndpointConnectionData()
{
    Properties = new SearchServicePrivateEndpointConnectionProperties()
    {
        ConnectionState = new SearchServicePrivateLinkServiceConnectionState()
        {
            Status = SearchServicePrivateLinkServiceConnectionStatus.Rejected,
            Description = "Rejected for some reason",
        },
    },
};
ArmOperation<SearchPrivateEndpointConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateEndpointConnectionName, data);
SearchPrivateEndpointConnectionResource result = lro.Value;

// 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": "Rejected",
      "description": "Rejected for some reason",
      "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 endpoint privato esistente al servizio di ricerca.
PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.
PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Non riuscita, Operazione riuscita o Incompleta
PrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione al servizio collegamento privato esistente all'endpoint privato di Azure.
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.

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 dell'endpoint privato del provider Microsoft.Network.

PrivateEndpointConnection

Descrive una connessione endpoint privato esistente al servizio di ricerca.

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.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

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

PrivateLinkServiceConnectionProvisioningState

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

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 esistente all'endpoint privato di Azure.

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.