Private Link Resources - List Supported

Referenz

Dienst:: Search Management

API-Version:: 2025-05-01

Ruft eine Liste aller unterstützten ressourcentypen für private Verknüpfungen für den angegebenen Dienst ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateLinkResourcesResult	Der Vorgang war erfolgreich. Die Antwort enthält die Liste aller unterstützten Ressourcentypen für private Verknüpfungen für den angegebenen Dienst.
Other Status Codes	CloudError	Unerwarteter Fehler während des Vorgangs.

Sicherheit

azure_auth

Gibt einen impliziten Genehmigungsfluss an, der auf der Microsoft Identity Platform unterstützt wird.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ListSupportedPrivateLinkResources

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
PrivateLinkResource	Beschreibt eine unterstützte private Linkressource für den Azure AI Search-Dienst.
PrivateLinkResourceProperties	Beschreibt die Eigenschaften einer unterstützten privaten Linkressource für den Azure AI Search-Dienst. Bei einer bestimmten API-Version stellt dies die "supported" groupIds beim Erstellen einer freigegebenen privaten Linkressource dar.
PrivateLinkResourcesResult	Antwort, die eine Liste der unterstützten privaten Linkressourcen enthält.
ShareablePrivateLinkResourceProperties	Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.
ShareablePrivateLinkResourceType	Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde, der von Azure AI Search unterstützt wird.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message	string	Eine kurze Beschreibung des Fehlers, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

PrivateLinkResource

Objekt

Beschreibt eine unterstützte private Linkressource für den Azure AI Search-Dienst.

Name	Typ	Beschreibung
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateLinkResourceProperties	Beschreibt die Eigenschaften einer unterstützten privaten Linkressource für den Azure AI Search-Dienst.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Objekt

Beschreibt die Eigenschaften einer unterstützten privaten Linkressource für den Azure AI Search-Dienst. Bei einer bestimmten API-Version stellt dies die "supported" groupIds beim Erstellen einer freigegebenen privaten Linkressource dar.

Name	Typ	Beschreibung
groupId	string	Die Gruppen-ID der Ressource für private Verknüpfungen.
requiredMembers	string[]	Die Liste der erforderlichen Member der Ressource für private Verknüpfungen.
requiredZoneNames	string[]	Die Liste der erforderlichen DNS-Zonennamen der Ressource für private Verknüpfungen.
shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	Die Liste der Ressourcen, die in den privaten Linkdienst integriert sind, die von Azure AI Search unterstützt werden.

PrivateLinkResourcesResult

Objekt

Antwort, die eine Liste der unterstützten privaten Linkressourcen enthält.

Name	Typ	Beschreibung
value	PrivateLinkResource[]	Die Liste der unterstützten privaten Linkressourcen.

ShareablePrivateLinkResourceProperties

Objekt

Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.

Name	Typ	Beschreibung
description	string	Die Beschreibung des Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.
groupId	string	Die Gruppen-ID des Ressourcenanbieters für die Ressource, die in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.
type	string	Der Ressourcenanbietertyp für die Ressource, die in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.

ShareablePrivateLinkResourceType

Objekt

Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde, der von Azure AI Search unterstützt wird.

Name	Typ	Beschreibung
name	string	Der Name des Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.
properties	ShareablePrivateLinkResourceProperties	Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Private Link Resources - List Supported

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ListSupportedPrivateLinkResources

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

createdByType

PrivateLinkResource

PrivateLinkResourceProperties

PrivateLinkResourcesResult

ShareablePrivateLinkResourceProperties

ShareablePrivateLinkResourceType

systemData