Shared Private Link Resources - List By Service

Référence

Service:: Search Management

Version d'API:: 2023-11-01

Obtient la liste de toutes les ressources de liaison privée partagées gérées par le service donné.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?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	SharedPrivateLinkResourceListResult	L’opération a réussi. La réponse contient la liste de toutes les ressources de liaison privée partagées gérées par 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

ListSharedPrivateLinkResourcesByService

Exemple de requête

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


/**
 * Samples for SharedPrivateLinkResources ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * ListSharedPrivateLinkResourcesByService.json
     */
    /**
     * Sample code: ListSharedPrivateLinkResourcesByService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSharedPrivateLinkResourcesByService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getSharedPrivateLinkResources().listByService("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_shared_private_link_resources_by_service.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.shared_private_link_resources.list_by_service(
        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/ListSharedPrivateLinkResourcesByService.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/ListSharedPrivateLinkResourcesByService.json
func ExampleSharedPrivateLinkResourcesClient_NewListByServicePager() {
	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.NewSharedPrivateLinkResourcesClient().NewListByServicePager("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.SharedPrivateLinkResourceListResult = armsearch.SharedPrivateLinkResourceListResult{
		// 	Value: []*armsearch.SharedPrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("testResource"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices/sharedPrivateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource"),
		// 			Properties: &armsearch.SharedPrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("blob"),
		// 				PrivateLinkResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName"),
		// 				RequestMessage: to.Ptr("please approve"),
		// 				Status: to.Ptr(armsearch.SharedPrivateLinkResourceStatusPending),
		// 			},
		// 	}},
		// }
	}
}

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 shared private link resources managed by the given service.
 *
 * @summary Gets a list of all shared private link resources managed by the given service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSharedPrivateLinkResourcesByService.json
 */
async function listSharedPrivateLinkResourcesByService() {
  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.sharedPrivateLinkResources.listByService(
    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.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListSharedPrivateLinkResourcesByService.json
// this example is just showing the usage of "SharedPrivateLinkResources_ListByService" 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);

// get the collection of this SharedSearchServicePrivateLinkResource
SharedSearchServicePrivateLinkResourceCollection collection = searchService.GetSharedSearchServicePrivateLinkResources();

// invoke the operation and iterate over the result
await foreach (SharedSearchServicePrivateLinkResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SharedSearchServicePrivateLinkResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "name": "testResource",
      "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
      "properties": {
        "requestMessage": "please approve",
        "groupId": "blob",
        "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
        "status": "Pending",
        "resourceRegion": null
      }
    }
  ]
}

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.
SharedPrivateLinkResource	Décrit une ressource de Private Link partagée gérée par le service de recherche.
SharedPrivateLinkResourceListResult	Réponse contenant une liste de ressources Private Link partagées.
SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de Private Link partagée existante gérée par le service de recherche.
SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.
SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

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).

SharedPrivateLinkResource

Décrit une ressource de Private Link partagée gérée par 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	SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de Private Link partagée gérée par le service de recherche.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceListResult

Réponse contenant une liste de ressources Private Link partagées.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble suivant de ressources de liaison privée partagée, le cas échéant.
value	SharedPrivateLinkResource[]	Liste des ressources Private Link partagées.

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée existante gérée par le service de recherche.

Nom	Type	Description
groupId	string	ID de groupe du fournisseur de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
privateLinkResourceId	string	ID de ressource de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
provisioningState	SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.
requestMessage	string	Message de demande d’approbation de la ressource de liaison privée partagée.
resourceRegion	string	facultatif. Peut être utilisé pour spécifier l’emplacement azure Resource Manager de la ressource vers laquelle une liaison privée partagée doit être créée. Cela est nécessaire uniquement pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

SharedPrivateLinkResourceProvisioningState

État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.

Nom	Type	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string