Private Endpoint Connection - Create Or Update
Cria uma nova Conexão de Ponto de Extremidade 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 de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
private
|
path | True |
string |
Nome da conexão de ponto de extremidade privado. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Padrão Regex: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
id |
string |
ID do recurso de conexão de ponto de extremidade privado. |
properties |
O estado de conexão da conexão de ponto de extremidade privado. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A Solicitação de Conexão de Ponto de Extremidade Privado foi concluída. |
|
202 Accepted |
Solicitação para aprovar ou rejeitar a conexão de ponto de extremidade privado. O cabeçalho location contém a URL em que o status da operação de execução prolongada pode ser verificado. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
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
ApiManagementApproveOrRejectPrivateEndpointConnection
Solicitação de exemplo
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."
}
}
}
Resposta de exemplo
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
Nome | Description |
---|---|
Error |
Contrato de Campo de Erro. |
Error |
Resposta de erro. |
Private |
O recurso ponto de extremidade privado. |
Private |
O recurso conexão de ponto de extremidade privado. |
Private |
O estado de provisionamento atual. |
Private |
Uma solicitação para aprovar ou rejeitar uma conexão de ponto de extremidade privado |
Private |
A conexão do ponto de extremidade privado status. |
Private |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
Properties |
O estado de conexão da conexão de ponto de extremidade privado. |
ErrorFieldContract
Contrato de Campo de Erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
PrivateEndpoint
O recurso ponto de extremidade privado.
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do ARM para o ponto de extremidade privado |
PrivateEndpointConnection
O recurso conexão de ponto de extremidade privado.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.privateEndpoint |
O recurso do ponto de extremidade privado. |
|
properties.privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
|
properties.provisioningState |
O estado de provisionamento do recurso de conexão de ponto de extremidade privado. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
O estado de provisionamento atual.
Nome | Tipo | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointConnectionRequest
Uma solicitação para aprovar ou rejeitar uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
id |
string |
ID do recurso de conexão de ponto de extremidade privado. |
properties |
O estado de conexão da conexão de ponto de extremidade privado. |
PrivateEndpointServiceConnectionStatus
A conexão do ponto de extremidade privado status.
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
Nome | Tipo | Description |
---|---|---|
actionsRequired |
string |
Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. |
description |
string |
O motivo da aprovação/rejeição da conexão. |
status |
Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. |
Properties
O estado de conexão da conexão de ponto de extremidade privado.
Nome | Tipo | Description |
---|---|---|
privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |