Log Analytics Workspace

Overview

{
	"log_analytics": {
		"name": "log-workspace-{env}",
		"sku": "PerGB2018",

		"keyvault": {
			"@key_vault_name": "kv-example-{env}",
			"secrets": {
				"workspace_id": "nameOfSecret",
				"workspace_key": "nameOfSecret"
			}
		},
		"location": "northeurope",
		"external": false,
		"resource_group_name": "my-rg-name",
		"tags": { "example": "S0" }
	}
}

Log Analytics Workspace Reference

KeyTypeDescription
name (required)stringThe name of the Log Analytics Workspace (see how to name)
sku (required)LogAnalytics Sku DefinitionSku of the Log Analytics Workspace
keyvaultKeyVaultSettingsThe keyvault integration configuration
locationstringResource Location (defaults to the resource group location)
externalboolA reference to an existing Log Analytics Workspace (defaults to false)
resource_group_namestringThe name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tagsobjectAdditional tags for the resource (defaults to no additional tags)

LogAnalyticsSku

ValueDescription
PerGB2018Data Ingested (Pay-as-you-go), most commonly used
CapacityReservationCommitment tier
LAClusterDedicated clusters require customers to commit for at least 500 GB of data ingestion per day
FreeLegacy trial tier
StandardLegacy Standard
StandaloneLegacy per GB
PremiumLegacy Premium
PerNodeLegacy tier for use if you own OMS Licenses

KeyVaultSettings

KeyTypeDescription
@key_vault_name (required)stringThe name of the Key Vault to bind to
secretsSecretsThe secret to insert

Secrets

KeyTypeDescription
workspace_id (required)stringThe name of the secret holding the Workspace ID
workspace_key (required)stringThe name of the secret holding the Workspace key