Shared Private Link Resources - List By Service

Usługa:: Search Management

Wersja interfejsu API:: 2023-11-01

Pobiera listę wszystkich udostępnionych zasobów łącza prywatnego zarządzanych przez daną usługę.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?api-version=2023-11-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	Nazwa usługi wyszukiwania 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, narzędzi wiersza polecenia 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.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SharedPrivateLinkResourceListResult	Operacja zakończyła się pomyślnie. Odpowiedź zawiera listę wszystkich udostępnionych zasobów łącza prywatnego zarządzanych przez daną usługę.
Other Status Codes	CloudError	Wystąpił nieoczekiwany błąd podczas operacji.

Zabezpieczenia

azure_auth

Przepływ autoryzacji OAuth2 identyfikatora Entra firmy Microsoft.

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

ListSharedPrivateLinkResourcesByService

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources?api-version=2023-11-01

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "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.
SharedPrivateLinkResource	Opisuje udostępniony zasób usługi Private Link zarządzany przez usługę wyszukiwania.
SharedPrivateLinkResourceListResult	Odpowiedź zawierająca listę udostępnionych zasobów usługi Private Link.
SharedPrivateLinkResourceProperties	Opisuje właściwości istniejącego udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.
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.

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.

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

SharedPrivateLinkResource

Objekt

Opisuje udostępniony zasób usługi Private Link zarządzany przez usługę wyszukiwania.

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	SharedPrivateLinkResourceProperties	Opisuje właściwości udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Objekt

Odpowiedź zawierająca listę udostępnionych zasobów usługi Private Link.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu udostępnionych zasobów łącza prywatnego, jeśli istnieją.
value	SharedPrivateLinkResource[]	Lista udostępnionych zasobów usługi Private Link.

SharedPrivateLinkResourceProperties

Objekt

Opisuje właściwości istniejącego udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy od dostawcy zasobu jest przeznaczony dla zasobu udostępnionego łącza prywatnego.
privateLinkResourceId	string	Identyfikator zasobu zasobu, dla których znajduje się udostępniony zasób łącza prywatnego.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.
requestMessage	string	Komunikat żądania żądania zatwierdzenia udostępnionego zasobu łącza prywatnego.
resourceRegion	string	Opcjonalny. Można użyć do określenia lokalizacji usługi Azure Resource Manager zasobu, do którego ma zostać utworzony udostępniony link prywatny. Jest to wymagane tylko dla tych zasobów, których konfiguracja DNS jest regionalna (na przykład Usługa Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

SharedPrivateLinkResourceProvisioningState

Wyliczenie

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

Wartość	Opis
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Wyliczenie

Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Wartość	Opis
Pending
Approved
Rejected
Disconnected