Shared Private Link Resources - Get

Referentie

Service:: Search Management

API-versie:: 2023-11-01

Hiermee haalt u de details op van de gedeelde privékoppelingsresource die wordt beheerd door de zoekservice in de opgegeven resourcegroep.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?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.
sharedPrivateLinkResourceName	path	True	string	De naam van de gedeelde Private Link-resource die wordt beheerd door de zoekservice binnen 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	SharedPrivateLinkResource	De definitie van de gedeelde privékoppelingsresource is opgehaald en staat in het antwoord.
Other Status Codes	CloudError	HTTP 404 (niet gevonden): het abonnement, de resourcegroep, de zoekservice of de gedeelde privékoppelingsresource is niet gevonden.

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

SharedPrivateLinkResourceGet

Voorbeeldaanvraag

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


/**
 * Samples for SharedPrivateLinkResources Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetSharedPrivateLinkResource.
     * json
     */
    /**
     * Sample code: SharedPrivateLinkResourceGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void sharedPrivateLinkResourceGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getSharedPrivateLinkResources().getWithResponse("rg1",
            "mysearchservice", "testResource", 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 get_shared_private_link_resource.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.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        shared_private_link_resource_name="testResource",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetSharedPrivateLinkResource.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/GetSharedPrivateLinkResource.json
func ExampleSharedPrivateLinkResourcesClient_Get() {
	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)
	}
	res, err := clientFactory.NewSharedPrivateLinkResourcesClient().Get(ctx, "rg1", "mysearchservice", "testResource", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SharedPrivateLinkResource = 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 the details of the shared private link resource managed by the search service in the given resource group.
 *
 * @summary Gets the details of the shared private link resource managed by the search service in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetSharedPrivateLinkResource.json
 */
async function sharedPrivateLinkResourceGet() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const sharedPrivateLinkResourceName = "testResource";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.sharedPrivateLinkResources.get(
    resourceGroupName,
    searchServiceName,
    sharedPrivateLinkResourceName
  );
  console.log(result);
}

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/GetSharedPrivateLinkResource.json
// this example is just showing the usage of "SharedPrivateLinkResources_Get" 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
string sharedPrivateLinkResourceName = "testResource";
NullableResponse<SharedSearchServicePrivateLinkResource> response = await collection.GetIfExistsAsync(sharedPrivateLinkResourceName);
SharedSearchServicePrivateLinkResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Voorbeeldrespons

Statuscode:: 200

{
  "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
  }
}

Definities

Name	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
SharedPrivateLinkResource	Beschrijft een gedeelde Private Link resource die wordt beheerd door de zoekservice.
SharedPrivateLinkResourceProperties	Beschrijft de eigenschappen van een bestaande gedeelde Private Link resource die wordt beheerd door de zoekservice.
SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.
SharedPrivateLinkResourceStatus	Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

CloudError

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.

CloudErrorBody

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

SharedPrivateLinkResource

Beschrijft een gedeelde Private Link resource die wordt beheerd door 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	SharedPrivateLinkResourceProperties	Beschrijft de eigenschappen van een gedeelde Private Link resource die wordt beheerd door de zoekservice.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een bestaande gedeelde Private Link resource die wordt beheerd door de zoekservice.

Name	Type	Description
groupId	string	De groeps-id van de provider van de resource waarvoor de gedeelde Private Link-resource is bedoeld.
privateLinkResourceId	string	De resource-id van de resource waarvoor de gedeelde Private Link-resource is bedoeld.
provisioningState	SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.
requestMessage	string	Het aanvraagbericht voor het aanvragen van goedkeuring van de gedeelde Private Link-resource.
resourceRegion	string	Optioneel. Kan worden gebruikt om de Azure Resource Manager locatie op te geven van de resource waarnaar een gedeelde privékoppeling moet worden gemaakt. Dit is alleen vereist voor resources waarvan de DNS-configuratie regionaal is (zoals Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

SharedPrivateLinkResourceProvisioningState

De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.

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

SharedPrivateLinkResourceStatus

Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string