指定されたサービスによって管理されているすべての共有プライベート リンク リソースの一覧を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?api-version=2023-11-01
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
resourceGroupName
|
path |
True
|
string
|
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
|
|
searchServiceName
|
path |
True
|
string
|
指定したリソース グループに関連付けられている検索サービスの名前。
|
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API、コマンド ライン ツール、またはポータルから取得できます。
|
|
api-version
|
query |
True
|
string
|
各要求に使用する API バージョン。
|
| 名前 |
必須 |
型 |
説明 |
|
x-ms-client-request-id
|
|
string
(uuid)
|
この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。
|
応答
セキュリティ
azure_auth
Microsoft Entra ID OAuth2 承認フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 |
説明 |
|
user_impersonation
|
ユーザー アカウントを偽装する
|
例
ListSharedPrivateLinkResourcesByService
要求のサンプル
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
応答のサンプル
{
"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
}
}
]
}
定義
CloudError
Object
API エラーに関する情報が含まれています。
CloudErrorBody
Object
エラー コードとメッセージを含む特定の API エラーについて説明します。
| 名前 |
型 |
説明 |
|
code
|
string
|
HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。
|
|
details
|
CloudErrorBody[]
|
このエラーに関連する入れ子になったエラーが含まれています。
|
|
message
|
string
|
エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
|
|
target
|
string
|
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。
|
SharedPrivateLinkResource
Object
検索サービスによって管理される Shared Private Link リソースについて説明します。
| 名前 |
型 |
説明 |
|
id
|
string
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
リソースの名前
|
|
properties
|
SharedPrivateLinkResourceProperties
|
検索サービスによって管理される Shared Private Link リソースのプロパティについて説明します。
|
|
type
|
string
|
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceListResult
Object
共有プライベート リンク リソースの一覧を含む応答。
SharedPrivateLinkResourceProperties
Object
検索サービスによって管理されている既存の Shared Private Link リソースのプロパティについて説明します。
| 名前 |
型 |
説明 |
|
groupId
|
string
|
共有プライベート リンク リソースの対象となるリソースのプロバイダーのグループ ID。
|
|
privateLinkResourceId
|
string
|
共有プライベート リンク リソースの対象となるリソースのリソース ID。
|
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
|
|
requestMessage
|
string
|
共有プライベート リンク リソースの承認を要求するための要求メッセージ。
|
|
resourceRegion
|
string
|
任意 共有プライベート リンクを作成するリソースの Azure Resource Manager の場所を指定するために使用できます。 これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。
|
|
status
|
SharedPrivateLinkResourceStatus
|
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
|
SharedPrivateLinkResourceProvisioningState
列挙
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
| 値 |
説明 |
|
Deleting
|
|
|
Failed
|
|
|
Incomplete
|
|
|
Succeeded
|
|
|
Updating
|
|
SharedPrivateLinkResourceStatus
列挙
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
| 値 |
説明 |
|
Approved
|
|
|
Disconnected
|
|
|
Pending
|
|
|
Rejected
|
|