次の方法で共有


Shared Private Link Resources - Get

指定されたリソース グループ内の検索サービスによって管理される共有プライベート リンク リソースの詳細を取得します。

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

URI パラメーター

名前 / 必須 説明
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 バージョン。

要求ヘッダー

名前 必須 説明
x-ms-client-request-id

string

uuid

クライアントが生成した、この要求を識別する GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前 説明
200 OK

SharedPrivateLinkResource

共有プライベート リンク リソースの定義が正常に取得され、応答中です。

Other Status Codes

CloudError

HTTP 404 (見つかりません): サブスクリプション、リソース グループ、検索サービス、または共有プライベート リンク リソースが見つかりませんでした。

セキュリティ

azure_auth

OAuth2 承認フローをMicrosoft Entra IDします。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

SharedPrivateLinkResourceGet

要求のサンプル

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

応答のサンプル

{
  "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 エラーに関する情報が含まれています。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

SharedPrivateLinkResource

検索サービスによって管理される共有Private Link リソースについて説明します。

SharedPrivateLinkResourceProperties

検索サービスによって管理される既存の共有Private Link リソースのプロパティについて説明します。

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

CloudError

API エラーに関する情報が含まれています。

名前 説明
error

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前 説明
code

string

エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。

details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。

message

string

エラーの詳細を説明し、デバッグ情報を提供するメッセージ。

target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

SharedPrivateLinkResource

検索サービスによって管理される共有Private Link リソースについて説明します。

名前 説明
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 リソースのプロパティについて説明します。

名前 説明
groupId

string

共有プライベート リンク リソースの対象となるリソースのプロバイダーからのグループ ID。

privateLinkResourceId

string

共有プライベート リンク リソースの対象となるリソースのリソース ID。

provisioningState

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

requestMessage

string

共有プライベート リンク リソースの承認を要求するための要求メッセージ。

resourceRegion

string

省略可能。 共有プライベート リンクを作成するリソースの Azure Resource Managerの場所を指定するために使用できます。 これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。

status

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

名前 説明
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

名前 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string