Private Endpoint Connections - Update

サービス:: Search Management

API バージョン:: 2025-05-01

特定のリソースグループ内の検索サービスへのプライベートエンドポイント接続を更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2025-05-01

URI パラメーター

名前	/	必須	型	説明
privateEndpointConnectionName	path	True	string	指定したリソースグループを持つ Azure AI Search サービスへのプライベートエンドポイント接続の名前。
resourceGroupName	path	True	string	現在のサブスクリプション内のリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	指定したリソースグループに関連付けられている Azure AI Search サービスの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。この値は、Azure Resource Manager API またはポータルから取得できます。
api-version	query	True	string	各要求に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。指定した場合、これは要求を追跡する方法として応答情報に含まれます。

要求本文

名前	型	説明
properties	PrivateEndpointConnectionProperties	Azure AI Search サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。

応答

名前	型	説明
200 OK	PrivateEndpointConnection	既存のプライベートエンドポイント接続定義が正常に更新されました。
Other Status Codes	CloudError	HTTP 400 (無効な要求): 指定されたプライベートエンドポイント接続名またはプライベートエンドポイント接続定義が無効です。詳細については、応答のエラーコードとメッセージを参照してください。 HTTP 404 (見つかりません): サブスクリプション、リソースグループ、検索サービス、またはプライベートエンドポイント接続が見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

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

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

PrivateEndpointConnectionUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2025-05-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason."
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason.",
      "actionsRequired": "None"
    }
  }
}

定義

名前	説明
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
createdByType	リソースを作成した ID の種類。
PrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
PrivateEndpointConnection	Azure AI Search サービスへの既存のプライベートエンドポイント接続について説明します。
PrivateEndpointConnectionProperties	検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。
PrivateLinkServiceConnectionState	プライベートエンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。
PrivateLinkServiceConnectionStatus	プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

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

名前	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

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

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

PrivateEndpoint

Object

Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。

名前	型	説明
id	string	Microsoft.Network プロバイダーからのプライベートエンドポイントリソースのリソース ID。

PrivateEndpointConnection

Object

Azure AI Search サービスへの既存のプライベートエンドポイント接続について説明します。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	Azure AI Search サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。

名前	型	説明
groupId	string	プライベートリンクサービスの対象となる Azure リソースのグループ ID。
privateEndpoint	PrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートエンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。
provisioningState	PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。

PrivateLinkServiceConnectionProvisioningState

列挙

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

値	説明
Updating	プライベートリンクサービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。
Deleting	プライベートリンクサービス接続は削除中です。
Failed	プライベートリンクサービス接続をプロビジョニングまたは削除できませんでした。
Succeeded	プライベートリンクサービス接続のプロビジョニングが完了し、承認の準備が整いました。
Incomplete	プライベートリンクサービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。
Canceled	プライベートリンクサービス接続リソースのプロビジョニング要求が取り消されました。

PrivateLinkServiceConnectionState

Object

プライベートエンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。

名前	型	規定値	説明
actionsRequired	string	None	必要になる可能性がある追加のアクションの説明。
description	string		プライベートリンクサービスの接続状態の説明。
status	PrivateLinkServiceConnectionStatus		プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

PrivateLinkServiceConnectionStatus

列挙

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

値	説明
Pending	プライベートエンドポイント接続が作成され、承認が保留中です。
Approved	プライベートエンドポイント接続が承認され、使用できる状態になります。
Rejected	プライベートエンドポイント接続が拒否され、使用できません。
Disconnected	プライベートエンドポイント接続がサービスから削除されました。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Private Endpoint Connections - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

PrivateEndpointConnectionUpdate

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

createdByType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

systemData