Private Endpoint Connections - Create Or Update
Schválení nebo odmítnutí připojení privátního koncového bodu s daným názvem
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-15
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
account
|
path | True |
string |
Název účtu databáze Cosmos DB. Vzor regulárního výrazu: |
private
|
path | True |
string |
Název připojení privátního koncového bodu. |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
Name | Typ | Description |
---|---|---|
properties.groupId |
string |
ID skupiny privátního koncového bodu. |
properties.privateEndpoint |
Privátní koncový bod, ke kterému připojení patří. |
|
properties.privateLinkServiceConnectionState |
Stav připojení privátního koncového bodu. |
|
properties.provisioningState |
string |
Stav zřizování privátního koncového bodu. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Připojení privátního koncového bodu se úspěšně schválilo nebo zamítlo. |
|
202 Accepted |
Přijata. Aktualizace připojení privátního koncového bodu se dokončí asynchronně. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | Zosobnění uživatelského účtu |
Příklady
Approve or reject a private endpoint connection with a given name.
Ukázkový požadavek
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"
}
}
}
Ukázková odpověď
{
"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"
}
}
Definice
Name | Description |
---|---|
Error |
Odpověď na chybu. |
Private |
Připojení privátního koncového bodu |
Private |
Privátní koncový bod, ke kterému připojení patří. |
Private |
Stav připojení privátního koncového bodu. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
message |
string |
Chybová zpráva s informacemi o tom, proč operace selhala. |
PrivateEndpointConnection
Připojení privátního koncového bodu
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
name |
string |
Název prostředku |
properties.groupId |
string |
ID skupiny privátního koncového bodu. |
properties.privateEndpoint |
Privátní koncový bod, ke kterému připojení patří. |
|
properties.privateLinkServiceConnectionState |
Stav připojení privátního koncového bodu. |
|
properties.provisioningState |
string |
Stav zřizování privátního koncového bodu. |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
PrivateEndpointProperty
Privátní koncový bod, ke kterému připojení patří.
Name | Typ | Description |
---|---|---|
id |
string |
ID prostředku privátního koncového bodu |
PrivateLinkServiceConnectionStateProperty
Stav připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Jakákoli akce, která se vyžaduje nad rámec základního pracovního postupu (schválení, odmítnutí nebo odpojení) |
description |
string |
Popis připojení služby Private Link. |
status |
string |
Stav připojení služby Private Link. |