1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. security
  6. WorkspaceSetting
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi

    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",
        });
    
    });
    
    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
    	})
    }
    
    pulumi {
      required_providers {
        azure-native = {
          source = "pulumi/azure-native"
        }
      }
    }
    
    resource "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"
    }
    
    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.ArrayList;
    import java.util.Arrays;
    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());
    
        }
    }
    
    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",
    });
    
    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")
    
    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
    

    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.
    
    
    resource "azure-native_security_workspace_setting" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args WorkspaceSettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    example, err := security.NewWorkspaceSetting(ctx, "workspaceSettingResource", &security.WorkspaceSettingArgs{
    	Scope:                pulumi.String("string"),
    	WorkspaceId:          pulumi.String("string"),
    	WorkspaceSettingName: pulumi.String("string"),
    })
    
    resource "azure-native_security_workspace_setting" "workspaceSettingResource" {
      lifecycle {
        create_before_destroy = true
      }
      scope                  = "string"
      workspace_id           = "string"
      workspace_setting_name = "string"
    }
    
    var workspaceSettingResource = new WorkspaceSetting("workspaceSettingResource", WorkspaceSettingArgs.builder()
        .scope("string")
        .workspaceId("string")
        .workspaceSettingName("string")
        .build());
    
    workspace_setting_resource = azure_native.security.WorkspaceSetting("workspaceSettingResource",
        scope="string",
        workspace_id="string",
        workspace_setting_name="string")
    
    const workspaceSettingResource = new azure_native.security.WorkspaceSetting("workspaceSettingResource", {
        scope: "string",
        workspaceId: "string",
        workspaceSettingName: "string",
    });
    
    type: azure-native:security:WorkspaceSetting
    properties:
        scope: string
        workspaceId: string
        workspaceSettingName: string
    

    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 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 string
    The full Azure ID of the workspace to save the data in
    WorkspaceSettingName string
    Name of the security setting
    Scope 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 string
    The full Azure ID of the workspace to save the data in
    WorkspaceSettingName string
    Name of the security setting
    scope 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
    workspace_id string
    The full Azure ID of the workspace to save the data in
    workspace_setting_name string
    Name of the security setting
    scope 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 String
    The full Azure ID of the workspace to save the data in
    workspaceSettingName String
    Name of the security setting
    scope 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 string
    The full Azure ID of the workspace to save the data in
    workspaceSettingName string
    Name of the security setting
    scope 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 str
    The full Azure ID of the workspace to save the data in
    workspace_setting_name str
    Name of the security setting
    scope 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 String
    The full Azure ID of the workspace to save the data in
    workspaceSettingName 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
    The name of the resource
    SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.26.0
    published on Thursday, Aug 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial