Private Endpoint Connections - Update
特定のリソース グループ内の検索サービスへのプライベート エンドポイント接続を更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
private
|
path | True |
string |
指定したリソース グループを持つ検索サービスへのプライベート エンドポイント接続の名前。 |
resource
|
path | True |
string |
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。 |
search
|
path | True |
string |
指定したリソース グループに関連付けられている検索サービスの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API、コマンド ライン ツール、またはポータルから取得できます。 |
api-version
|
query | True |
string |
各要求に使用する API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
クライアントが生成した、この要求を識別する GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties |
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
既存のプライベート エンドポイント接続定義が正常に更新されました。 |
|
Other Status Codes |
HTTP 400 (無効な要求): 指定されたプライベート エンドポイント接続名またはプライベート エンドポイント接続定義が無効です。詳細については、応答のエラー コードとメッセージを参照してください。 HTTP 404 (見つかりません): サブスクリプション、リソース グループ、検索サービス、またはプライベート エンドポイント接続が見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。 |
セキュリティ
azure_auth
OAuth2 承認フローをMicrosoft Entra IDします。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
PrivateEndpointConnectionUpdate
要求のサンプル
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2023-11-01
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Rejected",
"description": "Rejected for some reason"
}
}
}
応答のサンプル
{
"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"
}
}
}
定義
名前 | 説明 |
---|---|
Cloud |
API エラーに関する情報が含まれます。 |
Cloud |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
Private |
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。 |
Private |
検索サービスへの既存のプライベート エンドポイント接続について説明します。 |
Private |
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。 |
Private |
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です |
Private |
Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。 |
Private |
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。 |
CloudError
API エラーに関する情報が含まれます。
名前 | 型 | 説明 |
---|---|---|
error |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
CloudErrorBody
エラー コードとメッセージを含む特定の API エラーについて説明します。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。 |
details |
このエラーに関連する入れ子になったエラーが含まれています。 |
|
message |
string |
エラーを詳細に説明し、デバッグ情報を提供するメッセージ。 |
target |
string |
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 |
PrivateEndpoint
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Microsoft.Network プロバイダーからのプライベート エンドポイント リソースのリソース ID。 |
PrivateEndpointConnection
検索サービスへの既存のプライベート エンドポイント接続について説明します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties |
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
名前 | 型 | 説明 |
---|---|---|
groupId |
string |
プライベート リンク サービス接続の対象となるリソースのプロバイダーからのグループ ID。 |
privateEndpoint |
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。 |
|
privateLinkServiceConnectionState |
Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。 |
|
provisioningState |
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です |
PrivateLinkServiceConnectionProvisioningState
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です
名前 | 型 | 説明 |
---|---|---|
Canceled |
string |
プライベート リンク サービス接続リソースのプロビジョニング要求が取り消されました |
Deleting |
string |
プライベート リンク サービス接続は、削除中です。 |
Failed |
string |
プライベート リンク サービス接続のプロビジョニングまたは削除に失敗しました。 |
Incomplete |
string |
プライベート リンク サービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。 |
Succeeded |
string |
プライベート リンク サービス接続のプロビジョニングが完了し、承認の準備が整いました。 |
Updating |
string |
プライベート リンク サービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。 |
PrivateLinkServiceConnectionState
Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
actionsRequired |
string |
None |
必要になる可能性がある追加のアクションの説明。 |
description |
string |
プライベート リンク サービスの接続状態の説明。 |
|
status |
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。 |
PrivateLinkServiceConnectionStatus
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
名前 | 型 | 説明 |
---|---|---|
Approved |
string |
プライベート エンドポイント接続が承認され、使用できる状態になります。 |
Disconnected |
string |
プライベート エンドポイント接続がサービスから削除されました。 |
Pending |
string |
プライベート エンドポイント接続が作成され、承認が保留中です。 |
Rejected |
string |
プライベート エンドポイント接続が拒否され、使用できません。 |