Private Endpoint Connections - List By Private Link Scope

リファレンス

Service:: Monitor

API Version:: 2019-10-17-preview

プライベートリンクスコープ上のすべてのプライベートエンドポイント接続を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections?api-version=2019-10-17-preview

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
scopeName	path	True	string	Azure Monitor PrivateLinkScope リソースの名前。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	PrivateEndpointConnectionListResult	プライベートエンドポイント接続が正常に取得されました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Gets list of private endpoint connections on a private link scope.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections?api-version=2019-10-17-preview

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateEndpointConnectionList.json
func ExamplePrivateEndpointConnectionsClient_NewListByPrivateLinkScopePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByPrivateLinkScopePager("MyResourceGroup",
		"MyPrivateLinkScope",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

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

/**
 * This sample demonstrates how to Gets all private endpoint connections on a private link scope.
 *
 * @summary Gets all private endpoint connections on a private link scope.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateEndpointConnectionList.json
 */
async function getsListOfPrivateEndpointConnectionsOnAPrivateLinkScope() {
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = "MyResourceGroup";
  const scopeName = "MyPrivateLinkScope";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateEndpointConnections.listByPrivateLinkScope(
    resourceGroupName,
    scopeName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

getsListOfPrivateEndpointConnectionsOnAPrivateLinkScope().catch(console.error);

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

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name",
      "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-approved",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name-2",
      "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Pending",
          "description": "Please approve my connection.",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

定義

名前	説明
PrivateEndpointConnection	プライベートエンドポイント接続
PrivateEndpointConnectionListResult	プライベートエンドポイント接続の一覧。
PrivateEndpointProperty	接続が属するプライベートエンドポイント。
PrivateLinkServiceConnectionStateProperty	プライベートエンドポイント接続の状態。

PrivateEndpointConnection

プライベートエンドポイント接続

名前	型	説明
id	string	Azure リソース ID
name	string	Azure リソース名
properties.privateEndpoint	PrivateEndpointProperty	接続が属するプライベートエンドポイント。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	プライベートエンドポイント接続の接続状態。
properties.provisioningState	string	プライベートエンドポイント接続の状態。
type	string	Azure リソースタイプ

PrivateEndpointConnectionListResult

プライベートエンドポイント接続の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	PrivateEndpointConnection[]	結果の配列。

PrivateEndpointProperty

接続が属するプライベートエンドポイント。

名前	型	説明
id	string	プライベートエンドポイントのリソース ID。

PrivateLinkServiceConnectionStateProperty

プライベートエンドポイント接続の状態。

名前	型	説明
actionsRequired	string	プライベートリンクサービス接続に必要なアクション。
description	string	プライベートリンクサービスの接続の説明。
status	string	プライベートリンクサービスの接続状態。

次の方法で共有