Shared Private Link Resources - Create Or Update

Usługa:: Search Management

Wersja interfejsu API:: 2025-05-01

Inicjuje tworzenie lub aktualizowanie udostępnionego zasobu łącza prywatnego zarządzanego przez usługę wyszukiwania w danej grupie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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.
sharedPrivateLinkResourceName	path	True	string	Nazwa udostępnionego zasobu łącza prywatnego zarządzanego przez usługę Azure AI Search w określonej grupie 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	SharedPrivateLinkResourceProperties	Opisuje właściwości udostępnionego zasobu łącza prywatnego zarządzanego przez usługę Azure AI Search.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SharedPrivateLinkResource	Szczegóły udostępnionego zasobu łącza prywatnego, który został utworzony lub zaktualizowany.
202 Accepted		Udostępniona operacja tworzenia lub aktualizowania zasobu łącza prywatnego została zaakceptowana i zostanie ukończona asynchronicznie.
Other Status Codes	CloudError	HTTP 400 (Nieprawidłowe żądanie): podana nazwa zasobu łącza prywatnego lub definicja zasobu łącza prywatnego współużytkowanego 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 udostępnionego zasobu łącza prywatnego. 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

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

SharedPrivateLinkResourceCreateOrUpdate

Przykładowe zapytanie

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-05-01

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

Przykładowa odpowiedź

Kod stanu:: 202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01

Kod stanu:: 200

{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

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.
createdByType	Typ tożsamości, która utworzyła zasób.
SharedPrivateLinkResource	Opisuje udostępniony zasób łącza prywatnego zarządzany przez usługę Azure AI Search.
SharedPrivateLinkResourceProperties	Opisuje właściwości istniejącego udostępnionego zasobu łącza prywatnego zarządzanego przez usługę Azure AI Search.
SharedPrivateLinkResourceProvisioningState	Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.
SharedPrivateLinkResourceStatus	Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Sprzeciwiać się

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

Sprzeciwiać się

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

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key