Private Link Resources - List Supported

Odwołanie

Usługa:: Search Management

Wersja interfejsu API:: 2023-11-01

Pobiera listę wszystkich obsługiwanych typów zasobów łącza prywatnego dla danej usługi.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
searchServiceName	path	True	string	Nazwa usługi wyszukiwania skojarzonej z określoną grupą zasobów.
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager, narzędzi wiersza polecenia lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateLinkResourcesResult	Operacja zakończyła się pomyślnie. Odpowiedź zawiera listę wszystkich obsługiwanych typów zasobów łącza prywatnego dla danej usługi.
Other Status Codes	CloudError	Podczas tej operacji wystąpił niespodziewany błąd.

Zabezpieczenia

azure_auth

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ListSupportedPrivateLinkResources

Przykładowe żądanie

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


/**
 * Samples for PrivateLinkResources ListSupported.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * ListSupportedPrivateLinkResources.json
     */
    /**
     * Sample code: ListSupportedPrivateLinkResources.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSupportedPrivateLinkResources(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateLinkResources().listSupported("rg1",
            "mysearchservice", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python list_supported_private_link_resources.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_link_resources.list_supported(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSupportedPrivateLinkResources.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSupportedPrivateLinkResources.json
func ExamplePrivateLinkResourcesClient_NewListSupportedPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListSupportedPager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourcesResult = armsearch.PrivateLinkResourcesResult{
		// 	Value: []*armsearch.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("searchService"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService"),
		// 			Properties: &armsearch.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("searchService"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("searchService")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.search.windows.net")},
		// 						ShareablePrivateLinkResourceTypes: []*armsearch.ShareablePrivateLinkResourceType{
		// 							{
		// 								Name: to.Ptr("blob"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Storage/storageAccounts"),
		// 									Description: to.Ptr("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)"),
		// 									GroupID: to.Ptr("blob"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("table"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Storage/storageAccounts"),
		// 									Description: to.Ptr("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)"),
		// 									GroupID: to.Ptr("table"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("Sql"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
		// 									Description: to.Ptr("Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)."),
		// 									GroupID: to.Ptr("Sql"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("plr"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Sql/servers"),
		// 									Description: to.Ptr("Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)."),
		// 									GroupID: to.Ptr("sqlServer"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("vault"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.KeyVault/vaults"),
		// 									Description: to.Ptr("Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"),
		// 									GroupID: to.Ptr("vault"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("plr"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.DBforMySQL/servers"),
		// 									Description: to.Ptr("Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)."),
		// 									GroupID: to.Ptr("mysqlServer"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("site"),
		// 								Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Web/sites"),
		// 									Description: to.Ptr("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."),
		// 									GroupID: to.Ptr("sites"),
		// 								},
		// 						}},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of all supported private link resource types for the given service.
 *
 * @summary Gets a list of all supported private link resource types for the given service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSupportedPrivateLinkResources.json
 */
async function listSupportedPrivateLinkResources() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateLinkResources.listSupported(
    resourceGroupName,
    searchServiceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSupportedPrivateLinkResources.json
// this example is just showing the usage of "PrivateLinkResources_ListSupported" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// invoke the operation and iterate over the result
await foreach (SearchPrivateLinkResource item in searchService.GetSupportedPrivateLinkResourcesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 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."
            }
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
PrivateLinkResource	Opisuje obsługiwany zasób łącza prywatnego dla usługi wyszukiwania.
PrivateLinkResourceProperties	Opisuje właściwości obsługiwanego zasobu łącza prywatnego dla usługi wyszukiwania. W przypadku danej wersji interfejsu API reprezentuje to "obsługiwane" identyfikatory groupId podczas tworzenia udostępnionego zasobu łącza prywatnego.
PrivateLinkResourcesResult	Odpowiedź zawierająca listę obsługiwanych zasobów Private Link.
ShareablePrivateLinkResourceProperties	Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.
ShareablePrivateLinkResourceType	Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

PrivateLinkResource

Opisuje obsługiwany zasób łącza prywatnego dla usługi wyszukiwania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	PrivateLinkResourceProperties	Opisuje właściwości obsługiwanego zasobu łącza prywatnego dla usługi wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Opisuje właściwości obsługiwanego zasobu łącza prywatnego dla usługi wyszukiwania. W przypadku danej wersji interfejsu API reprezentuje to "obsługiwane" identyfikatory groupId podczas tworzenia udostępnionego zasobu łącza prywatnego.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy zasobu łącza prywatnego.
requiredMembers	string[]	Lista wymaganych elementów członkowskich zasobu łącza prywatnego.
requiredZoneNames	string[]	Lista wymaganych nazw stref DNS zasobu łącza prywatnego.
shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	Lista zasobów dołączonych do usługi łącza prywatnego i obsługiwanych przez wyszukiwanie.

PrivateLinkResourcesResult

Odpowiedź zawierająca listę obsługiwanych zasobów Private Link.

Nazwa	Typ	Opis
value	PrivateLinkResource[]	Lista obsługiwanych zasobów Private Link.

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.

Nazwa	Typ	Opis
description	string	Opis typu zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.
groupId	string	Identyfikator grupy dostawcy zasobów dla zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.
type	string	Typ dostawcy zasobów dla zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.

ShareablePrivateLinkResourceType

Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.

Nazwa	Typ	Opis
name	string	Nazwa typu zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwana przez wyszukiwanie.
properties	ShareablePrivateLinkResourceProperties	Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego i jest obsługiwany przez wyszukiwanie.