Private Link Resources - List By Cluster

Szolgáltatás:

Cosmos DB for PostgreSQL

API-verzió:

2023-03-02-preview

Lekéri a fürt privát kapcsolati erőforrásait.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateLinkResources?api-version=2023-03-02-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
clusterName	path	True	string minLength: 3 maxLength: 40 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?	A klaszter neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	PrivateLinkResourceListResult	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	Megszemélyesíti a felhasználói fiókját

Példák

Gets the private link resources for cluster.

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/privateLinkResources?api-version=2023-03-02-preview

Java

/**
 * Samples for PrivateLinkResources ListByCluster.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/PrivateLinkResourceListByCluster.json
     */
    /**
     * Sample code: Gets the private link resources for cluster.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void getsThePrivateLinkResourcesForCluster(
        com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        manager.privateLinkResources().listByCluster("TestResourceGroup", "testcluster",
            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

Go

package armpostgresqlhsc_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresqlhsc/armpostgresqlhsc"
)

// Generated from example definition: 2023-03-02-preview/PrivateLinkResourceListByCluster.json
func ExamplePrivateLinkResourcesClient_NewListByClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlhsc.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListByClusterPager("TestResourceGroup", "testcluster", 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 = armpostgresqlhsc.PrivateLinkResourcesClientListByClusterResponse{
		// 	PrivateLinkResourceListResult: armpostgresqlhsc.PrivateLinkResourceListResult{
		// 		Value: []*armpostgresqlhsc.PrivateLinkResource{
		// 			{
		// 				Name: to.Ptr("coordinator"),
		// 				Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2/privateLinkResources"),
		// 				ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/privateLinkResources/coordinator"),
		// 				Properties: &armpostgresqlhsc.PrivateLinkResourceProperties{
		// 					GroupID: to.Ptr("coordinator"),
		// 					RequiredMembers: []*string{
		// 						to.Ptr("coordinator"),
		// 					},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.testcluster.postgres.database.azure.com"),
		// 					},
		// 				},
		// 				SystemData: &armpostgresqlhsc.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-01T17:18:19.1234567Z"); return t}()),
		// 					CreatedBy: to.Ptr("user1"),
		// 					CreatedByType: to.Ptr(armpostgresqlhsc.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-02T17:18:19.1234567Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("user2"),
		// 					LastModifiedByType: to.Ptr(armpostgresqlhsc.CreatedByTypeUser),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("worker-0"),
		// 				Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2/privateLinkResources"),
		// 				ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/privateLinkResources/worker-0"),
		// 				Properties: &armpostgresqlhsc.PrivateLinkResourceProperties{
		// 					GroupID: to.Ptr("worker-0"),
		// 					RequiredMembers: []*string{
		// 						to.Ptr("worker-0"),
		// 					},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.testcluster.postgres.database.azure.com"),
		// 					},
		// 				},
		// 				SystemData: &armpostgresqlhsc.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-01T17:18:19.1234567Z"); return t}()),
		// 					CreatedBy: to.Ptr("user1"),
		// 					CreatedByType: to.Ptr(armpostgresqlhsc.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-02T17:18:19.1234567Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("user2"),
		// 					LastModifiedByType: to.Ptr(armpostgresqlhsc.CreatedByTypeUser),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets the private link resources for cluster.
 *
 * @summary gets the private link resources for cluster.
 * x-ms-original-file: 2023-03-02-preview/PrivateLinkResourceListByCluster.json
 */
async function getsThePrivateLinkResourcesForCluster() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.privateLinkResources.listByCluster(
    "TestResourceGroup",
    "testcluster",
  )) {
    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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "name": "coordinator",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/privateLinkResources",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/privateLinkResources/coordinator",
      "properties": {
        "groupId": "coordinator",
        "requiredMembers": [
          "coordinator"
        ],
        "requiredZoneNames": [
          "privatelink.testcluster.postgres.database.azure.com"
        ]
      },
      "systemData": {
        "createdAt": "2022-01-01T17:18:19.1234567Z",
        "createdBy": "user1",
        "createdByType": "User",
        "lastModifiedAt": "2022-01-02T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User"
      }
    },
    {
      "name": "worker-0",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/privateLinkResources",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/privateLinkResources/worker-0",
      "properties": {
        "groupId": "worker-0",
        "requiredMembers": [
          "worker-0"
        ],
        "requiredZoneNames": [
          "privatelink.testcluster.postgres.database.azure.com"
        ]
      },
      "systemData": {
        "createdAt": "2022-01-01T17:18:19.1234567Z",
        "createdBy": "user1",
        "createdByType": "User",
        "lastModifiedAt": "2022-01-02T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User"
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
PrivateLinkResource	Egy privát kapcsolati erőforrás.
PrivateLinkResourceListResult	Egy PrivateLinkResource listaművelet válasza.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

PrivateLinkResource

Tárgy

Egy privát kapcsolati erőforrás.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.groupId	string	A privát kapcsolat erőforráscsoport-azonosítója.
properties.requiredMembers	string[]	A privát kapcsolat erőforrásának tagneveket kellett megadnia.
properties.requiredZoneNames	string[]	A privát kapcsolatú erőforrás privát kapcsolat DNS-zónaneve.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateLinkResourceListResult

Tárgy

Egy PrivateLinkResource listaművelet válasza.

Name	Típus	Description
nextLink	string (uri)	A következő oldalra mutató link
value	PrivateLinkResource[]	A PrivateLinkResource elemek ezen a lapon

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.