Shared Private Link Resources - Get

Referencia

Szolgáltatás:: Search Management

API-verzió:: 2023-11-01

Lekéri a keresési szolgáltatás által az adott erőforráscsoportban kezelt megosztott privát kapcsolati erőforrás részleteit.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string	A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.
sharedPrivateLinkResourceName	path	True	string	A keresési szolgáltatás által a megadott erőforráscsoporton belül kezelt megosztott privát kapcsolatú erőforrás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, a parancssori eszközökből vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Name	Típus	Description
200 OK	SharedPrivateLinkResource	A megosztott privát kapcsolati erőforrás definícióját sikerült lekérni, és a válaszban szerepel.
Other Status Codes	CloudError	HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport, a keresési szolgáltatás vagy a megosztott privát kapcsolat erőforrása nem található.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

SharedPrivateLinkResourceGet

Mintakérelem

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

Mintaválasz

Állapotkód:: 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
  }
}

Definíciók

Name	Description
CloudError	Egy API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.
SharedPrivateLinkResource	A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrást ismerteti.
SharedPrivateLinkResourceProperties	A keresési szolgáltatás által felügyelt meglévő megosztott Private Link-erőforrás tulajdonságait ismerteti.
SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
SharedPrivateLinkResourceStatus	A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

CloudError

Egy API-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

Name	Típus	Description
code	string	Egy hibakód, amely pontosabban írja le a hibaállapotot, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon lehet kezelni.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat tartalmaz.
target	string	Az adott hiba célja (például a hibás tulajdonság neve).

SharedPrivateLinkResource

A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrást ismerteti.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	SharedPrivateLinkResourceProperties	A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrás tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

A keresési szolgáltatás által felügyelt meglévő megosztott Private Link-erőforrás tulajdonságait ismerteti.

Name	Típus	Description
groupId	string	Annak az erőforrásnak a csoportazonosítója, amelyre a megosztott privát kapcsolatú erőforrás tartozik.
privateLinkResourceId	string	Annak az erőforrásnak az erőforrás-azonosítója, amelyre a megosztott privát kapcsolati erőforrás tartozik.
provisioningState	SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
requestMessage	string	A megosztott privát kapcsolati erőforrás jóváhagyását kérő üzenet.
resourceRegion	string	Választható. Segítségével megadhatja annak az erőforrásnak az Azure Resource Manager helyét, amelyhez megosztott privát kapcsolatot kíván létrehozni. Ez csak azokhoz az erőforrásokhoz szükséges, amelyek DNS-konfigurációja regionális (például Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

SharedPrivateLinkResourceProvisioningState

A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.

Name	Típus	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string