operationalinsights

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.operationalinsights.AnalyticsSolution(resource_name, opts=None, location=None, plan=None, resource_group_name=None, solution_name=None, workspace_name=None, workspace_resource_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Log Analytics (formally Operational Insights) Solution.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • plan (pulumi.Input[dict]) – A plan block as documented below.

  • resource_group_name (pulumi.Input[str]) – 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.

  • solution_name (pulumi.Input[str]) – Specifies the name of the solution to be deployed. See here for options.Changing this forces a new resource to be created.

  • workspace_name (pulumi.Input[str]) – The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

  • workspace_resource_id (pulumi.Input[str]) – 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.

The plan object supports the following:

  • name (pulumi.Input[str])

  • product (pulumi.Input[str])

  • promotionCode (pulumi.Input[str])

  • publisher (pulumi.Input[str])

location = None

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

plan = None

A plan block as documented below.

  • name (str)

  • product (str)

  • promotionCode (str)

  • publisher (str)

resource_group_name = None

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.

solution_name = None

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

workspace_name = None

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

workspace_resource_id = None

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.

static get(resource_name, id, opts=None, location=None, plan=None, resource_group_name=None, solution_name=None, workspace_name=None, workspace_resource_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • plan (pulumi.Input[dict]) – A plan block as documented below.

  • resource_group_name (pulumi.Input[str]) – 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.

  • solution_name (pulumi.Input[str]) –

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

  • workspace_name (pulumi.Input[str]) – The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.

  • workspace_resource_id (pulumi.Input[str]) – 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.

The plan object supports the following:

  • name (pulumi.Input[str])

  • product (pulumi.Input[str])

  • promotionCode (pulumi.Input[str])

  • publisher (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.operationalinsights.AnalyticsWorkspace(resource_name, opts=None, location=None, name=None, resource_group_name=None, retention_in_days=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages a Log Analytics (formally Operational Insights) Workspace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[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.

  • resource_group_name (pulumi.Input[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 (pulumi.Input[float]) – The workspace data retention in days. Possible values range between 30 and 730.

  • sku (pulumi.Input[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 (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

location = None

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

name = None

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 = None

The Portal URL for the Log Analytics Workspace.

primary_shared_key = None

The Primary shared key for the Log Analytics Workspace.

resource_group_name = None

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 = None

The workspace data retention in days. Possible values range between 30 and 730.

secondary_shared_key = None

The Secondary shared key for the Log Analytics Workspace.

sku = None

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 = None

A mapping of tags to assign to the resource.

workspace_id = None

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

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)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[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 (pulumi.Input[str]) – The Portal URL for the Log Analytics Workspace.

  • primary_shared_key (pulumi.Input[str]) – The Primary shared key for the Log Analytics Workspace.

  • resource_group_name (pulumi.Input[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 (pulumi.Input[float]) – The workspace data retention in days. Possible values range between 30 and 730.

  • secondary_shared_key (pulumi.Input[str]) – The Secondary shared key for the Log Analytics Workspace.

  • sku (pulumi.Input[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 (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • workspace_id (pulumi.Input[str]) – The Workspace (or Customer) ID for the Log Analytics Workspace.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.operationalinsights.AnalyticsWorkspaceLinkedService(resource_name, opts=None, linked_service_name=None, linked_service_properties=None, resource_group_name=None, resource_id=None, tags=None, workspace_name=None, __props__=None, __name__=None, __opts__=None)

Links a Log Analytics (formally Operational Insights) Workspace to another resource. The (currently) only linkable service is an Azure Automation Account.

NOTE: This resource has been deprecated in favour of the loganalytics.LinkedService resource and will be removed in the next major version of the AzureRM Provider. The new resource shares the same fields as this one, and information on migrating across can be found in this guide.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • linked_service_name (pulumi.Input[str]) – Name of the type of linkedServices resource to connect to the Log Analytics Workspace specified in workspace_name. Currently it defaults to and only supports automation as a value. Changing this forces a new resource to be created.

  • linked_service_properties (pulumi.Input[list]) – A linked_service_properties block as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Log Analytics Linked Service is created. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • workspace_name (pulumi.Input[str]) – Name of the Log Analytics Workspace that will contain the linkedServices resource. Changing this forces a new resource to be created.

The linked_service_properties object supports the following:

  • resource_id (pulumi.Input[str]) - The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

linked_service_name = None

Name of the type of linkedServices resource to connect to the Log Analytics Workspace specified in workspace_name. Currently it defaults to and only supports automation as a value. Changing this forces a new resource to be created.

linked_service_properties = None

A linked_service_properties block as defined below.

  • resource_id (str) - The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

name = None

The automatically generated name of the Linked Service. This cannot be specified. The format is always <workspace_name>/<linked_service_name> e.g. workspace1/Automation

resource_group_name = None

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

resource_id = None

The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

tags = None

A mapping of tags to assign to the resource.

workspace_name = None

Name of the Log Analytics Workspace that will contain the linkedServices resource. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, linked_service_name=None, linked_service_properties=None, name=None, resource_group_name=None, resource_id=None, tags=None, workspace_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • linked_service_name (pulumi.Input[str]) – Name of the type of linkedServices resource to connect to the Log Analytics Workspace specified in workspace_name. Currently it defaults to and only supports automation as a value. Changing this forces a new resource to be created.

  • linked_service_properties (pulumi.Input[list]) – A linked_service_properties block as defined below.

  • name (pulumi.Input[str]) – The automatically generated name of the Linked Service. This cannot be specified. The format is always <workspace_name>/<linked_service_name> e.g. workspace1/Automation

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Log Analytics Linked Service is created. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • workspace_name (pulumi.Input[str]) – Name of the Log Analytics Workspace that will contain the linkedServices resource. Changing this forces a new resource to be created.

The linked_service_properties object supports the following:

  • resource_id (pulumi.Input[str]) - The resource id of the resource that will be linked to the workspace. This field has been deprecated in favour of the top-level resource_id field and will be removed in v2.0 of the AzureRM Provider.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.operationalinsights.AwaitableGetAnalyticsWorkspaceResult(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, id=None)
class pulumi_azure.operationalinsights.GetAnalyticsWorkspaceResult(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, id=None)

A collection of values returned by getAnalyticsWorkspace.

portal_url = None

The Portal URL for the Log Analytics Workspace.

primary_shared_key = None

The Primary shared key for the Log Analytics Workspace.

retention_in_days = None

The workspace data retention in days.

secondary_shared_key = None

The Secondary shared key for the Log Analytics Workspace.

sku = None

The Sku of the Log Analytics Workspace.

tags = None

A mapping of tags assigned to the resource.

workspace_id = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

pulumi_azure.operationalinsights.get_analytics_workspace(name=None, resource_group_name=None, opts=None)

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

Parameters
  • name (str) – Specifies the name of the Log Analytics Workspace.

  • resource_group_name (str) – The name of the resource group in which the Log Analytics workspace is located in.