Private Endpoint Connection - Create Or Update
Cria uma nova Ligaçã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=2022-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
private
|
path | True |
string |
Nome da ligação de ponto final privado. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Regex pattern: |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
id |
string |
ID do Recurso de Ligação de Ponto Final Privado. |
properties |
O estado de ligação da ligação do ponto final privado. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
O Pedido de Ligação de Ponto Final Privado foi concluído. |
|
202 Accepted |
Pedido para aprovar ou rejeitar a ligação de ponto final privado. O cabeçalho de localização contém o URL onde o estado da operação de execução prolongada pode ser verificado. |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ApiManagementApproveOrRejectPrivateEndpointConnection
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "The Private Endpoint Connection is approved."
}
}
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
"name": "privateEndpointConnectionName",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Succeeded",
"description": "The request has been approved."
}
}
}
Definições
Name | Description |
---|---|
Error |
Contrato de Campo de Erro. |
Error |
Resposta do Erro. |
Private |
O recurso do Ponto Final Privado. |
Private |
O recurso Ligação de Ponto Final Privado. |
Private |
O estado de aprovisionamento atual. |
Private |
Um pedido para aprovar ou rejeitar uma ligação de ponto final privado |
Private |
O estado da ligação do ponto final privado. |
Private |
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço. |
Properties |
O estado de ligação da ligação do ponto final privado. |
ErrorFieldContract
Contrato de Campo de Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro de nível de propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta do Erro.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados no pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
PrivateEndpoint
O recurso do Ponto Final Privado.
Name | Tipo | Description |
---|---|---|
id |
string |
O identificador arm para o Ponto Final Privado |
PrivateEndpointConnection
O recurso Ligação de Ponto Final Privado.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.privateEndpoint |
O recurso do ponto final privado. |
|
properties.privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço. |
|
properties.provisioningState |
O estado de aprovisionamento do recurso de ligação de ponto final privado. |
|
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
O estado de aprovisionamento atual.
Name | Tipo | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointConnectionRequest
Um pedido para aprovar ou rejeitar uma ligação de ponto final privado
Name | Tipo | Description |
---|---|---|
id |
string |
ID do Recurso de Ligação de Ponto Final Privado. |
properties |
O estado de ligação da ligação do ponto final privado. |
PrivateEndpointServiceConnectionStatus
O estado da ligação do ponto final privado.
Name | Tipo | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.
Name | Tipo | Description |
---|---|---|
actionsRequired |
string |
Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor. |
description |
string |
O motivo da aprovação/rejeição da ligação. |
status |
Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço. |
Properties
O estado de ligação da ligação do ponto final privado.
Name | Tipo | Description |
---|---|---|
privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço. |