Partager via

Private Link Resources - List Supported

  • Référence
Service:
Search Management
Version d'API:
2023-11-01

Obtient la liste de tous les types de ressources de liaison privée pris en charge pour le service donné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
searchServiceName
 path True

string

Nom du service de recherche associé au groupe de ressources spécifié.
subscriptionId
 path True

string

Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager, des outils en ligne de commande ou du portail.
api-version
 query True

string

Version de l’API à utiliser pour chaque requête.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string

uuid

Valeur GUID générée par le client, qui identifie cette demande. S’il est spécifié, il est inclus dans les informations de réponse afin de suivre la demande.

Réponses

Nom Type Description
200 OK

PrivateLinkResourcesResult

L’opération a réussi. La réponse contient la liste de tous les types de ressources de liaison privée pris en charge pour le service donné.
Other Status Codes

CloudError

Une erreur inattendue s’est produite pendant l’opération.

Sécurité

azure_auth

Microsoft Entra ID flux d’autorisation OAuth2.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ListSupportedPrivateLinkResources

Exemple de requête

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

Exemple de réponse

Code d’état:
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."
            }
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
CloudError

Contient des informations sur une erreur d’API.
CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.
PrivateLinkResource

Décrit une ressource de liaison privée prise en charge pour le service de recherche.
PrivateLinkResourceProperties

Décrit les propriétés d’une ressource de liaison privée prise en charge pour le service de recherche. Pour une version d’API donnée, cela représente les groupIds « pris en charge » lors de la création d’une ressource de liaison privée partagée.
PrivateLinkResourcesResult

Réponse contenant la liste des ressources Private Link prises en charge.
ShareablePrivateLinkResourceProperties

Décrit les propriétés d’un type de ressource qui a été intégré au service de liaison privée et qui est pris en charge par la recherche.
ShareablePrivateLinkResourceType

Décrit un type de ressource qui a été intégré au service private link et qui est pris en charge par la recherche.

CloudError

Contient des informations sur une erreur d’API.

Nom Type Description
error

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom Type Description
code

string

Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code status HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details

CloudErrorBody[]

Contient des erreurs imbriquées liées à cette erreur.
message

string

Message qui décrit l’erreur en détail et fournit des informations de débogage.
target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

PrivateLinkResource

Décrit une ressource de liaison privée prise en charge pour le service de recherche.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

nom de la ressource.
properties

PrivateLinkResourceProperties

Décrit les propriétés d’une ressource de liaison privée prise en charge pour le service de recherche.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateLinkResourceProperties

Décrit les propriétés d’une ressource de liaison privée prise en charge pour le service de recherche. Pour une version d’API donnée, cela représente les groupIds « pris en charge » lors de la création d’une ressource de liaison privée partagée.

Nom Type Description
groupId

string

ID de groupe de la ressource de liaison privée.
requiredMembers

string[]

Liste des membres requis de la ressource de liaison privée.
requiredZoneNames

string[]

Liste des noms de zone DNS requis de la ressource de liaison privée.
shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

Liste des ressources intégrées au service de liaison privée et prises en charge par la recherche.

PrivateLinkResourcesResult

Réponse contenant la liste des ressources Private Link prises en charge.

Nom Type Description
value

PrivateLinkResource[]

Liste des ressources Private Link prises en charge.

ShareablePrivateLinkResourceProperties

Décrit les propriétés d’un type de ressource qui a été intégré au service de liaison privée et qui est pris en charge par la recherche.

Nom Type Description
description

string

Description du type de ressource qui a été intégré au service de liaison privée et qui est pris en charge par la recherche.
groupId

string

ID de groupe du fournisseur de ressources pour la ressource qui a été intégrée au service de liaison privée et qui est prise en charge par la recherche.
type

string

Type de fournisseur de ressources pour la ressource qui a été intégrée au service de liaison privée et qui est prise en charge par la recherche.

ShareablePrivateLinkResourceType

Décrit un type de ressource qui a été intégré au service private link et qui est pris en charge par la recherche.

Nom Type Description
name

string

Nom du type de ressource qui a été intégré au service private link et qui est pris en charge par la recherche.
properties

ShareablePrivateLinkResourceProperties

Décrit les propriétés d’un type de ressource qui a été intégré au service de liaison privée et qui est pris en charge par la recherche.