Private Endpoint Connections - Create Or Update
Aprovar ou rejeitar uma ligação de ponto final privado com um determinado nome.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-15
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nome da conta da base de dados do Cosmos DB. Padrão Regex: |
private
|
path | True |
string |
O 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. |
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 |
---|---|---|
properties.groupId |
string |
ID de grupo do ponto final privado. |
properties.privateEndpoint |
Ponto final privado ao qual a ligação pertence. |
|
properties.privateLinkServiceConnectionState |
Estado de Ligação da Ligação de Ponto Final Privado. |
|
properties.provisioningState |
string |
Estado de aprovisionamento do ponto final privado. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Ligação de ponto final privado aprovada ou rejeitada com êxito. |
|
202 Accepted |
Aceite. A atualização de ligação de ponto final privado será concluída de forma assíncrona. |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Representar a sua conta de utilizador |
Exemplos
Approve or reject a private endpoint connection with a given name.
Pedido de amostra
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-15
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com"
}
}
}
Resposta da amostra
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName",
"name": "privateEndpointConnectionName",
"type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-approved",
"actionsRequired": "None"
},
"groupId": "Sql",
"provisioningState": "Succeeded"
}
}
Definições
Name | Description |
---|---|
Error |
Resposta a Erros. |
Private |
Uma ligação de ponto final privado |
Private |
Ponto final privado ao qual a ligação pertence. |
Private |
Estado de Ligação da Ligação de Ponto Final Privado. |
ErrorResponse
Resposta a Erros.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
message |
string |
Mensagem de erro a indicar por que motivo a operação falhou. |
PrivateEndpointConnection
Uma 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.groupId |
string |
ID de grupo do ponto final privado. |
properties.privateEndpoint |
Ponto final privado ao qual a ligação pertence. |
|
properties.privateLinkServiceConnectionState |
Estado de Ligação da Ligação de Ponto Final Privado. |
|
properties.provisioningState |
string |
Estado de aprovisionamento do ponto final privado. |
type |
string |
O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
PrivateEndpointProperty
Ponto final privado ao qual a ligação pertence.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso do ponto final privado. |
PrivateLinkServiceConnectionStateProperty
Estado de Ligação da Ligação de Ponto Final Privado.
Name | Tipo | Description |
---|---|---|
actionsRequired |
string |
Qualquer ação necessária para além do fluxo de trabalho básico (aprovar/rejeitar/desligar) |
description |
string |
A descrição da ligação do serviço de ligação privada. |
status |
string |
O estado da ligação do serviço de ligação privada. |