Private Endpoint Connections - Delete

Referência

Serviço:: Search Management

Versão da API:: 2025-05-01

Desconecta a conexão de ponto de extremidade privado e a exclui do serviço de pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
privateEndpointConnectionName	path	True	string	O nome da conexão de ponto de extremidade privado com o serviço Azure AI Search com o grupo de recursos especificado.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnection	A conexão de ponto de extremidade privado foi desconectada e removida com êxito do serviço de pesquisa. A resposta conterá a definição atualizada da conexão de ponto de extremidade privado.
404 Not Found		Não foi possível encontrar a assinatura, o grupo de recursos, o serviço de pesquisa ou a conexão de ponto de extremidade privado.
Other Status Codes	CloudError	Ocorreu um erro inesperado durante a operação.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

PrivateEndpointConnectionDelete

Solicitação de exemplo

HTTP

DELETE 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

Resposta de exemplo

Código de status:: 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"
    }
  }
}

Código de status:: 404

Definições

Nome	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
createdByType	O tipo de identidade que criou o recurso.
PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
PrivateEndpointConnection	Descreve uma conexão de ponto de extremidade privado existente com o serviço Azure AI Search.
PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.
PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.
PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
PrivateLinkServiceConnectionStatus	Status da conexão de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.
systemData	Metadados relativos à criação e última modificação do recurso.

CloudError

Objeto

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Objeto

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

PrivateEndpoint

Objeto

O recurso de ponto de extremidade privado do provedor Microsoft.Network.

Nome	Tipo	Description
id	string	A ID de recurso do recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnection

Objeto

Descreve uma conexão de ponto de extremidade privado existente com o serviço Azure AI Search.

Nome	Tipo	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço Azure AI Search.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objeto

Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.

Nome	Tipo	Description
groupId	string	A ID do grupo do recurso do Azure para o qual o serviço de link privado serve.
privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
provisioningState	PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.

PrivateLinkServiceConnectionProvisioningState

Enumeração

O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.

Valor	Description
Canceled	A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada.
Deleting	A conexão do serviço de link privado está em processo de exclusão.
Failed	A conexão do serviço de link privado falhou ao ser provisionada ou excluída.
Incomplete	A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi aceita, mas o processo de criação ainda não começou.
Succeeded	A conexão de serviço de link privado terminou o provisionamento e está pronta para aprovação.
Updating	A conexão de serviço de link privado está em processo de criação junto com outros recursos para que ela seja totalmente funcional.

PrivateLinkServiceConnectionState

Objeto

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.

Nome	Tipo	Valor padrão	Description
actionsRequired	string	None	Uma descrição de todas as ações extras que podem ser necessárias.
description	string		A descrição do estado de conexão do serviço de link privado.
status	PrivateLinkServiceConnectionStatus		Status da conexão de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

PrivateLinkServiceConnectionStatus

Enumeração

Status da conexão de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

Valor	Description
Approved	A conexão de ponto de extremidade privado é aprovada e está pronta para uso.
Disconnected	A conexão de ponto de extremidade privado foi removida do serviço.
Pending	A conexão de ponto de extremidade privado foi criada e está pendente de aprovação.
Rejected	A conexão de ponto de extremidade privado foi rejeitada e não pode ser usada.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Private Endpoint Connections - Delete

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

PrivateEndpointConnectionDelete

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

CloudErrorBody

createdByType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

systemData