Private Endpoint Connections - Delete

プライベート エンドポイント接続を切断し、検索サービスから削除します。

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-04-01-preview

URI パラメーター

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

指定したリソース グループを持つAzure Cognitive Search サービスへのプライベート エンドポイント接続の名前。

resourceGroupName
path True
  • string

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

searchServiceName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求ヘッダー

Name Required Type Description
x-ms-client-request-id
  • string
uuid

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

応答

Name Type Description
200 OK

プライベート エンドポイント接続が正常に切断され、検索サービスから削除されました。 応答には、プライベート エンドポイント接続の更新された定義が含まれます。

404 Not Found

サブスクリプション、リソース グループ、検索サービス、またはプライベート エンドポイント接続が見つかりませんでした。

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

PrivateEndpointConnectionDelete

Sample Request

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

Sample Response

{
  "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": "Disconnected",
      "description": "",
      "actionsRequired": "None"
    }
  }
}

定義

CloudError

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

CloudErrorBody

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

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否、または切断が可能です。

CloudError

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

Name Type Description
error

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

message
  • string

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

CloudErrorBody

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

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

特定のエラーのターゲット (エラーのプロパティの名前など)。

PrivateEndpoint

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

Name Type Description
id
  • string

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

PrivateEndpointConnection

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

Name Type Description
id
  • string

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

name
  • string

リソースの名前

properties

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

type
  • string

リソースの型。 たとえば、"Microsoft.Compute/virtualMachines" や "Microsoft" などです。Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

Name Type Description
privateEndpoint

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

privateLinkServiceConnectionState

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

PrivateLinkServiceConnectionState

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

Name Type Default Value Description
actionsRequired
  • string
None

必要になる可能性がある追加のアクションの説明。

description
  • string

プライベート リンク サービスの接続状態の説明。

status

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否、または切断が可能です。

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否、または切断が可能です。

Name Type Description
Approved
  • string

プライベート エンドポイント接続が承認され、使用できる状態になります。

Disconnected
  • string

プライベート エンドポイント接続がサービスから削除されました。

Pending
  • string

プライベート エンドポイント接続が作成され、承認が保留中です。

Rejected
  • string

プライベート エンドポイント接続が拒否され、使用できません。