AnalyticsWorkspace

Manages a Log Analytics (formally Operational Insights) Workspace.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "East US",
        });
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new Azure.OperationalInsights.AnalyticsWorkspaceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "PerGB2018",
            RetentionInDays = 30,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/operationalinsights"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("East US"),
        })
        if err != nil {
            return err
        }
        _, err = operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("PerGB2018"),
            RetentionInDays:   pulumi.Int(30),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="East US")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="PerGB2018",
    retention_in_days=30)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "East US"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
    retentionInDays: 30,
});

Create a AnalyticsWorkspace Resource

new AnalyticsWorkspace(name: string, args: AnalyticsWorkspaceArgs, opts?: CustomResourceOptions);

def AnalyticsWorkspace(resource_name, opts=None, location=None, name=None, resource_group_name=None, retention_in_days=None, sku=None, tags=None, __props__=None);

func NewAnalyticsWorkspace(ctx *Context, name string, args AnalyticsWorkspaceArgs, opts ...ResourceOption) (*AnalyticsWorkspace, error)

public AnalyticsWorkspace(string name, AnalyticsWorkspaceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AnalyticsWorkspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AnalyticsWorkspaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AnalyticsWorkspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

AnalyticsWorkspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The AnalyticsWorkspace resource accepts the following input properties:

ResourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
Sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
RetentionInDays int: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
Sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
RetentionInDays int: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
retentionInDays number: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
sku str: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
retention_in_days float: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the AnalyticsWorkspace resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
PortalUrl string: The Portal URL for the Log Analytics Workspace.
PrimarySharedKey string: The Primary shared key for the Log Analytics Workspace.
SecondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
WorkspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

Id string: The provider-assigned unique ID for this managed resource.
PortalUrl string: The Portal URL for the Log Analytics Workspace.
PrimarySharedKey string: The Primary shared key for the Log Analytics Workspace.
SecondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
WorkspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

id string: The provider-assigned unique ID for this managed resource.
portalUrl string: The Portal URL for the Log Analytics Workspace.
primarySharedKey string: The Primary shared key for the Log Analytics Workspace.
secondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
workspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

id str: The provider-assigned unique ID for this managed resource.
portal_url str: The Portal URL for the Log Analytics Workspace.
primary_shared_key str: The Primary shared key for the Log Analytics Workspace.
secondary_shared_key str: The Secondary shared key for the Log Analytics Workspace.
workspace_id str: The Workspace (or Customer) ID for the Log Analytics Workspace.

Look up an Existing AnalyticsWorkspace Resource

Get an existing AnalyticsWorkspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AnalyticsWorkspaceState, opts?: CustomResourceOptions): AnalyticsWorkspace

static get(resource_name, id, opts=None, location=None, name=None, portal_url=None, primary_shared_key=None, resource_group_name=None, retention_in_days=None, secondary_shared_key=None, sku=None, tags=None, workspace_id=None, __props__=None);

func GetAnalyticsWorkspace(ctx *Context, name string, id IDInput, state *AnalyticsWorkspaceState, opts ...ResourceOption) (*AnalyticsWorkspace, error)

public static AnalyticsWorkspace Get(string name, Input<string> id, AnalyticsWorkspaceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
PortalUrl string: The Portal URL for the Log Analytics Workspace.
PrimarySharedKey string: The Primary shared key for the Log Analytics Workspace.
ResourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
RetentionInDays int: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
SecondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
Sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
WorkspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
PortalUrl string: The Portal URL for the Log Analytics Workspace.
PrimarySharedKey string: The Primary shared key for the Log Analytics Workspace.
ResourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
RetentionInDays int: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
SecondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
Sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
Tags map[string]string: A mapping of tags to assign to the resource.
WorkspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
portalUrl string: The Portal URL for the Log Analytics Workspace.
primarySharedKey string: The Primary shared key for the Log Analytics Workspace.
resourceGroupName string: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retentionInDays number: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
secondarySharedKey string: The Secondary shared key for the Log Analytics Workspace.
sku string: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
tags {[key: string]: string}: A mapping of tags to assign to the resource.
workspaceId string: The Workspace (or Customer) ID for the Log Analytics Workspace.

location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or ‘-’. The ‘-’ shouldn’t be the first or the last symbol. Changing this forces a new resource to be created.
portal_url str: The Portal URL for the Log Analytics Workspace.
primary_shared_key str: The Primary shared key for the Log Analytics Workspace.
resource_group_name str: The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retention_in_days float: The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
secondary_shared_key str: The Secondary shared key for the Log Analytics Workspace.
sku str: Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).
tags Dict[str, str]: A mapping of tags to assign to the resource.
workspace_id str: The Workspace (or Customer) ID for the Log Analytics Workspace.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud