Private Link Resources - List Supported

Hämtar en lista över alla typer av privata länkar som stöds för den aktuella tjänsten.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

searchServiceName
path True

string

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

Namnet på den Azure AI-sökning-tjänst som är associerad med den angivna resursgruppen.

subscriptionId
path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string (uuid)

Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name Typ Description
200 OK

PrivateLinkResourcesResult

Azure-operationen slutfördes framgångsrikt.

Other Status Codes

CloudError

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ListSupportedPrivateLinkResources

Exempelbegäran

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

Exempelsvar

{
  "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"
            }
          }
        ]
      }
    }
  ]
}

Definitioner

Name Description
CloudError

Innehåller information om ett API-fel.

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

createdByType

Den typ av identitet som skapade resursen.

PrivateLinkResource

Beskriver en stödd privat länkresurs för tjänsten Azure AI-sökning.

PrivateLinkResourceProperties

Beskriver egenskaperna hos en stödd privat länkresurs för Azure AI-sökning-tjänsten. För en viss API-version representerar detta groupIds som stöds när du skapar en resurs för delad privat länk.

PrivateLinkResourcesResult

Svar som innehåller en lista över private link-resurser som stöds.

ShareablePrivateLinkResourceProperties

Beskriver egenskaperna hos en resurstyp som har onboardats till privat länktjänst, stödd av Azure AI-sökning.

ShareablePrivateLinkResourceType

Beskriver en resurstyp som har onboardats till privat länk-tjänst, stödd av Azure AI-sökning.

systemData

Metadata som rör skapande och senaste ändring av resursen.

CloudError

Innehåller information om ett API-fel.

Name Typ Description
error

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

message

string

En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.

details

CloudErrorBody[]

Innehåller kapslade fel som är relaterade till det här felet.

message

string

Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.

target

string

Målet för det specifika felet (till exempel namnet på den felaktiga egenskapen).

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

PrivateLinkResource

Beskriver en stödd privat länkresurs för tjänsten Azure AI-sökning.

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Namnet på resursen

properties

PrivateLinkResourceProperties

Beskriver egenskaperna hos en stödd privat länkresurs för Azure AI-sökning-tjänsten.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Beskriver egenskaperna hos en stödd privat länkresurs för Azure AI-sökning-tjänsten. För en viss API-version representerar detta groupIds som stöds när du skapar en resurs för delad privat länk.

Name Typ Description
groupId

string

Grupp-ID för den privata länkresursen.

requiredMembers

string[]

Listan över nödvändiga medlemmar i den privata länkresursen.

requiredZoneNames

string[]

Listan över nödvändiga DNS-zonnamn för den privata länkresursen.

shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

Listan över resurser som är inbäddade till privat länktjänst och som stöds av Azure AI-sökning.

PrivateLinkResourcesResult

Svar som innehåller en lista över private link-resurser som stöds.

Name Typ Description
nextLink

string

URL:en för att få nästa uppsättning privata länkresurser, om det finns några.

value

PrivateLinkResource[]

Listan över private link-resurser som stöds.

ShareablePrivateLinkResourceProperties

Beskriver egenskaperna hos en resurstyp som har onboardats till privat länktjänst, stödd av Azure AI-sökning.

Name Typ Description
description

string

Beskrivningen av resurstypen som har onboardats till privat länktjänst, stödd av Azure AI-sökning.

groupId

string

Resursleverantörens grupp-id för resursen som har onboardats till privat länktjänst, stödd av Azure AI-sökning.

type

string

Resursleverantörstypen för resursen som har onboardats till privat länk-tjänst, stödd av Azure AI-sökning.

ShareablePrivateLinkResourceType

Beskriver en resurstyp som har onboardats till privat länk-tjänst, stödd av Azure AI-sökning.

Name Typ Description
name

string

Namnet på resurstypen som har onboardats till privat länktjänst, stöds av Azure AI-sökning.

properties

ShareablePrivateLinkResourceProperties

Beskriver egenskaperna hos en resurstyp som har onboardats till privat länktjänst, stödd av Azure AI-sökning.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.