Obtém os detalhes do recurso de link privado compartilhado gerenciado pelo serviço de pesquisa no grupo de recursos especificado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2023-11-01
Parâmetros de URI
Nome
Em
Obrigatório
Tipo
Description
resourceGroupName
path
True
string
O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
searchServiceName
path
True
string
O nome do serviço de pesquisa associado ao grupo de recursos especificado.
sharedPrivateLinkResourceName
path
True
string
O nome do recurso de link privado compartilhado gerenciado pelo serviço de pesquisa dentro do grupo de recursos especificado.
subscriptionId
path
True
string
O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API de Resource Manager do Azure, das ferramentas de linha de comando ou do portal.
api-version
query
True
string
A versão da API a ser usada para cada solicitação.
Cabeçalho da solicitação
Nome
Obrigatório
Tipo
Description
x-ms-client-request-id
string
uuid
Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.
HTTP 404 (Não Encontrado): não foi possível encontrar a assinatura, o grupo de recursos, o serviço de pesquisa ou o recurso de link privado compartilhado.
Segurança
azure_auth
Microsoft Entra ID fluxo de autorização OAuth2.
Tipo:
oauth2 Flow:
implicit URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
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);
}
}
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()
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),
// },
// }
}
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);
}
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://zcusa.951200.xyz/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}");
}
Descreve um erro de API específico com um código de erro e uma mensagem.
CloudErrorBody
Descreve um erro de API específico com um código de erro e uma mensagem.
Nome
Tipo
Description
code
string
Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target
string
O destino do erro específico (por exemplo, o nome da propriedade em erro).
SharedPrivateLinkResource
Descreve um Recurso de Link Privado Compartilhado gerenciado pelo serviço de pesquisa.
Nome
Tipo
Description
id
string
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.
requestMessage
string
A mensagem de solicitação para solicitar a aprovação do recurso de link privado compartilhado.
resourceRegion
string
Opcional. Pode ser usado para especificar o local Resource Manager do Azure do recurso ao qual um link privado compartilhado deve ser criado. Isso só é necessário para os recursos cuja configuração de DNS é regional (como Serviço de Kubernetes do Azure).