Delen via

Private Link Resources - List Supported

  • Referentie
Service:
Search Management
API-versie:
2023-11-01

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=2023-11-01

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName
 path True

string

De naam van de zoekservice die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId
 path True

string

De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API, opdrachtregelprogramma's of de portal.
api-version
 query True

string

De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name 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 de antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Name Type Description
200 OK

PrivateLinkResourcesResult

De bewerking is voltooid. Het antwoord bevat de lijst met alle ondersteunde private link-resourcetypen voor de opgegeven service.
Other Status Codes

CloudError

Er is een onverwachte fout opgetreden tijdens de bewerking.

Beveiliging

azure_auth

Microsoft Entra ID OAuth2-autorisatiestroom.

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

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ListSupportedPrivateLinkResources

Voorbeeldaanvraag

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

Voorbeeldrespons

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 Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "table",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "groupId": "table",
              "description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "Sql",
            "properties": {
              "type": "Microsoft.DocumentDB/databaseAccounts",
              "groupId": "Sql",
              "description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)."
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.Sql/servers",
              "groupId": "sqlServer",
              "description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)."
            }
          },
          {
            "name": "vault",
            "properties": {
              "type": "Microsoft.KeyVault/vaults",
              "groupId": "vault",
              "description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.DBforMySQL/servers",
              "groupId": "mysqlServer",
              "description": "Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)."
            }
          },
          {
            "name": "site",
            "properties": {
              "type": "Microsoft.Web/sites",
              "groupId": "sites",
              "description": "Azure Cognitive Search indexers can connect to App Services when executing custom web api skills that can be present in a skillset (optional) attached to the indexer."
            }
          }
        ]
      }
    }
  ]
}

Definities

Name Description
CloudError

Bevat informatie over een API-fout.
CloudErrorBody

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

Beschrijft een ondersteunde Private Link-resource voor de zoekservice.
PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de zoekservice. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde privékoppelingsresource.
PrivateLinkResourcesResult

Antwoord met een lijst met ondersteunde Private Link resources.
ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.
ShareablePrivateLinkResourceType

Beschrijft een resourcetype dat is toegevoegd aan de Private Link-service en dat wordt ondersteund door zoeken.

CloudError

Object

Bevat informatie over een API-fout.

Name Type Description
error

CloudErrorBody

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

CloudErrorBody

Object

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

Name Type Description
code

string

Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
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).

PrivateLinkResource

Object

Beschrijft een ondersteunde Private Link-resource voor de zoekservice.

Name Type Description
id

string

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

string

De naam van de resource
properties

PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de zoekservice.
type

string

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

PrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de zoekservice. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde privékoppelingsresource.

Name 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 met resources die worden toegevoegd aan de Private Link-service en die worden ondersteund door de zoekfunctie.

PrivateLinkResourcesResult

Object

Antwoord met een lijst met ondersteunde Private Link resources.

Name Type Description
value

PrivateLinkResource[]

De lijst met ondersteunde Private Link resources.

ShareablePrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.

Name Type Description
description

string

De beschrijving van het resourcetype dat is toegevoegd aan de Private Link-service en dat wordt ondersteund door de zoekfunctie.
groupId

string

De resourceprovidergroeps-id voor de resource die is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.
type

string

Het resourceprovidertype voor de resource die is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.

ShareablePrivateLinkResourceType

Object

Beschrijft een resourcetype dat is toegevoegd aan de Private Link-service en dat wordt ondersteund door zoeken.

Name Type Description
name

string

De naam van het resourcetype dat is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.
properties

ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service en die wordt ondersteund door de zoekfunctie.