Private Link Resources - Get
Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}?api-version=2021-07-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
group
|
path | True |
string |
The name of the private link resource. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
scope
|
path | True |
string |
The name of the Azure Monitor PrivateLinkScope resource. |
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 |
Successfully retrieved a specified private link resource. |
|
Other Status Codes |
An error occurred. |
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
Gets private endpoint connection.
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor?api-version=2021-07-01-preview
Sample response
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor",
"name": "azuremonitor",
"type": "Microsoft.Insights/privateLinkScopes/privateLinkResources",
"properties": {
"groupId": "azuremonitor",
"requiredMembers": [
"api",
"global.in.ai",
"profiler",
"live",
"snapshot",
"agentsolutionpackstore",
"dce-global"
],
"requiredZoneNames": [
"privatelink.monitor.azure.com",
"privatelink.oms.opinsights.azure.com",
"privatelink.ods.opinsights.azure.com",
"privatelink.agentsvc.azure-automation.net",
"privatelink.blob.core.windows.net"
]
}
}
Definitions
Name | Description |
---|---|
Default |
Default error response |
Error |
The resource management error additional info. |
Error |
The error detail. |
Private |
A private link resource |
DefaultErrorResponse
Default error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
PrivateLinkResource
A private link resource
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.groupId |
string |
The private link resource group id. |
properties.requiredMembers |
string[] |
The private link resource required member names. |
properties.requiredZoneNames |
string[] |
The private link resource Private link DNS zone name. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |