Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. securitycenter
  5. Workspace

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.securitycenter.Workspace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages the subscription’s Security Center Workspace.

    NOTE: Owner access permission is required.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "tfex-security-workspace",
    location: "West Europe",
});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
    name: "tfex-security-workspace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "PerGB2018",
});
const exampleWorkspace = new azure.securitycenter.Workspace("example", {
    scope: "/subscriptions/00000000-0000-0000-0000-000000000000",
    workspaceId: exampleAnalyticsWorkspace.id,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="tfex-security-workspace",
    location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
    name="tfex-security-workspace",
    location=example.location,
    resource_group_name=example.name,
    sku="PerGB2018")
example_workspace = azure.securitycenter.Workspace("example",
    scope="/subscriptions/00000000-0000-0000-0000-000000000000",
    workspace_id=example_analytics_workspace.id)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/securitycenter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("tfex-security-workspace"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
			Name:              pulumi.String("tfex-security-workspace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		_, err = securitycenter.NewWorkspace(ctx, "example", &securitycenter.WorkspaceArgs{
			Scope:       pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000"),
			WorkspaceId: exampleAnalyticsWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "tfex-security-workspace",
        Location = "West Europe",
    });

    var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
    {
        Name = "tfex-security-workspace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "PerGB2018",
    });

    var exampleWorkspace = new Azure.SecurityCenter.Workspace("example", new()
    {
        Scope = "/subscriptions/00000000-0000-0000-0000-000000000000",
        WorkspaceId = exampleAnalyticsWorkspace.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.securitycenter.Workspace;
import com.pulumi.azure.securitycenter.WorkspaceArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("tfex-security-workspace")
            .location("West Europe")
            .build());

        var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
            .name("tfex-security-workspace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("PerGB2018")
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .scope("/subscriptions/00000000-0000-0000-0000-000000000000")
            .workspaceId(exampleAnalyticsWorkspace.id())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: tfex-security-workspace
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    name: example
    properties:
      name: tfex-security-workspace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: PerGB2018
  exampleWorkspace:
    type: azure:securitycenter:Workspace
    name: example
    properties:
      scope: /subscriptions/00000000-0000-0000-0000-000000000000
      workspaceId: ${exampleAnalyticsWorkspace.id}

    Create Workspace Resource

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

    Constructor syntax

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

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

    type: azure:securitycenter:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceArgs
    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 WorkspaceArgs
    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 WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    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 exampleworkspaceResourceResourceFromSecuritycenterworkspace = new Azure.SecurityCenter.Workspace("exampleworkspaceResourceResourceFromSecuritycenterworkspace", new()
{
    Scope = "string",
    WorkspaceId = "string",
});

    example, err := securitycenter.NewWorkspace(ctx, "exampleworkspaceResourceResourceFromSecuritycenterworkspace", &securitycenter.WorkspaceArgs{
	Scope:       pulumi.String("string"),
	WorkspaceId: pulumi.String("string"),
})

    var exampleworkspaceResourceResourceFromSecuritycenterworkspace = new Workspace("exampleworkspaceResourceResourceFromSecuritycenterworkspace", WorkspaceArgs.builder()
    .scope("string")
    .workspaceId("string")
    .build());

    exampleworkspace_resource_resource_from_securitycenterworkspace = azure.securitycenter.Workspace("exampleworkspaceResourceResourceFromSecuritycenterworkspace",
    scope="string",
    workspace_id="string")

    const exampleworkspaceResourceResourceFromSecuritycenterworkspace = new azure.securitycenter.Workspace("exampleworkspaceResourceResourceFromSecuritycenterworkspace", {
    scope: "string",
    workspaceId: "string",
});

    type: azure:securitycenter:Workspace
properties:
    scope: string
    workspaceId: string

    Workspace 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 Workspace resource accepts the following input properties:

    Scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    WorkspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    Scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    WorkspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    scope String
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId String
    The ID of the Log Analytics Workspace to save the data in.
    scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    scope str
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspace_id str
    The ID of the Log Analytics Workspace to save the data in.
    scope String
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId String
    The ID of the Log Analytics Workspace to save the data in.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Workspace Resource

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

    public static get(name: string, id: Input<ID>, state?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        scope: Optional[str] = None,
        workspace_id: Optional[str] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    WorkspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    Scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    WorkspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    scope String
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId String
    The ID of the Log Analytics Workspace to save the data in.
    scope string
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId string
    The ID of the Log Analytics Workspace to save the data in.
    scope str
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspace_id str
    The ID of the Log Analytics Workspace to save the data in.
    scope String
    The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
    workspaceId String
    The ID of the Log Analytics Workspace to save the data in.

    Import

    The contact can be imported using the resource id, e.g.

    $ pulumi import azure:securitycenter/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Security/workspaceSettings/default

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure