Obtém os recursos de link privado que precisam ser criados para uma conta do Cosmos DB.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources?api-version=2023-11-15
Parâmetros de URI
Nome |
Em |
Obrigatório |
Tipo |
Description |
accountName
|
path |
True
|
string
|
Nome da conta de banco de dados do Cosmos DB.
Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
|
subscriptionId
|
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.
|
Respostas
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Description |
user_impersonation
|
Representar sua conta de usuário
|
Exemplos
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?api-version=2023-11-15
/**
* Samples for PrivateLinkResources ListByDatabaseAccount.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
* CosmosDBPrivateLinkResourceListGet.json
*/
/**
* Sample code: Gets private endpoint connection.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getsPrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getPrivateLinkResources().listByDatabaseAccount("rg1",
"ddb1", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-cosmosdb
# USAGE
python cosmos_db_private_link_resource_list_get.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = CosmosDBManagementClient(
credential=DefaultAzureCredential(),
subscription_id="00000000-1111-2222-3333-444444444444",
)
response = client.private_link_resources.list_by_database_account(
resource_group_name="rg1",
account_name="ddb1",
)
for item in response:
print(item)
# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcosmos_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json
func ExamplePrivateLinkResourcesClient_NewListByDatabaseAccountPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateLinkResourcesClient().NewListByDatabaseAccountPager("rg1", "ddb1", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.PrivateLinkResourceListResult = armcosmos.PrivateLinkResourceListResult{
// Value: []*armcosmos.PrivateLinkResource{
// {
// Name: to.Ptr("sql"),
// Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/privateLinkResources"),
// ID: to.Ptr("subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql"),
// Properties: &armcosmos.PrivateLinkResourceProperties{
// GroupID: to.Ptr("sql"),
// RequiredMembers: []*string{
// to.Ptr("ddb1"),
// to.Ptr("ddb1-westus")},
// RequiredZoneNames: []*string{
// to.Ptr("privatelink.documents.azure.net")},
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the private link resources that need to be created for a Cosmos DB account.
*
* @summary Gets the private link resources that need to be created for a Cosmos DB account.
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json
*/
async function getsPrivateEndpointConnection() {
const subscriptionId =
process.env["COSMOSDB_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
const accountName = "ddb1";
const credential = new DefaultAzureCredential();
const client = new CosmosDBManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.privateLinkResources.listByDatabaseAccount(
resourceGroupName,
accountName,
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"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"
]
}
}
]
}
Definições
PrivateLinkResource
Um recurso de link privado
Nome |
Tipo |
Description |
id
|
string
|
O identificador de recurso exclusivo da conta de banco de dados.
|
name
|
string
|
O nome da conta de banco de dados.
|
properties.groupId
|
string
|
A ID do grupo de recursos de link privado.
|
properties.requiredMembers
|
string[]
|
Os nomes de membro necessários do recurso de link privado.
|
properties.requiredZoneNames
|
string[]
|
Os nomes de zona necessários do recurso de link privado.
|
type
|
string
|
O tipo de recurso do Azure.
|
PrivateLinkResourceListResult
Uma lista de recursos de link privado