Private Link Resources - List Supported

Pobiera listę wszystkich obsługiwanych typów zasobów łącza prywatnego dla danej usługi.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?api-version=2026-11-01

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

searchServiceName
path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Nazwa usługi Wyszukiwanie AI platformy Azure skojarzonej z określoną grupą zasobów.

subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwisko 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

Nazwisko Typ Opis
200 OK

PrivateLinkResourcesResult

Operacja Azure zakończyła się pomyślnie.

Other Status Codes

CloudError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

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

Zakresy

Nazwisko Opis
user_impersonation podszywaj się pod konto użytkownika

Przykłady

ListSupportedPrivateLinkResources

Przykładowe żądanie

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources?api-version=2026-11-01

Przykładowa odpowiedź

{
  "value": [
    {
      "name": "searchService",
      "type": "Microsoft.Search/searchServices/privateLinkResources",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService",
      "properties": {
        "groupId": "searchService",
        "requiredMembers": [
          "searchService"
        ],
        "requiredZoneNames": [
          "privatelink.search.windows.net"
        ],
        "shareablePrivateLinkResourceTypes": [
          {
            "name": "blob",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "description": "Azure AI Search indexers can connect to blobs in Azure Storage for reading data from an indexer data source, for writing intermediate results of indexer execution or for storing any knowledge store projections.",
              "groupId": "blob"
            }
          },
          {
            "name": "table",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "description": "Azure AI Search indexers can connect to tables in Azure Storage for reading data from an indexer data source, for writing intermediate results of indexer execution or for storing any knowledge store projections.",
              "groupId": "table"
            }
          },
          {
            "name": "Sql",
            "properties": {
              "type": "Microsoft.DocumentDB/databaseAccounts",
              "description": "Azure AI Search indexers can connect to Azure Cosmos DB API for NoSQL for reading data from an indexer data source.",
              "groupId": "Sql"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.Sql/servers",
              "description": "Azure AI Search indexers can connect to Azure SQL database on a server for reading data from an indexer data source.",
              "groupId": "sqlServer"
            }
          },
          {
            "name": "vault",
            "properties": {
              "type": "Microsoft.KeyVault/vaults",
              "description": "Azure AI Search can access keys in Azure Key Vault to encrypt sensitive data in a search index and synonym map data.",
              "groupId": "vault"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.DBforMySQL/servers",
              "description": "Azure AI Search indexers can connect to MySQL databases for reading data from an indexer data source.",
              "groupId": "mysqlServer"
            }
          },
          {
            "name": "site",
            "properties": {
              "type": "Microsoft.Web/sites",
              "description": "For custom skills that connect to an app service, you can specify sites as the group ID.",
              "groupId": "sites"
            }
          }
        ]
      }
    }
  ]
}

Definicje

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

PrivateLinkResource

Opisuje obsługiwany zasób linków prywatnych dla usługi Wyszukiwanie AI platformy Azure.

PrivateLinkResourceProperties

Opisuje właściwości obsługiwanego zasobu linku prywatnego dla usługi Wyszukiwanie AI platformy Azure. W przypadku danej wersji interfejsu API reprezentuje to "obsługiwane" identyfikatory groupId podczas tworzenia udostępnionego zasobu łącza prywatnego.

PrivateLinkResourcesResult

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

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu wdrożonego do usługi linku prywatnego, wspieranego przez Wyszukiwanie AI platformy Azure.

ShareablePrivateLinkResourceType

Opisuje typ zasobu włączony do usługi prywatnego linku, wspieranej przez Wyszukiwanie AI platformy Azure.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwisko 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

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

Nazwisko 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

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

Wartość Opis
User
Application
ManagedIdentity
Key

PrivateLinkResource

Opisuje obsługiwany zasób linków prywatnych dla usługi Wyszukiwanie AI platformy Azure.

Nazwisko Typ Opis
id

string (arm-id)

W pełni określony identyfikator zasobu dla tego zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nazwa zasobu

properties

PrivateLinkResourceProperties

Opisuje właściwości obsługiwanego zasobu linku prywatnego dla usługi Wyszukiwanie AI platformy Azure.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Opisuje właściwości obsługiwanego zasobu linku prywatnego dla usługi Wyszukiwanie AI platformy Azure. W przypadku danej wersji interfejsu API reprezentuje to "obsługiwane" identyfikatory groupId podczas tworzenia udostępnionego zasobu łącza prywatnego.

Nazwisko Typ Opis
groupId

string

Identyfikator grupy zasobu łącza prywatnego.

requiredMembers

string[]

Lista wymaganych członków zasobu łącza prywatnego.

requiredZoneNames

string[]

Lista wymaganych nazw stref DNS zasobu łącza prywatnego.

shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

Lista zasobów wdrażanych w usłudze prywatnego linku, wspieranych przez Wyszukiwanie AI platformy Azure.

PrivateLinkResourcesResult

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

Nazwisko Typ Opis
nextLink

string

URL do uzyskania kolejnego zestawu zasobów linków prywatnych, jeśli takie są.

value

PrivateLinkResource[]

Lista obsługiwanych zasobów usługi Private Link.

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu wdrożonego do usługi linku prywatnego, wspieranego przez Wyszukiwanie AI platformy Azure.

Nazwisko Typ Opis
description

string

Opis typu zasobu wdrożonego do usługi linku prywatnego, wspieranego przez Wyszukiwanie AI platformy Azure.

groupId

string

Identyfikator grupy dostawcy zasobów zasobów, który został włączony do usługi linku prywatnego, obsługiwanego przez Wyszukiwanie AI platformy Azure.

type

string

Typ dostawcy zasobów dla zasobu, który został włączony do usługi linku prywatnego, obsługiwanej przez Wyszukiwanie AI platformy Azure.

ShareablePrivateLinkResourceType

Opisuje typ zasobu włączony do usługi prywatnego linku, wspieranej przez Wyszukiwanie AI platformy Azure.

Nazwisko Typ Opis
name

string

Nazwa typu zasobu wdrożonego do usługi private link, wspieranej przez Wyszukiwanie AI platformy Azure.

properties

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu wdrożonego do usługi linku prywatnego, wspieranego przez Wyszukiwanie AI platformy Azure.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwisko Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

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

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

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