Private Link Resources - List Supported

Hiermee haalt u een lijst op met alle ondersteunde private link-resourcetypen voor de opgegeven service.

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

URI-parameters

Naam In Vereist Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resource group. De naam is hoofdletterongevoelig.

searchServiceName
path True

string

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

De naam van de Azure AI Zoeken-service die is gekoppeld aan de opgegeven resourcegroep.

subscriptionId
path True

string (uuid)

De ID van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Naam Vereist Type Description
x-ms-client-request-id

string (uuid)

Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Naam Type Description
200 OK

PrivateLinkResourcesResult

Azure-operatie succesvol voltooid.

Other Status Codes

CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ListSupportedPrivateLinkResources

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Naam Description
CloudError

Bevat informatie over een API-fout.

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

createdByType

Het identiteitstype dat de resource heeft gemaakt.

PrivateLinkResource

Beschrijft een ondersteunde private link-resource voor de Azure AI Zoeken-service.

PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde private link-resource voor de Azure AI Zoeken-service. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde private link-resource.

PrivateLinkResourcesResult

Antwoord met een lijst met ondersteunde Private Link-resources.

ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is ingebouwd op een private link-service, ondersteund door Azure AI Zoeken.

ShareablePrivateLinkResourceType

Beschrijft een resourcetype dat is ingebouwd naar een private link-service, ondersteund door Azure AI Zoeken.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Bevat informatie over een API-fout.

Naam Type Description
error

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

message

string

Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Naam Type Description
code

string

Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.

details

CloudErrorBody[]

Bevat geneste fouten die betrekking hebben op deze fout.

message

string

Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.

target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

createdByType

Het identiteitstype dat de resource heeft gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

PrivateLinkResource

Beschrijft een ondersteunde private link-resource voor de Azure AI Zoeken-service.

Naam Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"

name

string

De naam van de resource

properties

PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde private link-resource voor de Azure AI Zoeken-service.

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde private link-resource voor de Azure AI Zoeken-service. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde private link-resource.

Naam Type Description
groupId

string

De groeps-id van de private link-resource.

requiredMembers

string[]

De lijst met vereiste leden van de private link-resource.

requiredZoneNames

string[]

De lijst met vereiste DNS-zonenamen van de private link-resource.

shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

De lijst van bronnen die zijn ingebouwd op de private link-service en die worden ondersteund door Azure AI Zoeken.

PrivateLinkResourcesResult

Antwoord met een lijst met ondersteunde Private Link-resources.

Naam Type Description
nextLink

string

De URL om de volgende set privé-linkbronnen te krijgen, als die er zijn.

value

PrivateLinkResource[]

De lijst met ondersteunde Private Link-resources.

ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is ingebouwd op een private link-service, ondersteund door Azure AI Zoeken.

Naam Type Description
description

string

De beschrijving van het resourcetype dat is geïnboarded naar de private link-service, ondersteund door Azure AI Zoeken.

groupId

string

De resource provider group id voor de resource die is geïnboarded naar de private link-service, ondersteund door Azure AI Zoeken.

type

string

Het type resource provider voor de resource die is geïnboarded naar de private link-service, ondersteund door Azure AI Zoeken.

ShareablePrivateLinkResourceType

Beschrijft een resourcetype dat is ingebouwd naar een private link-service, ondersteund door Azure AI Zoeken.

Naam Type Description
name

string

De naam van het resourcetype dat is ingebouwd op de private link-service, ondersteund door Azure AI Zoeken.

properties

ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is ingebouwd op een private link-service, ondersteund door Azure AI Zoeken.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Naam Type Description
createdAt

string (date-time)

De tijdstempel van het aanmaken van resources (UTC).

createdBy

string

De identiteit die de resource heeft gemaakt.

createdByType

createdByType

Het identiteitstype dat de resource heeft gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.