Private Endpoint Connections - Update

Usługa:: Search Management

Wersja interfejsu API:: 2025-02-01-preview

Aktualizuje połączenie prywatnego punktu końcowego z usługą wyszukiwania w danej grupie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
privateEndpointConnectionName	path	True	string	Nazwa połączenia prywatnego punktu końcowego z usługą Azure AI Search z określoną grupą zasobów.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nazwa usługi Azure AI Search skojarzonej z określoną grupą zasobów.
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania.

Treść żądania

Nazwa	Typ	Opis
properties	PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą Azure AI Search.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnection	Istniejąca definicja połączenia prywatnego punktu końcowego została pomyślnie zaktualizowana.
Other Status Codes	CloudError	HTTP 400 (nieprawidłowe żądanie): podana nazwa połączenia prywatnego punktu końcowego lub definicja połączenia prywatnego punktu końcowego jest nieprawidłowa. Aby uzyskać szczegółowe informacje, zobacz kod błędu i komunikat w odpowiedzi. HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji, grupy zasobów, usługi wyszukiwania lub prywatnego punktu końcowego. HTTP 409 (konflikt): określona subskrypcja jest wyłączona.

Zabezpieczenia

azure_auth

Określa niejawny przepływ udzielania, obsługiwany na platformie Microsoft Identity.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

PrivateEndpointConnectionUpdate

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
PrivateEndpointConnection	Opisuje istniejące połączenie prywatnego punktu końcowego z usługą Azure AI Search.
PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.
PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie, Niekompletne lub Anulowane.
PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Azure Private Link z prywatnym punktem końcowym.
PrivateLinkServiceConnectionStatus	Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

CloudError

Objekt

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
message	string	Krótki opis błędu, który wskazuje, co poszło nie tak (aby uzyskać szczegółowe informacje/debugowanie, zapoznaj się z właściwością "error.message").

CloudErrorBody

Objekt

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

PrivateEndpoint

Objekt

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnection

Objekt

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą Azure AI Search.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą Azure AI Search.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy zasobu platformy Azure, dla którego jest usługa łącza prywatnego.
privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Azure Private Link z prywatnym punktem końcowym.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie, Niekompletne lub Anulowane.

PrivateLinkServiceConnectionProvisioningState

Wyliczenie

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie, Niekompletne lub Anulowane.

Wartość	Opis
Updating	Połączenie usługi łącza prywatnego jest w trakcie tworzenia wraz z innymi zasobami, które mają być w pełni funkcjonalne.
Deleting	Połączenie usługi łącza prywatnego jest w trakcie usuwania.
Failed	Nie można zainicjować obsługi administracyjnej lub usunąć połączenia usługi łącza prywatnego.
Succeeded	Połączenie usługi private link zakończyło aprowizację i jest gotowe do zatwierdzenia.
Incomplete	Żądanie aprowizacji zasobu połączenia usługi private link zostało zaakceptowane, ale proces tworzenia nie został jeszcze rozpoczęty.
Canceled	Żądanie aprowizacji zasobu połączenia usługi private link zostało anulowane.

PrivateLinkServiceConnectionState

Objekt

Opisuje bieżący stan istniejącego połączenia usługi Azure Private Link z prywatnym punktem końcowym.

Nazwa	Typ	Domyślna wartość	Opis
actionsRequired	string	None	Opis wszelkich dodatkowych akcji, które mogą być wymagane.
description	string		Opis stanu połączenia usługi łącza prywatnego.
status	PrivateLinkServiceConnectionStatus		Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

PrivateLinkServiceConnectionStatus

Wyliczenie

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Wartość	Opis
Pending	Połączenie prywatnego punktu końcowego zostało utworzone i oczekuje na zatwierdzenie.
Approved	Połączenie prywatnego punktu końcowego jest zatwierdzone i jest gotowe do użycia.
Rejected	Połączenie prywatnego punktu końcowego zostało odrzucone i nie można go użyć.
Disconnected	Połączenie prywatnego punktu końcowego zostało usunięte z usługi.