Private Endpoint Connections - Delete

Referencia

Szolgáltatás:: Search Management

API-verzió:: 2023-11-01

Leválasztja a privát végpontkapcsolatot, és törli azt a keresési szolgáltatásból.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
privateEndpointConnectionName	path	True	string	A keresési szolgáltatáshoz a megadott erőforráscsoporttal létesített privát végpontkapcsolat neve.
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string	A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, a parancssori eszközökből vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Name	Típus	Description
200 OK	PrivateEndpointConnection	A privát végpont kapcsolata sikeresen le lett választva, és el lett távolítva a keresési szolgáltatásból. A válasz tartalmazza a privát végpont kapcsolatának frissített definícióját.
404 Not Found		Az előfizetés, az erőforráscsoport, a keresési szolgáltatás vagy a privát végpont kapcsolata nem található.
Other Status Codes	CloudError	Váratlan hiba történt a művelet során.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

PrivateEndpointConnectionDelete

Mintakérelem

DELETE 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


/**
 * Samples for PrivateEndpointConnections Delete.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/DeletePrivateEndpointConnection
     * .json
     */
    /**
     * Sample code: PrivateEndpointConnectionDelete.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void privateEndpointConnectionDelete(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateEndpointConnections().deleteWithResponse("rg1",
            "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", null,
            com.azure.core.util.Context.NONE);
    }
}

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

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/stable/2023-11-01/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

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

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/stable/2023-11-01/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

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 404

Definíciók

Name	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
PrivateEndpoint	A Microsoft.Network szolgáltató magánvégpont-erőforrása.
PrivateEndpointConnection	A keresési szolgáltatás meglévő privát végpontkapcsolatát ismerteti.
PrivateEndpointConnectionProperties	A keresési szolgáltatáshoz tartozó meglévő privát végpontkapcsolat tulajdonságait ismerteti.
PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos
PrivateLinkServiceConnectionState	Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
PrivateLinkServiceConnectionStatus	A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

CloudError

Objektum

Api-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

CloudErrorBody

Objektum

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Name	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

PrivateEndpoint

Objektum

A Microsoft.Network szolgáltató magánvégpont-erőforrása.

Name	Típus	Description
id	string	A Microsoft.Network szolgáltató magánvégpont-erőforrásának erőforrás-azonosítója.

PrivateEndpointConnection

Objektum

A keresési szolgáltatás meglévő privát végpontkapcsolatát ismerteti.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	PrivateEndpointConnectionProperties	A keresési szolgáltatással létesített meglévő privát végpontkapcsolat tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objektum

A keresési szolgáltatáshoz tartozó meglévő privát végpontkapcsolat tulajdonságait ismerteti.

Name	Típus	Description
groupId	string	Annak az erőforrásnak a csoportazonosítója, amelynek a magánhálózati kapcsolat szolgáltatáskapcsolata van.
privateEndpoint	PrivateEndpoint	A Microsoft.Network szolgáltató magánvégpont-erőforrása.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
provisioningState	PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos

PrivateLinkServiceConnectionProvisioningState

Enumerálás

A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos

Érték	Description
Canceled	A privát kapcsolati szolgáltatás kapcsolati erőforrásának kiépítési kérése megszakadt
Deleting	A privát kapcsolat szolgáltatáskapcsolat törlése folyamatban van.
Failed	A privát kapcsolat szolgáltatáskapcsolat kiépítése vagy törlése nem sikerült.
Incomplete	A privát kapcsolati szolgáltatás kapcsolati erőforrásának kiépítési kérése elfogadva, de a létrehozási folyamat még nem kezdődött el.
Succeeded	A privát kapcsolat szolgáltatáskapcsolata befejezte a kiépítést, és készen áll a jóváhagyásra.
Updating	A privát kapcsolat szolgáltatáskapcsolat létrehozása folyamatban van más erőforrásokkal együtt, hogy teljes mértékben működőképes legyen.

PrivateLinkServiceConnectionState

Objektum

Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.

Name	Típus	Alapértelmezett érték	Description
actionsRequired	string	None	Az esetlegesen szükséges további műveletek leírása.
description	string		A privát kapcsolati szolgáltatás kapcsolati állapotának leírása.
status	PrivateLinkServiceConnectionStatus		A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

PrivateLinkServiceConnectionStatus

Enumerálás

A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

Érték	Description
Approved	A privát végpontkapcsolat jóvá van hagyva, és használatra kész.
Disconnected	A privát végpont kapcsolata el lett távolítva a szolgáltatásból.
Pending	A privát végpontkapcsolat létrejött, és jóváhagyásra vár.
Rejected	A privát végpont kapcsolata elutasítva, és nem használható.