Microsoft.Security workspaceSettings

• Latest
• 2017-08-01-preview

Bicep resource definition

The workspaceSettings resource type can be deployed with operations that target:

• Subscription - See subscription deployment commands

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

Resource format

To create a Microsoft.Security/workspaceSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/workspaceSettings@2017-08-01-preview' = {
  name: 'string'
  properties: {
    scope: 'string'
    workspaceId: 'string'
  }
}

Property Values

Microsoft.Security/workspaceSettings

Name	Description	Value
name	The resource name	string (required)
properties	Workspace setting data	WorkspaceSettingProperties

WorkspaceSettingProperties

Name	Description	Value
scope	All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope	string (required)
workspaceId	The full Azure ID of the workspace to save the data in	string (required)

ARM template resource definition

The workspaceSettings resource type can be deployed with operations that target:

• Subscription - See subscription deployment commands

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

Resource format

To create a Microsoft.Security/workspaceSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/workspaceSettings",
  "apiVersion": "2017-08-01-preview",
  "name": "string",
  "properties": {
    "scope": "string",
    "workspaceId": "string"
  }
}

Property Values

Microsoft.Security/workspaceSettings

Name	Description	Value
apiVersion	The api version	'2017-08-01-preview'
name	The resource name	string (required)
properties	Workspace setting data	WorkspaceSettingProperties
type	The resource type	'Microsoft.Security/workspaceSettings'

WorkspaceSettingProperties

Name	Description	Value
scope	All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope	string (required)
workspaceId	The full Azure ID of the workspace to save the data in	string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaceSettings resource type can be deployed with operations that target:

• Subscription

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

Resource format

To create a Microsoft.Security/workspaceSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/workspaceSettings@2017-08-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      scope = "string"
      workspaceId = "string"
    }
  }
}

Property Values

Microsoft.Security/workspaceSettings

Name	Description	Value
name	The resource name	string (required)
properties	Workspace setting data	WorkspaceSettingProperties
type	The resource type	"Microsoft.Security/workspaceSettings@2017-08-01-preview"

WorkspaceSettingProperties

Name	Description	Value
scope	All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope	string (required)
workspaceId	The full Azure ID of the workspace to save the data in	string (required)