Private Endpoint Connection - Create Or Update

Serviço:: API Management

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

Cria uma nova Conexão de Ponto Final Privado ou atualiza uma existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
privateEndpointConnectionName	path	True	string	Nome da conexão de ponto de extremidade privado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
id	string	ID do recurso de conexão de ponto de extremidade privado.
properties	Properties	O estado da conexão da conexão de ponto de extremidade privado.

Respostas

Name	Tipo	Description
200 OK	PrivateEndpointConnection	A Solicitação de Conexão de Ponto Final Privado foi concluída.
202 Accepted		Solicitação para aprovar ou rejeitar conexão de ponto de extremidade privado. O cabeçalho de localização contém o URL onde o status da operação de longa duração pode ser verificado. Cabeçalhos location: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

PrivateEndpointConnection

A Solicitação de Conexão de Ponto Final Privado foi concluída.

202 Accepted

Solicitação para aprovar ou rejeitar conexão de ponto de extremidade privado. O cabeçalho de localização contém o URL onde o status da operação de longa duração pode ser verificado.

Cabeçalhos

location: string

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementApproveOrRejectPrivateEndpointConnection

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "The Private Endpoint Connection is approved."
    }
  }
}

Resposta da amostra

Código de estado:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Código de estado:: 200

{
  "name": "privateEndpointConnectionName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
  "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Succeeded",
      "description": "The request has been approved."
    }
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PrivateEndpoint	O recurso Ponto Final Privado.
PrivateEndpointConnection	O recurso Private Endpoint Connection.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointConnectionRequest	Uma solicitação para aprovar ou rejeitar uma conexão de ponto de extremidade privada
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
Properties	O estado da conexão da conexão de ponto de extremidade privado.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.