microsoft.insights privateLinkScopes 2021-07-01-preview
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@2021-07-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
accessModeSettings: {
exclusions: [
{
ingestionAccessMode: 'string'
privateEndpointConnectionName: 'string'
queryAccessMode: 'string'
}
]
ingestionAccessMode: 'string'
queryAccessMode: 'string'
}
}
}
Property values
privateLinkScopes
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
AzureMonitorPrivateLinkScopeProperties
Name | Description | Value |
---|---|---|
accessModeSettings | Access mode settings | AccessModeSettings (required) |
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' |
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": "2021-07-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"accessModeSettings": {
"exclusions": [
{
"ingestionAccessMode": "string",
"privateEndpointConnectionName": "string",
"queryAccessMode": "string"
}
],
"ingestionAccessMode": "string",
"queryAccessMode": "string"
}
}
}
Property values
privateLinkScopes
Name | Description | Value |
---|---|---|
type | The resource type | 'microsoft.insights/privateLinkScopes' |
apiVersion | The resource api version | '2021-07-01-preview' |
name | The resource name | string (required) |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
AzureMonitorPrivateLinkScopeProperties
Name | Description | Value |
---|---|---|
accessModeSettings | Access mode settings | AccessModeSettings (required) |
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' |
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@2021-07-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
accessModeSettings = {
exclusions = [
{
ingestionAccessMode = "string"
privateEndpointConnectionName = "string"
queryAccessMode = "string"
}
]
ingestionAccessMode = "string"
queryAccessMode = "string"
}
}
})
}
Property values
privateLinkScopes
Name | Description | Value |
---|---|---|
type | The resource type | "microsoft.insights/privateLinkScopes@2021-07-01-preview" |
name | The resource name | string (required) |
location | The geo-location where the resource lives | string (required) |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. |
properties | Properties that define a Azure Monitor PrivateLinkScope resource. | AzureMonitorPrivateLinkScopeProperties (required) |
AzureMonitorPrivateLinkScopeProperties
Name | Description | Value |
---|---|---|
accessModeSettings | Access mode settings | AccessModeSettings (required) |
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" |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for