Share via

Microsoft.OperationalInsights workspaces/linkedServices

  • Article

Bicep resource definition

The workspaces/linkedServices 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/workspaces/linkedServices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OperationalInsights/workspaces/linkedServices@2023-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    provisioningState: 'string'
    resourceId: 'string'
    writeAccessResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

LinkedServiceProperties

Name Description Value
provisioningState The provisioning state of the linked service. 'Deleting'
'ProvisioningAccount'
'Succeeded'
'Updating'
resourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access string
writeAccessResourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access string

LinkedServiceTags

Name Description Value

Microsoft.OperationalInsights/workspaces/linkedServices

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces
properties The properties of the linked service. LinkedServiceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Log Analytics workspace with solutions and data sources Deploys a Log Analytics workspace with specified solutions and data sources

ARM template resource definition

The workspaces/linkedServices 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/workspaces/linkedServices resource, add the following JSON to your template.

{
  "type": "Microsoft.OperationalInsights/workspaces/linkedServices",
  "apiVersion": "2023-09-01",
  "name": "string",
  "properties": {
    "provisioningState": "string",
    "resourceId": "string",
    "writeAccessResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

LinkedServiceProperties

Name Description Value
provisioningState The provisioning state of the linked service. 'Deleting'
'ProvisioningAccount'
'Succeeded'
'Updating'
resourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access string
writeAccessResourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access string

LinkedServiceTags

Name Description Value

Microsoft.OperationalInsights/workspaces/linkedServices

Name Description Value
apiVersion The api version '2023-09-01'
name The resource name string (required)
properties The properties of the linked service. LinkedServiceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.OperationalInsights/workspaces/linkedServices'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure Automation account

Deploy to Azure		 This template provides an example of how create an Azure Automation account and links it to a new or existing Azure Monitor Log Analytics workspace.
Log Analytics workspace with solutions and data sources

Deploy to Azure		 Deploys a Log Analytics workspace with specified solutions and data sources

Terraform (AzAPI provider) resource definition

The workspaces/linkedServices resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationalInsights/workspaces/linkedServices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OperationalInsights/workspaces/linkedServices@2023-09-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      provisioningState = "string"
      resourceId = "string"
      writeAccessResourceId = "string"
    }
  })
}

Property values

LinkedServiceProperties

Name Description Value
provisioningState The provisioning state of the linked service. 'Deleting'
'ProvisioningAccount'
'Succeeded'
'Updating'
resourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access string
writeAccessResourceId The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access string

LinkedServiceTags

Name Description Value

Microsoft.OperationalInsights/workspaces/linkedServices

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties The properties of the linked service. LinkedServiceProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.OperationalInsights/workspaces/linkedServices@2023-09-01"