Private Endpoint Connections - Delete

サービス:

Search Management

API バージョン:

2024-03-01-preview

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

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

URI パラメーター

名前	/	必須	型	説明
privateEndpointConnectionName	path	True	string	指定したリソース グループを使用して Azure AI Search Serviceへのプライベート エンドポイント接続の名前。
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	PrivateEndpointConnection	プライベート エンドポイント接続が正常に切断され、検索サービスから削除されました。 応答には、プライベート エンドポイント接続の更新された定義が含まれます。
404 Not Found		サブスクリプション、リソース グループ、検索サービス、またはプライベート エンドポイント接続が見つかりませんでした。
Other Status Codes	CloudError	この操作の実行中に予期しないエラーが発生しました。

セキュリティ

azure_auth

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

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

スコープ

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

例

PrivateEndpointConnectionDelete

要求のサンプル

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python delete_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_endpoint_connections.delete(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        private_endpoint_connection_name="testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/DeletePrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/DeletePrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_Delete() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Delete(ctx, "rg1", "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armsearch.PrivateEndpointConnection{
	// 	Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 	Properties: &armsearch.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
	// 			Description: to.Ptr(""),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusDisconnected),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Disconnects the private endpoint connection and deletes it from the search service.
 *
 * @summary Disconnects the private endpoint connection and deletes it from the search service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/DeletePrivateEndpointConnection.json
 */
async function privateEndpointConnectionDelete() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.delete(
    resourceGroupName,
    searchServiceName,
    privateEndpointConnectionName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/DeletePrivateEndpointConnection.json
// this example is just showing the usage of "PrivateEndpointConnections_Delete" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchPrivateEndpointConnectionResource created on azure
// for more information of creating SearchPrivateEndpointConnectionResource, please refer to the document of SearchPrivateEndpointConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
string privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
ResourceIdentifier searchPrivateEndpointConnectionResourceId = SearchPrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName, privateEndpointConnectionName);
SearchPrivateEndpointConnectionResource searchPrivateEndpointConnection = client.GetSearchPrivateEndpointConnectionResource(searchPrivateEndpointConnectionResourceId);

// invoke the operation
ArmOperation<SearchPrivateEndpointConnectionResource> lro = await searchPrivateEndpointConnection.DeleteAsync(WaitUntil.Completed);
SearchPrivateEndpointConnectionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchPrivateEndpointConnectionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

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

状態コード:

404

定義

名前	説明
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。
PrivateEndpoint	Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
PrivateEndpointConnection	Azure AI Search Serviceへの既存のプライベート エンドポイント接続について説明します。
PrivateEndpointConnectionProperties	検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
PrivateLinkServiceConnectionProvisioningState	プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。
PrivateLinkServiceConnectionState	プライベート エンドポイントへの既存のAzure Private Link サービス接続の現在の状態について説明します。
PrivateLinkServiceConnectionStatus	プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

CloudError

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

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

CloudErrorBody

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

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

PrivateEndpoint

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

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

PrivateEndpointConnection

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	Azure AI Search Serviceへの既存のプライベート エンドポイント接続のプロパティについて説明します。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

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

PrivateLinkServiceConnectionProvisioningState

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

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

PrivateLinkServiceConnectionState

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

名前	型	規定値	説明
actionsRequired	string	None	必要になる可能性がある追加のアクションの説明。
description	string		プライベート リンク サービスの接続状態の説明。
status	PrivateLinkServiceConnectionStatus		プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

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