Private Link Resources - List Supported
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=2026-11-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
Der Name des Azure KI-Suche Diensts, der der angegebenen Ressourcengruppe zugeordnet ist. |
|
subscription
|
path | True |
string (uuid) |
Die ID des Zielabonnements. Der Wert muss eine UUID sein. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang 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 |
Azure-Operation erfolgreich abgeschlossen. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Sich als Ihr Benutzerkonto ausgeben |
Beispiele
ListSupportedPrivateLinkResources
Beispielanforderung
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources?api-version=2026-11-01
Beispiel für eine Antwort
{
"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"
}
}
]
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Cloud |
Enthält Informationen zu einem API-Fehler. |
|
Cloud |
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung. |
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Private |
Beschreibt eine unterstützte private Link-Ressource für den Azure KI-Suche-Dienst. |
|
Private |
Beschreibt die Eigenschaften einer unterstützten privaten Link-Ressource für den Azure KI-Suche-Dienst. Bei einer bestimmten API-Version stellt dies die "supported" groupIds beim Erstellen einer freigegebenen privaten Linkressource dar. |
|
Private |
Antwort, die eine Liste der unterstützten privaten Linkressourcen enthält. |
|
Shareable |
Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
|
Shareable |
Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde und von Azure KI-Suche unterstützt wird. |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
CloudError
Enthält Informationen zu einem API-Fehler.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
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
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 |
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 jeweiligen Fehlers (z. B. der Name der fehlerhaften Eigenschaft). |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
PrivateLinkResource
Beschreibt eine unterstützte private Link-Ressource für den Azure KI-Suche-Dienst.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string (arm-id) |
Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
Der Name der Ressource |
| properties |
Beschreibt die Eigenschaften einer unterstützten privaten Link-Ressource für den Azure KI-Suche-Dienst. |
|
| 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
Beschreibt die Eigenschaften einer unterstützten privaten Link-Ressource für den Azure KI-Suche-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 |
Die Liste der Ressourcen, die auf den Private-Link-Service integriert sind und von Azure KI-Suche unterstützt werden. |
PrivateLinkResourcesResult
Antwort, die eine Liste der unterstützten privaten Linkressourcen enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| nextLink |
string |
Die URL, um die nächste Gruppe privater Link-Ressourcen zu erhalten, falls es welche gibt. |
| value |
Die Liste der unterstützten privaten Linkressourcen. |
ShareablePrivateLinkResourceProperties
Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche.
| Name | Typ | Beschreibung |
|---|---|---|
| description |
string |
Die Beschreibung des Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
| groupId |
string |
Die Resource Provider-Gruppen-ID für die Ressource, die in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
| type |
string |
Der Resource Provider-Typ für die Ressource, die in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
ShareablePrivateLinkResourceType
Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde und von Azure KI-Suche unterstützt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name des Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
| properties |
Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure KI-Suche. |
systemData
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 |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |