1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. operationalinsights

Module operationalinsights

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource AnalyticsSolution

class AnalyticsSolution extends CustomResource

Manages a Log Analytics (formally Operational Insights) Solution.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westeurope"});
const workspace = new random.RandomId("workspace", {
    keepers: {
        group_name: exampleResourceGroup.name,
    },
    byteLength: 8,
});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
});
const exampleAnalyticsSolution = new azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution", {
    solutionName: "ContainerInsights",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    workspaceResourceId: exampleAnalyticsWorkspace.id,
    workspaceName: exampleAnalyticsWorkspace.name,
    plan: {
        publisher: "Microsoft",
        product: "OMSGallery/ContainerInsights",
    },
});

constructor

new AnalyticsSolution(name: string, args: AnalyticsSolutionArgs, opts?: pulumi.CustomResourceOptions)

Create a AnalyticsSolution resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AnalyticsSolutionState, opts?: pulumi.CustomResourceOptions): AnalyticsSolution

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AnalyticsSolution

Returns true if the given object is an instance of AnalyticsSolution. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property plan

public plan: pulumi.Output<AnalyticsSolutionPlan>;

A plan block as documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the Log Analytics solution is created. Changing this forces a new resource to be created. Note: The solution and it’s related workspace can only exist in the same resource group.

property solutionName

public solutionName: pulumi.Output<string>;

Specifies the name of the solution to be deployed. See here for options.Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workspaceName

public workspaceName: pulumi.Output<string>;

The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

property workspaceResourceId

public workspaceResourceId: pulumi.Output<string>;

The full resource ID of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

Resource AnalyticsWorkspace

class AnalyticsWorkspace extends CustomResource

Manages a Log Analytics (formally Operational Insights) Workspace.

Example Usage

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,
});

constructor

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

Create a AnalyticsWorkspace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AnalyticsWorkspace

Returns true if the given object is an instance of AnalyticsWorkspace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<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.

property portalUrl

public portalUrl: pulumi.Output<string>;

The Portal URL for the Log Analytics Workspace.

property primarySharedKey

public primarySharedKey: pulumi.Output<string>;

The Primary shared key for the Log Analytics Workspace.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.

property retentionInDays

public retentionInDays: pulumi.Output<number>;

The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.

property secondarySharedKey

public secondarySharedKey: pulumi.Output<string>;

The Secondary shared key for the Log Analytics Workspace.

property sku

public sku: pulumi.Output<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).

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workspaceId

public workspaceId: pulumi.Output<string>;

The Workspace (or Customer) ID for the Log Analytics Workspace.

Functions

Function getAnalyticsWorkspace

getAnalyticsWorkspace(args: GetAnalyticsWorkspaceArgs, opts?: pulumi.InvokeOptions): Promise<GetAnalyticsWorkspaceResult>

Use this data source to access information about an existing Log Analytics (formally Operational Insights) Workspace.

Example Usage

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

const example = azure.operationalinsights.getAnalyticsWorkspace({
    name: "acctest-01",
    resourceGroupName: "acctest",
});
export const logAnalyticsWorkspaceId = example.then(example => example.workspaceId);

Others

interface AnalyticsSolutionArgs

interface AnalyticsSolutionArgs

The set of arguments for constructing a AnalyticsSolution resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property plan

plan: pulumi.Input<AnalyticsSolutionPlan>;

A plan block as documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the Log Analytics solution is created. Changing this forces a new resource to be created. Note: The solution and it’s related workspace can only exist in the same resource group.

property solutionName

solutionName: pulumi.Input<string>;

Specifies the name of the solution to be deployed. See here for options.Changing this forces a new resource to be created.

property workspaceName

workspaceName: pulumi.Input<string>;

The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

property workspaceResourceId

workspaceResourceId: pulumi.Input<string>;

The full resource ID of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

interface AnalyticsSolutionState

interface AnalyticsSolutionState

Input properties used for looking up and filtering AnalyticsSolution resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property plan

plan?: pulumi.Input<AnalyticsSolutionPlan>;

A plan block as documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the Log Analytics solution is created. Changing this forces a new resource to be created. Note: The solution and it’s related workspace can only exist in the same resource group.

property solutionName

solutionName?: pulumi.Input<string>;

Specifies the name of the solution to be deployed. See here for options.Changing this forces a new resource to be created.

property workspaceName

workspaceName?: pulumi.Input<string>;

The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

property workspaceResourceId

workspaceResourceId?: pulumi.Input<string>;

The full resource ID of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

interface AnalyticsWorkspaceArgs

interface AnalyticsWorkspaceArgs

The set of arguments for constructing a AnalyticsWorkspace resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.

property retentionInDays

retentionInDays?: pulumi.Input<number>;

The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.

property sku

sku: pulumi.Input<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).

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface AnalyticsWorkspaceState

interface AnalyticsWorkspaceState

Input properties used for looking up and filtering AnalyticsWorkspace resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<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.

property portalUrl

portalUrl?: pulumi.Input<string>;

The Portal URL for the Log Analytics Workspace.

property primarySharedKey

primarySharedKey?: pulumi.Input<string>;

The Primary shared key for the Log Analytics Workspace.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.

property retentionInDays

retentionInDays?: pulumi.Input<number>;

The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.

property secondarySharedKey

secondarySharedKey?: pulumi.Input<string>;

The Secondary shared key for the Log Analytics Workspace.

property sku

sku?: pulumi.Input<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).

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property workspaceId

workspaceId?: pulumi.Input<string>;

The Workspace (or Customer) ID for the Log Analytics Workspace.

interface GetAnalyticsWorkspaceArgs

interface GetAnalyticsWorkspaceArgs

A collection of arguments for invoking getAnalyticsWorkspace.

property name

name: string;

Specifies the name of the Log Analytics Workspace.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the Log Analytics workspace is located in.

interface GetAnalyticsWorkspaceResult

interface GetAnalyticsWorkspaceResult

A collection of values returned by getAnalyticsWorkspace.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

property name

name: string;

property portalUrl

portalUrl: string;

The Portal URL for the Log Analytics Workspace.

property primarySharedKey

primarySharedKey: string;

The Primary shared key for the Log Analytics Workspace.

property resourceGroupName

resourceGroupName: string;

property retentionInDays

retentionInDays: number;

The workspace data retention in days.

property secondarySharedKey

secondarySharedKey: string;

The Secondary shared key for the Log Analytics Workspace.

property sku

sku: string;

The Sku of the Log Analytics Workspace.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

property workspaceId

workspaceId: string;

The Workspace (or Customer) ID for the Log Analytics Workspace.