Shared Private Link Resources - List By Service

指定されたサービスによって管理されているすべての共有プライベート リンク リソースの一覧を取得します。

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName
path True

string

指定したリソース グループに関連付けられている Azure AI Search Serviceの名前。

正規表現パターン: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

subscriptionId
path True

string

Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

api-version
query True

string

要求ごとに使用する API バージョン。

要求ヘッダー

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

string

uuid

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

応答

名前 説明
200 OK

SharedPrivateLinkResourceListResult

操作が成功しました。 応答には、指定されたサービスによって管理されるすべての共有プライベート リンク リソースの一覧が含まれます。

Other Status Codes

CloudError

この操作の実行中に予期しないエラーが発生しました。

セキュリティ

azure_auth

Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。

型: 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=2024-03-01-preview

応答のサンプル

{
  "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

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

CloudErrorBody

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

SharedPrivateLinkResource

Azure AI Search Serviceによって管理される共有プライベート リンク リソースについて説明します。

SharedPrivateLinkResourceListResult

共有プライベート リンク リソースの一覧を含む応答。

SharedPrivateLinkResourceProperties

Azure AI Search Serviceによって管理される既存の共有プライベート リンク リソースのプロパティについて説明します。

SharedPrivateLinkResourceProvisioningState

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

SharedPrivateLinkResourceStatus

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

CloudError

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

名前 説明
error

CloudErrorBody

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

message

string

問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

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

名前 説明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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

SharedPrivateLinkResource

Azure AI Search Serviceによって管理される共有プライベート リンク リソースについて説明します。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties

SharedPrivateLinkResourceProperties

Azure AI Search Serviceによって管理される共有プライベート リンク リソースのプロパティについて説明します。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

共有プライベート リンク リソースの一覧を含む応答。

名前 説明
nextLink

string

共有プライベート リンク リソースの次のセットを取得する URL (存在する場合)。

value

SharedPrivateLinkResource[]

共有プライベート リンク リソースの一覧。

SharedPrivateLinkResourceProperties

Azure AI Search Serviceによって管理される既存の共有プライベート リンク リソースのプロパティについて説明します。

名前 説明
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

共有プライベート リンク リソースは拒否され、使用できません。