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 clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OperationalInsights/clusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.OperationalInsights/clusters@2020-03-01-preview' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
nextLink: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 4 Max length = 63 Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required) |
| properties | Log Analytics cluster properties. | ClusterProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| sku | The sku properties. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | The associated key properties. | KeyVaultProperties |
| nextLink | The link used to get the next page of recommendations. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity value | int |
| name | The name of the SKU. | 'CapacityReservation' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key associated with the Log Analytics cluster. | string |
| keyVaultUri | The Key Vault uri which holds they key associated with the Log Analytics cluster. | string |
| keyVersion | The version of the key associated with the Log Analytics cluster. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OperationalInsights/clusters resource, add the following JSON to your template.
{
"type": "Microsoft.OperationalInsights/clusters",
"apiVersion": "2020-03-01-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
},
"nextLink": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-03-01-preview' |
| identity | The identity of the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 4 Max length = 63 Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required) |
| properties | Log Analytics cluster properties. | ClusterProperties |
| sku | The sku properties. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.OperationalInsights/clusters' |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | The associated key properties. | KeyVaultProperties |
| nextLink | The link used to get the next page of recommendations. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity value | int |
| name | The name of the SKU. | 'CapacityReservation' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key associated with the Log Analytics cluster. | string |
| keyVaultUri | The Key Vault uri which holds they key associated with the Log Analytics cluster. | string |
| keyVersion | The version of the key associated with the Log Analytics cluster. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OperationalInsights/clusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.OperationalInsights/clusters@2020-03-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
nextLink = "string"
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 4 Max length = 63 Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Log Analytics cluster properties. | ClusterProperties |
| sku | The sku properties. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.OperationalInsights/clusters@2020-03-01-preview" |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | The associated key properties. | KeyVaultProperties |
| nextLink | The link used to get the next page of recommendations. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity value | int |
| name | The name of the SKU. | 'CapacityReservation' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key associated with the Log Analytics cluster. | string |
| keyVaultUri | The Key Vault uri which holds they key associated with the Log Analytics cluster. | string |
| keyVersion | The version of the key associated with the Log Analytics cluster. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying Log Analytics Cluster.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "cluster" {
type = "Microsoft.OperationalInsights/clusters@2020-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
identity {
type = "SystemAssigned"
identity_ids = []
}
body = {
sku = {
capacity = 1000
name = "CapacityReservation"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}