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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.synapse.WorkspaceVulnerabilityAssessment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages the Vulnerability Assessment for a Synapse Workspace.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageacc
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: example
      storageAccountName: ${exampleAccount.name}
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    name: example
    properties:
      name: example
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.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
    name: audit_logs
    properties:
      name: examplesa
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleWorkspaceSecurityAlertPolicy:
    type: azure:synapse:WorkspaceSecurityAlertPolicy
    name: example
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      policyState: Enabled
      storageEndpoint: ${auditLogs.primaryBlobEndpoint}
      storageAccountAccessKey: ${auditLogs.primaryAccessKey}
      disabledAlerts:
        - Sql_Injection
        - Data_Exfiltration
      retentionDays: 20
  exampleWorkspaceVulnerabilityAssessment:
    type: azure:synapse:WorkspaceVulnerabilityAssessment
    name: example
    properties:
      workspaceSecurityAlertPolicyId: ${exampleWorkspaceSecurityAlertPolicy.id}
      storageContainerPath: ${exampleAccount.primaryBlobEndpoint}${exampleContainer.name}/
      storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
      recurringScans:
        enabled: true
        emails:
          - email@example1.com
          - email@example2.com

    Create WorkspaceVulnerabilityAssessment Resource

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

    Constructor syntax

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

@overload
def WorkspaceVulnerabilityAssessment(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     storage_container_path: Optional[str] = None,
                                     workspace_security_alert_policy_id: Optional[str] = None,
                                     recurring_scans: Optional[WorkspaceVulnerabilityAssessmentRecurringScansArgs] = None,
                                     storage_account_access_key: Optional[str] = None,
                                     storage_container_sas_key: Optional[str] = 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.

    Parameters

    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.

    Constructor example

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

    var workspaceVulnerabilityAssessmentResource = new Azure.Synapse.WorkspaceVulnerabilityAssessment("workspaceVulnerabilityAssessmentResource", new()
{
    StorageContainerPath = "string",
    WorkspaceSecurityAlertPolicyId = "string",
    RecurringScans = new Azure.Synapse.Inputs.WorkspaceVulnerabilityAssessmentRecurringScansArgs
    {
        EmailSubscriptionAdminsEnabled = false,
        Emails = new[]
        {
            "string",
        },
        Enabled = false,
    },
    StorageAccountAccessKey = "string",
    StorageContainerSasKey = "string",
});

    example, err := synapse.NewWorkspaceVulnerabilityAssessment(ctx, "workspaceVulnerabilityAssessmentResource", &synapse.WorkspaceVulnerabilityAssessmentArgs{
	StorageContainerPath:           pulumi.String("string"),
	WorkspaceSecurityAlertPolicyId: pulumi.String("string"),
	RecurringScans: &synapse.WorkspaceVulnerabilityAssessmentRecurringScansArgs{
		EmailSubscriptionAdminsEnabled: pulumi.Bool(false),
		Emails: pulumi.StringArray{
			pulumi.String("string"),
		},
		Enabled: pulumi.Bool(false),
	},
	StorageAccountAccessKey: pulumi.String("string"),
	StorageContainerSasKey:  pulumi.String("string"),
})

    var workspaceVulnerabilityAssessmentResource = new WorkspaceVulnerabilityAssessment("workspaceVulnerabilityAssessmentResource", WorkspaceVulnerabilityAssessmentArgs.builder()
    .storageContainerPath("string")
    .workspaceSecurityAlertPolicyId("string")
    .recurringScans(WorkspaceVulnerabilityAssessmentRecurringScansArgs.builder()
        .emailSubscriptionAdminsEnabled(false)
        .emails("string")
        .enabled(false)
        .build())
    .storageAccountAccessKey("string")
    .storageContainerSasKey("string")
    .build());

    workspace_vulnerability_assessment_resource = azure.synapse.WorkspaceVulnerabilityAssessment("workspaceVulnerabilityAssessmentResource",
    storage_container_path="string",
    workspace_security_alert_policy_id="string",
    recurring_scans={
        "email_subscription_admins_enabled": False,
        "emails": ["string"],
        "enabled": False,
    },
    storage_account_access_key="string",
    storage_container_sas_key="string")

    const workspaceVulnerabilityAssessmentResource = new azure.synapse.WorkspaceVulnerabilityAssessment("workspaceVulnerabilityAssessmentResource", {
    storageContainerPath: "string",
    workspaceSecurityAlertPolicyId: "string",
    recurringScans: {
        emailSubscriptionAdminsEnabled: false,
        emails: ["string"],
        enabled: false,
    },
    storageAccountAccessKey: "string",
    storageContainerSasKey: "string",
});

    type: azure:synapse:WorkspaceVulnerabilityAssessment
properties:
    recurringScans:
        emailSubscriptionAdminsEnabled: false
        emails:
            - string
        enabled: false
    storageAccountAccessKey: string
    storageContainerPath: string
    storageContainerSasKey: string
    workspaceSecurityAlertPolicyId: string

    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

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

    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)
    resources:  _:    type: azure:synapse:WorkspaceVulnerabilityAssessment    get:      id: ${id}
    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 true.
    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 true.
    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 true.
    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 true.
    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 true.
    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 true.
    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

    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.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure