Private Link Scopes - List By Resource Group
Gets a list of Azure Monitor PrivateLinkScopes within a resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes?api-version=2019-10-17-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
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 |
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
PrivateLinkScopeListByResourceGroup
Sample request
GET https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes?api-version=2019-10-17-preview
Sample response
{
"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-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 |
---|---|
Azure |
An Azure Monitor PrivateLinkScope definition. |
Azure |
Describes the list of Azure Monitor PrivateLinkScope resources. |
Private |
A private endpoint connection |
Private |
Private endpoint which the connection belongs to. |
Private |
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 |
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 |
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 |
Private endpoint which the connection belongs to. |
|
properties.privateLinkServiceConnectionState |
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. |