Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The privateLinkScopes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Insights/privateLinkScopes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Insights/privateLinkScopes@2023-06-01-preview' = {
location: 'string'
name: 'string'
properties: {
accessModeSettings: {
exclusions: [
{
ingestionAccessMode: 'string'
privateEndpointConnectionName: 'string'
queryAccessMode: 'string'
}
]
ingestionAccessMode: 'string'
queryAccessMode: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Insights/privateLinkScopes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AccessModeSettings
| Name | Description | Value |
|---|---|---|
| exclusions | List of exclusions that override the default access mode settings for specific private endpoint connections. | AccessModeSettingsExclusion[] |
| ingestionAccessMode | Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
| queryAccessMode | Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
AccessModeSettingsExclusion
| Name | Description | Value |
|---|---|---|
| ingestionAccessMode | Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
| privateEndpointConnectionName | The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. | string |
| queryAccessMode | Specifies the access mode of queries through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
AzureMonitorPrivateLinkScopeProperties
| Name | Description | Value |
|---|---|---|
| accessModeSettings | Access mode settings | AccessModeSettings (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Monitor Private Link Scope | AVM Resource Module for Azure Monitor Private Link Scope |
ARM template resource definition
The privateLinkScopes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Insights/privateLinkScopes resource, add the following JSON to your template.
{
"type": "Microsoft.Insights/privateLinkScopes",
"apiVersion": "2023-06-01-preview",
"name": "string",
"location": "string",
"properties": {
"accessModeSettings": {
"exclusions": [
{
"ingestionAccessMode": "string",
"privateEndpointConnectionName": "string",
"queryAccessMode": "string"
}
],
"ingestionAccessMode": "string",
"queryAccessMode": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Insights/privateLinkScopes
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-06-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Insights/privateLinkScopes' |
AccessModeSettings
| Name | Description | Value |
|---|---|---|
| exclusions | List of exclusions that override the default access mode settings for specific private endpoint connections. | AccessModeSettingsExclusion[] |
| ingestionAccessMode | Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
| queryAccessMode | Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
AccessModeSettingsExclusion
| Name | Description | Value |
|---|---|---|
| ingestionAccessMode | Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
| privateEndpointConnectionName | The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. | string |
| queryAccessMode | Specifies the access mode of queries through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
AzureMonitorPrivateLinkScopeProperties
| Name | Description | Value |
|---|---|---|
| accessModeSettings | Access mode settings | AccessModeSettings (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The privateLinkScopes resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Insights/privateLinkScopes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/privateLinkScopes@2023-06-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
accessModeSettings = {
exclusions = [
{
ingestionAccessMode = "string"
privateEndpointConnectionName = "string"
queryAccessMode = "string"
}
]
ingestionAccessMode = "string"
queryAccessMode = "string"
}
}
}
}
Property Values
Microsoft.Insights/privateLinkScopes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Insights/privateLinkScopes@2023-06-01-preview" |
AccessModeSettings
| Name | Description | Value |
|---|---|---|
| exclusions | List of exclusions that override the default access mode settings for specific private endpoint connections. | AccessModeSettingsExclusion[] |
| ingestionAccessMode | Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
| queryAccessMode | Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. | 'Open' 'PrivateOnly' (required) |
AccessModeSettingsExclusion
| Name | Description | Value |
|---|---|---|
| ingestionAccessMode | Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
| privateEndpointConnectionName | The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. | string |
| queryAccessMode | Specifies the access mode of queries through the specified private endpoint connection in the exclusion. | 'Open' 'PrivateOnly' |
AzureMonitorPrivateLinkScopeProperties
| Name | Description | Value |
|---|---|---|
| accessModeSettings | Access mode settings | AccessModeSettings (required) |
TrackedResourceTags
| Name | Description | Value |
|---|