Private Link Scopes - List

Service:

Monitor

API Version:

2019-10-17-preview

Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.insights/privateLinkScopes?api-version=2019-10-17-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AzureMonitorPrivateLinkScopeListResult	A list containing 0 or more Azure Monitor PrivateLinkScope definitions.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PrivateLinkScopesList.json

Sample request

HTTP

GET https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/providers/microsoft.insights/privateLinkScopes?api-version=2019-10-17-preview

Go

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/PrivateLinkScopesList.json
func ExamplePrivateLinkScopesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewPrivateLinkScopesClient("86dc51d3-92ed-4d7e-947a-775ea79b4919", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(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

JavaScript

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

/**
 * This sample demonstrates how to Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.
 *
 * @summary Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateLinkScopesList.json
 */
async function privateLinkScopesListJson() {
  const subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4919";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateLinkScopes.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

privateLinkScopesListJson().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/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
      "name": "my-privatelinkscope",
      "type": "Microsoft.Insights/privateLinkScopes",
      "location": "Global",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-other-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope",
      "name": "my-other-privatelinkscope",
      "type": "Microsoft.Insights/privateLinkScopes",
      "location": "Global",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
AzureMonitorPrivateLinkScope	An Azure Monitor PrivateLinkScope definition.
AzureMonitorPrivateLinkScopeListResult	Describes the list of Azure Monitor PrivateLinkScope resources.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	State of the private endpoint connection.

AzureMonitorPrivateLinkScope

An Azure Monitor PrivateLinkScope definition.

Name	Type	Description
id	string	Azure resource Id
location	string	Resource location
name	string	Azure resource name
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections.
properties.provisioningState	string	Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.
tags	object	Resource tags
type	string	Azure resource type

AzureMonitorPrivateLinkScopeListResult

Describes the list of Azure Monitor PrivateLinkScope resources.

Name	Type	Description
nextLink	string	The URI to get the next set of Azure Monitor PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set.
value	AzureMonitorPrivateLinkScope[]	List of Azure Monitor PrivateLinkScope definitions.

PrivateEndpointConnection

A private endpoint connection

Name	Type	Description
id	string	Azure resource Id
name	string	Azure resource name
properties.privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
properties.provisioningState	string	State of the private endpoint connection.
type	string	Azure resource type

PrivateEndpointProperty

Private endpoint which the connection belongs to.

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

State of the private endpoint connection.

Name	Type	Description
actionsRequired	string	The actions required for private link service connection.
description	string	The private link service connection description.
status	string	The private link service connection status.