Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. WorkspaceVulnerabilityAssessment

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

azure.synapse.WorkspaceVulnerabilityAssessment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

    Manages the Vulnerability Assessment for a Synapse Workspace.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        AccountKind = "StorageV2",
        IsHnsEnabled = true,
    });

    var exampleContainer = new Azure.Storage.Container("exampleContainer", new()
    {
        StorageAccountName = exampleAccount.Name,
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
    {
        StorageAccountId = exampleAccount.Id,
    });

    var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
        SqlAdministratorLogin = "sqladminuser",
        SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        AadAdmin = new Azure.Synapse.Inputs.WorkspaceAadAdminArgs
        {
            Login = "AzureAD Admin",
            ObjectId = "00000000-0000-0000-0000-000000000000",
            TenantId = "00000000-0000-0000-0000-000000000000",
        },
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Tags = 
        {
            { "Env", "production" },
        },
    });

    var auditLogs = new Azure.Storage.Account("auditLogs", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleWorkspaceSecurityAlertPolicy = new Azure.Synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy", new()
    {
        SynapseWorkspaceId = exampleWorkspace.Id,
        PolicyState = "Enabled",
        StorageEndpoint = auditLogs.PrimaryBlobEndpoint,
        StorageAccountAccessKey = auditLogs.PrimaryAccessKey,
        DisabledAlerts = new[]
        {
            "Sql_Injection",
            "Data_Exfiltration",
        },
        RetentionDays = 20,
    });

    var exampleWorkspaceVulnerabilityAssessment = new Azure.Synapse.WorkspaceVulnerabilityAssessment("exampleWorkspaceVulnerabilityAssessment", new()
    {
        WorkspaceSecurityAlertPolicyId = exampleWorkspaceSecurityAlertPolicy.Id,
        StorageContainerPath = Output.Tuple(exampleAccount.PrimaryBlobEndpoint, exampleContainer.Name).Apply(values =>
        {
            var primaryBlobEndpoint = values.Item1;
            var name = values.Item2;
            return $"{primaryBlobEndpoint}{name}/";
        }),
        StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
        RecurringScans = new Azure.Synapse.Inputs.WorkspaceVulnerabilityAssessmentRecurringScansArgs
        {
            Enabled = true,
            EmailSubscriptionAdminsEnabled = true,
            Emails = new[]
            {
                "email@example1.com",
                "email@example2.com",
            },
        },
    });

});

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleContainer, err := storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
			StorageAccountName: exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
			ResourceGroupName:               exampleResourceGroup.Name,
			Location:                        exampleResourceGroup.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			AadAdmin: &synapse.WorkspaceAadAdminTypeArgs{
				Login:    pulumi.String("AzureAD Admin"),
				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		auditLogs, err := storage.NewAccount(ctx, "auditLogs", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleWorkspaceSecurityAlertPolicy, err := synapse.NewWorkspaceSecurityAlertPolicy(ctx, "exampleWorkspaceSecurityAlertPolicy", &synapse.WorkspaceSecurityAlertPolicyArgs{
			SynapseWorkspaceId:      exampleWorkspace.ID(),
			PolicyState:             pulumi.String("Enabled"),
			StorageEndpoint:         auditLogs.PrimaryBlobEndpoint,
			StorageAccountAccessKey: auditLogs.PrimaryAccessKey,
			DisabledAlerts: pulumi.StringArray{
				pulumi.String("Sql_Injection"),
				pulumi.String("Data_Exfiltration"),
			},
			RetentionDays: pulumi.Int(20),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspaceVulnerabilityAssessment(ctx, "exampleWorkspaceVulnerabilityAssessment", &synapse.WorkspaceVulnerabilityAssessmentArgs{
			WorkspaceSecurityAlertPolicyId: exampleWorkspaceSecurityAlertPolicy.ID(),
			StorageContainerPath: pulumi.All(exampleAccount.PrimaryBlobEndpoint, exampleContainer.Name).ApplyT(func(_args []interface{}) (string, error) {
				primaryBlobEndpoint := _args[0].(string)
				name := _args[1].(string)
				return fmt.Sprintf("%v%v/", primaryBlobEndpoint, name), nil
			}).(pulumi.StringOutput),
			StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
			RecurringScans: &synapse.WorkspaceVulnerabilityAssessmentRecurringScansArgs{
				Enabled:                        pulumi.Bool(true),
				EmailSubscriptionAdminsEnabled: pulumi.Bool(true),
				Emails: pulumi.StringArray{
					pulumi.String("email@example1.com"),
					pulumi.String("email@example2.com"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceAadAdminArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.WorkspaceSecurityAlertPolicy;
import com.pulumi.azure.synapse.WorkspaceSecurityAlertPolicyArgs;
import com.pulumi.azure.synapse.WorkspaceVulnerabilityAssessment;
import com.pulumi.azure.synapse.WorkspaceVulnerabilityAssessmentArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceVulnerabilityAssessmentRecurringScansArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .accountKind("StorageV2")
            .isHnsEnabled("true")
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()        
            .storageAccountName(exampleAccount.name())
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
            .storageAccountId(exampleAccount.id())
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
            .sqlAdministratorLogin("sqladminuser")
            .sqlAdministratorLoginPassword("H@Sh1CoR3!")
            .aadAdmin(WorkspaceAadAdminArgs.builder()
                .login("AzureAD Admin")
                .objectId("00000000-0000-0000-0000-000000000000")
                .tenantId("00000000-0000-0000-0000-000000000000")
                .build())
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .tags(Map.of("Env", "production"))
            .build());

        var auditLogs = new Account("auditLogs", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleWorkspaceSecurityAlertPolicy = new WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy", WorkspaceSecurityAlertPolicyArgs.builder()        
            .synapseWorkspaceId(exampleWorkspace.id())
            .policyState("Enabled")
            .storageEndpoint(auditLogs.primaryBlobEndpoint())
            .storageAccountAccessKey(auditLogs.primaryAccessKey())
            .disabledAlerts(            
                "Sql_Injection",
                "Data_Exfiltration")
            .retentionDays(20)
            .build());

        var exampleWorkspaceVulnerabilityAssessment = new WorkspaceVulnerabilityAssessment("exampleWorkspaceVulnerabilityAssessment", WorkspaceVulnerabilityAssessmentArgs.builder()        
            .workspaceSecurityAlertPolicyId(exampleWorkspaceSecurityAlertPolicy.id())
            .storageContainerPath(Output.tuple(exampleAccount.primaryBlobEndpoint(), exampleContainer.name()).applyValue(values -> {
                var primaryBlobEndpoint = values.t1;
                var name = values.t2;
                return String.format("%s%s/", primaryBlobEndpoint,name);
            }))
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .recurringScans(WorkspaceVulnerabilityAssessmentRecurringScansArgs.builder()
                .enabled(true)
                .emailSubscriptionAdminsEnabled(true)
                .emails(                
                    "email@example1.com",
                    "email@example2.com")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_container = azure.storage.Container("exampleContainer", storage_account_name=example_account.name)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("exampleWorkspace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!",
    aad_admin=azure.synapse.WorkspaceAadAdminArgs(
        login="AzureAD Admin",
        object_id="00000000-0000-0000-0000-000000000000",
        tenant_id="00000000-0000-0000-0000-000000000000",
    ),
    identity=azure.synapse.WorkspaceIdentityArgs(
        type="SystemAssigned",
    ),
    tags={
        "Env": "production",
    })
audit_logs = azure.storage.Account("auditLogs",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_workspace_security_alert_policy = azure.synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy",
    synapse_workspace_id=example_workspace.id,
    policy_state="Enabled",
    storage_endpoint=audit_logs.primary_blob_endpoint,
    storage_account_access_key=audit_logs.primary_access_key,
    disabled_alerts=[
        "Sql_Injection",
        "Data_Exfiltration",
    ],
    retention_days=20)
example_workspace_vulnerability_assessment = azure.synapse.WorkspaceVulnerabilityAssessment("exampleWorkspaceVulnerabilityAssessment",
    workspace_security_alert_policy_id=example_workspace_security_alert_policy.id,
    storage_container_path=pulumi.Output.all(example_account.primary_blob_endpoint, example_container.name).apply(lambda primary_blob_endpoint, name: f"{primary_blob_endpoint}{name}/"),
    storage_account_access_key=example_account.primary_access_key,
    recurring_scans=azure.synapse.WorkspaceVulnerabilityAssessmentRecurringScansArgs(
        enabled=True,
        email_subscription_admins_enabled=True,
        emails=[
            "email@example1.com",
            "email@example2.com",
        ],
    ))

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: true,
});
const exampleContainer = new azure.storage.Container("exampleContainer", {storageAccountName: exampleAccount.name});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
    aadAdmin: {
        login: "AzureAD Admin",
        objectId: "00000000-0000-0000-0000-000000000000",
        tenantId: "00000000-0000-0000-0000-000000000000",
    },
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        Env: "production",
    },
});
const auditLogs = new azure.storage.Account("auditLogs", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleWorkspaceSecurityAlertPolicy = new azure.synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy", {
    synapseWorkspaceId: exampleWorkspace.id,
    policyState: "Enabled",
    storageEndpoint: auditLogs.primaryBlobEndpoint,
    storageAccountAccessKey: auditLogs.primaryAccessKey,
    disabledAlerts: [
        "Sql_Injection",
        "Data_Exfiltration",
    ],
    retentionDays: 20,
});
const exampleWorkspaceVulnerabilityAssessment = new azure.synapse.WorkspaceVulnerabilityAssessment("exampleWorkspaceVulnerabilityAssessment", {
    workspaceSecurityAlertPolicyId: exampleWorkspaceSecurityAlertPolicy.id,
    storageContainerPath: pulumi.interpolate`${exampleAccount.primaryBlobEndpoint}${exampleContainer.name}/`,
    storageAccountAccessKey: exampleAccount.primaryAccessKey,
    recurringScans: {
        enabled: true,
        emailSubscriptionAdminsEnabled: true,
        emails: [
            "email@example1.com",
            "email@example2.com",
        ],
    },
});

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleContainer:
    type: azure:storage:Container
    properties:
      storageAccountName: ${exampleAccount.name}
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    properties:
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      aadAdmin:
        login: AzureAD Admin
        objectId: 00000000-0000-0000-0000-000000000000
        tenantId: 00000000-0000-0000-0000-000000000000
      identity:
        type: SystemAssigned
      tags:
        Env: production
  auditLogs:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleWorkspaceSecurityAlertPolicy:
    type: azure:synapse:WorkspaceSecurityAlertPolicy
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      policyState: Enabled
      storageEndpoint: ${auditLogs.primaryBlobEndpoint}
      storageAccountAccessKey: ${auditLogs.primaryAccessKey}
      disabledAlerts:
        - Sql_Injection
        - Data_Exfiltration
      retentionDays: 20
  exampleWorkspaceVulnerabilityAssessment:
    type: azure:synapse:WorkspaceVulnerabilityAssessment
    properties:
      workspaceSecurityAlertPolicyId: ${exampleWorkspaceSecurityAlertPolicy.id}
      storageContainerPath: ${exampleAccount.primaryBlobEndpoint}${exampleContainer.name}/
      storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
      recurringScans:
        enabled: true
        emailSubscriptionAdminsEnabled: true
        emails:
          - email@example1.com
          - email@example2.com

    Create WorkspaceVulnerabilityAssessment Resource

    new WorkspaceVulnerabilityAssessment(name: string, args: WorkspaceVulnerabilityAssessmentArgs, opts?: CustomResourceOptions);
    @overload
def WorkspaceVulnerabilityAssessment(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     recurring_scans: Optional[WorkspaceVulnerabilityAssessmentRecurringScansArgs] = None,
                                     storage_account_access_key: Optional[str] = None,
                                     storage_container_path: Optional[str] = None,
                                     storage_container_sas_key: Optional[str] = None,
                                     workspace_security_alert_policy_id: Optional[str] = None)
@overload
def WorkspaceVulnerabilityAssessment(resource_name: str,
                                     args: WorkspaceVulnerabilityAssessmentArgs,
                                     opts: Optional[ResourceOptions] = None)
    func NewWorkspaceVulnerabilityAssessment(ctx *Context, name string, args WorkspaceVulnerabilityAssessmentArgs, opts ...ResourceOption) (*WorkspaceVulnerabilityAssessment, error)
    public WorkspaceVulnerabilityAssessment(string name, WorkspaceVulnerabilityAssessmentArgs args, CustomResourceOptions? opts = null)
    public WorkspaceVulnerabilityAssessment(String name, WorkspaceVulnerabilityAssessmentArgs args)
public WorkspaceVulnerabilityAssessment(String name, WorkspaceVulnerabilityAssessmentArgs args, CustomResourceOptions options)

    type: azure:synapse:WorkspaceVulnerabilityAssessment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceVulnerabilityAssessmentArgs
    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 WorkspaceVulnerabilityAssessmentArgs
    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 WorkspaceVulnerabilityAssessmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceVulnerabilityAssessmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceVulnerabilityAssessmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WorkspaceVulnerabilityAssessment Resource Properties

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

    Inputs

    The WorkspaceVulnerabilityAssessment resource accepts the following input properties:

    StorageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    WorkspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    RecurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    StorageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    StorageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    StorageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    WorkspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    RecurringScans WorkspaceVulnerabilityAssessmentRecurringScansArgs

    The recurring scans settings. The recurring_scans block supports fields documented below.

    StorageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    StorageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    storageContainerPath String

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    workspaceSecurityAlertPolicyId String

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey String

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerSasKey String

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    storageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    workspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    storage_container_path str

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    workspace_security_alert_policy_id str

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurring_scans WorkspaceVulnerabilityAssessmentRecurringScansArgs

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storage_account_access_key str

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storage_container_sas_key str

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    storageContainerPath String

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    workspaceSecurityAlertPolicyId String

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans Property Map

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey String

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerSasKey String

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspaceVulnerabilityAssessment 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 WorkspaceVulnerabilityAssessment Resource

    Get an existing WorkspaceVulnerabilityAssessment 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?: WorkspaceVulnerabilityAssessmentState, opts?: CustomResourceOptions): WorkspaceVulnerabilityAssessment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        recurring_scans: Optional[WorkspaceVulnerabilityAssessmentRecurringScansArgs] = None,
        storage_account_access_key: Optional[str] = None,
        storage_container_path: Optional[str] = None,
        storage_container_sas_key: Optional[str] = None,
        workspace_security_alert_policy_id: Optional[str] = None) -> WorkspaceVulnerabilityAssessment
    func GetWorkspaceVulnerabilityAssessment(ctx *Context, name string, id IDInput, state *WorkspaceVulnerabilityAssessmentState, opts ...ResourceOption) (*WorkspaceVulnerabilityAssessment, error)
    public static WorkspaceVulnerabilityAssessment Get(string name, Input<string> id, WorkspaceVulnerabilityAssessmentState? state, CustomResourceOptions? opts = null)
    public static WorkspaceVulnerabilityAssessment get(String name, Output<String> id, WorkspaceVulnerabilityAssessmentState 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:
    RecurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    StorageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    StorageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    StorageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    WorkspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    RecurringScans WorkspaceVulnerabilityAssessmentRecurringScansArgs

    The recurring scans settings. The recurring_scans block supports fields documented below.

    StorageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    StorageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    StorageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    WorkspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey String

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerPath String

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    storageContainerSasKey String

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    workspaceSecurityAlertPolicyId String

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans WorkspaceVulnerabilityAssessmentRecurringScans

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey string

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerPath string

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    storageContainerSasKey string

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    workspaceSecurityAlertPolicyId string

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurring_scans WorkspaceVulnerabilityAssessmentRecurringScansArgs

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storage_account_access_key str

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storage_container_path str

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    storage_container_sas_key str

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    workspace_security_alert_policy_id str

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    recurringScans Property Map

    The recurring scans settings. The recurring_scans block supports fields documented below.

    storageAccountAccessKey String

    Specifies the identifier key of the storage account for vulnerability assessment scan results. If storage_container_sas_key isn't specified, storage_account_access_key is required.

    storageContainerPath String

    A blob storage container path to hold the scan results (e.g. https://example.blob.core.windows.net/VaScans/).

    storageContainerSasKey String

    A shared access signature (SAS Key) that has write access to the blob container specified in storage_container_path parameter. If storage_account_access_key isn't specified, storage_container_sas_key is required.

    workspaceSecurityAlertPolicyId String

    The ID of the security alert policy of the Synapse Workspace. Changing this forces a new resource to be created.

    Supporting Types

    WorkspaceVulnerabilityAssessmentRecurringScans, WorkspaceVulnerabilityAssessmentRecurringScansArgs

    EmailSubscriptionAdminsEnabled bool

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    Emails List<string>

    Specifies an array of email addresses to which the scan notification is sent.

    Enabled bool

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    EmailSubscriptionAdminsEnabled bool

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    Emails []string

    Specifies an array of email addresses to which the scan notification is sent.

    Enabled bool

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    emailSubscriptionAdminsEnabled Boolean

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    emails List<String>

    Specifies an array of email addresses to which the scan notification is sent.

    enabled Boolean

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    emailSubscriptionAdminsEnabled boolean

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    emails string[]

    Specifies an array of email addresses to which the scan notification is sent.

    enabled boolean

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    email_subscription_admins_enabled bool

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    emails Sequence[str]

    Specifies an array of email addresses to which the scan notification is sent.

    enabled bool

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    emailSubscriptionAdminsEnabled Boolean

    Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

    emails List<String>

    Specifies an array of email addresses to which the scan notification is sent.

    enabled Boolean

    Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

    Import

    Synapse Workspace Vulnerability Assessment can be imported using the resource id, e.g.

     $ pulumi import azure:synapse/workspaceVulnerabilityAssessment:WorkspaceVulnerabilityAssessment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/vulnerabilityAssessments/default

    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 Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
    pulumi/pulumi-azure