지정된 리소스 그룹의 검색 서비스에서 관리하는 공유 프라이빗 링크 리소스의 세부 정보를 가져옵니다.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2023-11-01
URI 매개 변수
| Name |
In(다음 안에) |
필수 |
형식 |
Description |
|
resourceGroupName
|
path |
True
|
string
|
현재 구독 내의 리소스 그룹 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
|
|
searchServiceName
|
path |
True
|
string
|
지정된 리소스 그룹과 연결된 검색 서비스의 이름입니다.
|
|
sharedPrivateLinkResourceName
|
path |
True
|
string
|
지정된 리소스 그룹 내의 검색 서비스에서 관리하는 공유 프라이빗 링크 리소스의 이름입니다.
|
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure 구독의 고유 식별자입니다. Azure Resource Manager API, 명령줄 도구 또는 포털에서 이 값을 가져올 수 있습니다.
|
|
api-version
|
query |
True
|
string
|
각 요청에 사용할 API 버전입니다.
|
| Name |
필수 |
형식 |
Description |
|
x-ms-client-request-id
|
|
string
uuid
|
이 요청을 식별하는 클라이언트에서 생성한 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다.
|
응답
| Name |
형식 |
Description |
|
200 OK
|
SharedPrivateLinkResource
|
공유 프라이빗 링크 리소스의 정의가 성공적으로 검색되었으며 응답에 있습니다.
|
|
Other Status Codes
|
CloudError
|
HTTP 404(찾을 수 없음): 구독, 리소스 그룹, 검색 서비스 또는 공유 프라이빗 링크 리소스를 찾을 수 없습니다.
|
보안
azure_auth
OAuth2 권한 부여 흐름을 Microsoft Entra ID.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name |
Description |
|
user_impersonation
|
사용자 계정 가장
|
예제
SharedPrivateLinkResourceGet
샘플 요청
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
샘플 응답
{
"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
}
}
정의
CloudError
API 오류에 대한 정보를 포함합니다.
| Name |
형식 |
Description |
|
error
|
CloudErrorBody
|
오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.
|
CloudErrorBody
오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.
| Name |
형식 |
Description |
|
code
|
string
|
HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
|
|
details
|
CloudErrorBody[]
|
이 오류와 관련된 중첩된 오류를 포함합니다.
|
|
message
|
string
|
오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
|
|
target
|
string
|
특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).
|
SharedPrivateLinkResource
검색 서비스에서 관리하는 공유 Private Link 리소스에 대해 설명합니다.
| Name |
형식 |
Description |
|
id
|
string
|
리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
리소스의 이름입니다.
|
|
properties
|
SharedPrivateLinkResourceProperties
|
검색 서비스에서 관리하는 공유 Private Link 리소스의 속성을 설명합니다.
|
|
type
|
string
|
리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceProperties
검색 서비스에서 관리하는 기존 공유 Private Link 리소스의 속성을 설명합니다.
| Name |
형식 |
Description |
|
groupId
|
string
|
공유 프라이빗 링크 리소스가 있는 리소스 공급자의 그룹 ID입니다.
|
|
privateLinkResourceId
|
string
|
공유 프라이빗 링크 리소스의 리소스 ID입니다.
|
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
공유 프라이빗 링크 리소스의 프로비저닝 상태입니다. 유효한 값은 업데이트, 삭제, 실패, 성공 또는 불완전입니다.
|
|
requestMessage
|
string
|
공유 프라이빗 링크 리소스의 승인을 요청하기 위한 요청 메시지입니다.
|
|
resourceRegion
|
string
|
선택 사항입니다. 공유 프라이빗 링크를 만들 리소스의 Azure Resource Manager 위치를 지정하는 데 사용할 수 있습니다. DNS 구성이 지역(예: Azure Kubernetes Service)인 리소스에만 필요합니다.
|
|
status
|
SharedPrivateLinkResourceStatus
|
공유 프라이빗 링크 리소스의 상태입니다. 유효한 값은 보류 중, 승인됨, 거부됨 또는 연결 끊김입니다.
|
SharedPrivateLinkResourceProvisioningState
공유 프라이빗 링크 리소스의 프로비저닝 상태입니다. 유효한 값은 업데이트, 삭제, 실패, 성공 또는 불완전입니다.
| Name |
형식 |
Description |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Incomplete
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
SharedPrivateLinkResourceStatus
공유 프라이빗 링크 리소스의 상태입니다. 유효한 값은 보류 중, 승인됨, 거부됨 또는 연결 끊김입니다.
| Name |
형식 |
Description |
|
Approved
|
string
|
|
|
Disconnected
|
string
|
|
|
Pending
|
string
|
|
|
Rejected
|
string
|
|