Private Link Resources - Get

Pobiera prywatne zasoby łączy, które muszą zostać utworzone dla konta Cosmos DB.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}?api-version=2021-03-15

Parametry identyfikatora URI

Name In Required Type Description
accountName
path True
  • string

Nazwa konta bazy danych Cosmos DB.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

groupName
path True
  • string

Nazwa zasobu łącza prywatnego.

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Name Type Description
200 OK

Pomyślnie pobrano określony zasób linku prywatnego.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Gets private endpoint connection.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/privateLinkResources/sql?api-version=2021-03-15

Sample Response

{
  "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql",
  "name": "sql",
  "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources",
  "properties": {
    "groupId": "sql",
    "requiredMembers": [
      "ddb1",
      "ddb1-westus"
    ],
    "requiredZoneNames": [
      "privatelink.documents.azure.net"
    ]
  }
}

Definicje

PrivateLinkResource

Zasób link prywatny

Name Type Description
id
  • string

Unikatowy identyfikator zasobu konta bazy danych.

name
  • string

Nazwa konta bazy danych.

properties.groupId
  • string

Identyfikator grupy zasobów link prywatny.

properties.requiredMembers
  • string[]

Wymagane są nazwy członków prywatnego linku.

properties.requiredZoneNames
  • string[]

Nazwy stref wymaganych przez zasób link prywatny.

type
  • string

Typ zasobu platformy Azure.