Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. WorkspaceSetting
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.security.WorkspaceSetting

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Configures where to store the OMS agent data for workspaces under a scope

Uses Azure REST API version 2017-08-01-preview. In version 2.x of the Azure Native provider, it used API version 2017-08-01-preview.

Example Usage

Create a workspace setting data for subscription

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspaceSetting = new AzureNative.Security.WorkspaceSetting("workspaceSetting", new()
    {
        Scope = "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
        WorkspaceId = "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace",
        WorkspaceSettingName = "default",
    });

});
Copy
package main

import (
	security "github.com/pulumi/pulumi-azure-native-sdk/security/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := security.NewWorkspaceSetting(ctx, "workspaceSetting", &security.WorkspaceSettingArgs{
			Scope:                pulumi.String("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23"),
			WorkspaceId:          pulumi.String("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace"),
			WorkspaceSettingName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.security.WorkspaceSetting;
import com.pulumi.azurenative.security.WorkspaceSettingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workspaceSetting = new WorkspaceSetting("workspaceSetting", WorkspaceSettingArgs.builder()
            .scope("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23")
            .workspaceId("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace")
            .workspaceSettingName("default")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceSetting = new azure_native.security.WorkspaceSetting("workspaceSetting", {
    scope: "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    workspaceId: "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace",
    workspaceSettingName: "default",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_setting = azure_native.security.WorkspaceSetting("workspaceSetting",
    scope="/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    workspace_id="/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace",
    workspace_setting_name="default")
Copy
resources:
  workspaceSetting:
    type: azure-native:security:WorkspaceSetting
    properties:
      scope: /subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23
      workspaceId: /subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace
      workspaceSettingName: default
Copy

Create WorkspaceSetting Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkspaceSetting(name: string, args: WorkspaceSettingArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceSetting(resource_name: str,
                     args: WorkspaceSettingArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceSetting(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     scope: Optional[str] = None,
                     workspace_id: Optional[str] = None,
                     workspace_setting_name: Optional[str] = None)
func NewWorkspaceSetting(ctx *Context, name string, args WorkspaceSettingArgs, opts ...ResourceOption) (*WorkspaceSetting, error)
public WorkspaceSetting(string name, WorkspaceSettingArgs args, CustomResourceOptions? opts = null)
public WorkspaceSetting(String name, WorkspaceSettingArgs args)
public WorkspaceSetting(String name, WorkspaceSettingArgs args, CustomResourceOptions options)

type: azure-native:security:WorkspaceSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceSettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceSettingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workspaceSettingResource = new AzureNative.Security.WorkspaceSetting("workspaceSettingResource", new()
{
    Scope = "string",
    WorkspaceId = "string",
    WorkspaceSettingName = "string",
});
Copy
example, err := security.NewWorkspaceSetting(ctx, "workspaceSettingResource", &security.WorkspaceSettingArgs{
	Scope:                pulumi.String("string"),
	WorkspaceId:          pulumi.String("string"),
	WorkspaceSettingName: pulumi.String("string"),
})
Copy
var workspaceSettingResource = new WorkspaceSetting("workspaceSettingResource", WorkspaceSettingArgs.builder()
    .scope("string")
    .workspaceId("string")
    .workspaceSettingName("string")
    .build());
Copy
workspace_setting_resource = azure_native.security.WorkspaceSetting("workspaceSettingResource",
    scope="string",
    workspace_id="string",
    workspace_setting_name="string")
Copy
const workspaceSettingResource = new azure_native.security.WorkspaceSetting("workspaceSettingResource", {
    scope: "string",
    workspaceId: "string",
    workspaceSettingName: "string",
});
Copy
type: azure-native:security:WorkspaceSetting
properties:
    scope: string
    workspaceId: string
    workspaceSettingName: string
Copy

WorkspaceSetting Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkspaceSetting resource accepts the following input properties:

Scope This property is required. string
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
WorkspaceId This property is required. string
The full Azure ID of the workspace to save the data in
WorkspaceSettingName Changes to this property will trigger replacement. string
Name of the security setting
Scope This property is required. string
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
WorkspaceId This property is required. string
The full Azure ID of the workspace to save the data in
WorkspaceSettingName Changes to this property will trigger replacement. string
Name of the security setting
scope This property is required. String
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
workspaceId This property is required. String
The full Azure ID of the workspace to save the data in
workspaceSettingName Changes to this property will trigger replacement. String
Name of the security setting
scope This property is required. string
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
workspaceId This property is required. string
The full Azure ID of the workspace to save the data in
workspaceSettingName Changes to this property will trigger replacement. string
Name of the security setting
scope This property is required. str
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
workspace_id This property is required. str
The full Azure ID of the workspace to save the data in
workspace_setting_name Changes to this property will trigger replacement. str
Name of the security setting
scope This property is required. String
All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
workspaceId This property is required. String
The full Azure ID of the workspace to save the data in
workspaceSettingName Changes to this property will trigger replacement. String
Name of the security setting

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
Type string
Resource type
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
Type string
Resource type
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
type String
Resource type
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name
type string
Resource type
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name
type str
Resource type
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
type String
Resource type

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:security:WorkspaceSetting default /subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings/{workspaceSettingName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native