1. Packages
  2. Azure Classic
  3. API Docs
  4. machinelearning
  5. SynapseSpark

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.machinelearning.SynapseSpark

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages the linked service to link an Azure Machine learning workspace to an Azure Synapse workspace.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const current = azure.core.getClientConfig({});
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "west europe",
        tags: {
            stage: "example",
        },
    });
    const exampleInsights = new azure.appinsights.Insights("example", {
        name: "example-ai",
        location: example.location,
        resourceGroupName: example.name,
        applicationType: "web",
    });
    const exampleKeyVault = new azure.keyvault.KeyVault("example", {
        name: "example-kv",
        location: example.location,
        resourceGroupName: example.name,
        tenantId: current.then(current => current.tenantId),
        skuName: "standard",
        purgeProtectionEnabled: true,
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "examplesa",
        location: example.location,
        resourceGroupName: example.name,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleWorkspace = new azure.machinelearning.Workspace("example", {
        name: "example-mlw",
        location: example.location,
        resourceGroupName: example.name,
        applicationInsightsId: exampleInsights.id,
        keyVaultId: exampleKeyVault.id,
        storageAccountId: exampleAccount.id,
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
        name: "example",
        storageAccountId: exampleAccount.id,
    });
    const exampleWorkspace2 = new azure.synapse.Workspace("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
        sqlAdministratorLogin: "sqladminuser",
        sqlAdministratorLoginPassword: "H@Sh1CoR3!",
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleSparkPool = new azure.synapse.SparkPool("example", {
        name: "example",
        synapseWorkspaceId: exampleWorkspace2.id,
        nodeSizeFamily: "MemoryOptimized",
        nodeSize: "Small",
        nodeCount: 3,
    });
    const exampleSynapseSpark = new azure.machinelearning.SynapseSpark("example", {
        name: "example",
        machineLearningWorkspaceId: exampleWorkspace.id,
        location: example.location,
        synapseSparkPoolId: exampleSparkPool.id,
        identity: {
            type: "SystemAssigned",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    current = azure.core.get_client_config()
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="west europe",
        tags={
            "stage": "example",
        })
    example_insights = azure.appinsights.Insights("example",
        name="example-ai",
        location=example.location,
        resource_group_name=example.name,
        application_type="web")
    example_key_vault = azure.keyvault.KeyVault("example",
        name="example-kv",
        location=example.location,
        resource_group_name=example.name,
        tenant_id=current.tenant_id,
        sku_name="standard",
        purge_protection_enabled=True)
    example_account = azure.storage.Account("example",
        name="examplesa",
        location=example.location,
        resource_group_name=example.name,
        account_tier="Standard",
        account_replication_type="LRS")
    example_workspace = azure.machinelearning.Workspace("example",
        name="example-mlw",
        location=example.location,
        resource_group_name=example.name,
        application_insights_id=example_insights.id,
        key_vault_id=example_key_vault.id,
        storage_account_id=example_account.id,
        identity={
            "type": "SystemAssigned",
        })
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
        name="example",
        storage_account_id=example_account.id)
    example_workspace2 = azure.synapse.Workspace("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
        sql_administrator_login="sqladminuser",
        sql_administrator_login_password="H@Sh1CoR3!",
        identity={
            "type": "SystemAssigned",
        })
    example_spark_pool = azure.synapse.SparkPool("example",
        name="example",
        synapse_workspace_id=example_workspace2.id,
        node_size_family="MemoryOptimized",
        node_size="Small",
        node_count=3)
    example_synapse_spark = azure.machinelearning.SynapseSpark("example",
        name="example",
        machine_learning_workspace_id=example_workspace.id,
        location=example.location,
        synapse_spark_pool_id=example_spark_pool.id,
        identity={
            "type": "SystemAssigned",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/machinelearning"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-rg"),
    			Location: pulumi.String("west europe"),
    			Tags: pulumi.StringMap{
    				"stage": pulumi.String("example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleInsights, err := appinsights.NewInsights(ctx, "example", &appinsights.InsightsArgs{
    			Name:              pulumi.String("example-ai"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			ApplicationType:   pulumi.String("web"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
    			Name:                   pulumi.String("example-kv"),
    			Location:               example.Location,
    			ResourceGroupName:      example.Name,
    			TenantId:               pulumi.String(current.TenantId),
    			SkuName:                pulumi.String("standard"),
    			PurgeProtectionEnabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplesa"),
    			Location:               example.Location,
    			ResourceGroupName:      example.Name,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := machinelearning.NewWorkspace(ctx, "example", &machinelearning.WorkspaceArgs{
    			Name:                  pulumi.String("example-mlw"),
    			Location:              example.Location,
    			ResourceGroupName:     example.Name,
    			ApplicationInsightsId: exampleInsights.ID(),
    			KeyVaultId:            exampleKeyVault.ID(),
    			StorageAccountId:      exampleAccount.ID(),
    			Identity: &machinelearning.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
    			Name:             pulumi.String("example"),
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspace2, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
    			Name:                            pulumi.String("example"),
    			ResourceGroupName:               example.Name,
    			Location:                        example.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSparkPool, err := synapse.NewSparkPool(ctx, "example", &synapse.SparkPoolArgs{
    			Name:               pulumi.String("example"),
    			SynapseWorkspaceId: exampleWorkspace2.ID(),
    			NodeSizeFamily:     pulumi.String("MemoryOptimized"),
    			NodeSize:           pulumi.String("Small"),
    			NodeCount:          pulumi.Int(3),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = machinelearning.NewSynapseSpark(ctx, "example", &machinelearning.SynapseSparkArgs{
    			Name:                       pulumi.String("example"),
    			MachineLearningWorkspaceId: exampleWorkspace.ID(),
    			Location:                   example.Location,
    			SynapseSparkPoolId:         exampleSparkPool.ID(),
    			Identity: &machinelearning.SynapseSparkIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		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 current = Azure.Core.GetClientConfig.Invoke();
    
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-rg",
            Location = "west europe",
            Tags = 
            {
                { "stage", "example" },
            },
        });
    
        var exampleInsights = new Azure.AppInsights.Insights("example", new()
        {
            Name = "example-ai",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ApplicationType = "web",
        });
    
        var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
        {
            Name = "example-kv",
            Location = example.Location,
            ResourceGroupName = example.Name,
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            SkuName = "standard",
            PurgeProtectionEnabled = true,
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplesa",
            Location = example.Location,
            ResourceGroupName = example.Name,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleWorkspace = new Azure.MachineLearning.Workspace("example", new()
        {
            Name = "example-mlw",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ApplicationInsightsId = exampleInsights.Id,
            KeyVaultId = exampleKeyVault.Id,
            StorageAccountId = exampleAccount.Id,
            Identity = new Azure.MachineLearning.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
        {
            Name = "example",
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace2 = new Azure.Synapse.Workspace("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleSparkPool = new Azure.Synapse.SparkPool("example", new()
        {
            Name = "example",
            SynapseWorkspaceId = exampleWorkspace2.Id,
            NodeSizeFamily = "MemoryOptimized",
            NodeSize = "Small",
            NodeCount = 3,
        });
    
        var exampleSynapseSpark = new Azure.MachineLearning.SynapseSpark("example", new()
        {
            Name = "example",
            MachineLearningWorkspaceId = exampleWorkspace.Id,
            Location = example.Location,
            SynapseSparkPoolId = exampleSparkPool.Id,
            Identity = new Azure.MachineLearning.Inputs.SynapseSparkIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appinsights.Insights;
    import com.pulumi.azure.appinsights.InsightsArgs;
    import com.pulumi.azure.keyvault.KeyVault;
    import com.pulumi.azure.keyvault.KeyVaultArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.machinelearning.Workspace;
    import com.pulumi.azure.machinelearning.WorkspaceArgs;
    import com.pulumi.azure.machinelearning.inputs.WorkspaceIdentityArgs;
    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.WorkspaceIdentityArgs;
    import com.pulumi.azure.synapse.SparkPool;
    import com.pulumi.azure.synapse.SparkPoolArgs;
    import com.pulumi.azure.machinelearning.SynapseSpark;
    import com.pulumi.azure.machinelearning.SynapseSparkArgs;
    import com.pulumi.azure.machinelearning.inputs.SynapseSparkIdentityArgs;
    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) {
            final var current = CoreFunctions.getClientConfig();
    
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-rg")
                .location("west europe")
                .tags(Map.of("stage", "example"))
                .build());
    
            var exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()
                .name("example-ai")
                .location(example.location())
                .resourceGroupName(example.name())
                .applicationType("web")
                .build());
    
            var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
                .name("example-kv")
                .location(example.location())
                .resourceGroupName(example.name())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .skuName("standard")
                .purgeProtectionEnabled(true)
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("examplesa")
                .location(example.location())
                .resourceGroupName(example.name())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
                .name("example-mlw")
                .location(example.location())
                .resourceGroupName(example.name())
                .applicationInsightsId(exampleInsights.id())
                .keyVaultId(exampleKeyVault.id())
                .storageAccountId(exampleAccount.id())
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
                .name("example")
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace2 = new Workspace("exampleWorkspace2", WorkspaceArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleSparkPool = new SparkPool("exampleSparkPool", SparkPoolArgs.builder()
                .name("example")
                .synapseWorkspaceId(exampleWorkspace2.id())
                .nodeSizeFamily("MemoryOptimized")
                .nodeSize("Small")
                .nodeCount(3)
                .build());
    
            var exampleSynapseSpark = new SynapseSpark("exampleSynapseSpark", SynapseSparkArgs.builder()
                .name("example")
                .machineLearningWorkspaceId(exampleWorkspace.id())
                .location(example.location())
                .synapseSparkPoolId(exampleSparkPool.id())
                .identity(SynapseSparkIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: west europe
          tags:
            stage: example
      exampleInsights:
        type: azure:appinsights:Insights
        name: example
        properties:
          name: example-ai
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationType: web
      exampleKeyVault:
        type: azure:keyvault:KeyVault
        name: example
        properties:
          name: example-kv
          location: ${example.location}
          resourceGroupName: ${example.name}
          tenantId: ${current.tenantId}
          skuName: standard
          purgeProtectionEnabled: true
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplesa
          location: ${example.location}
          resourceGroupName: ${example.name}
          accountTier: Standard
          accountReplicationType: LRS
      exampleWorkspace:
        type: azure:machinelearning:Workspace
        name: example
        properties:
          name: example-mlw
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationInsightsId: ${exampleInsights.id}
          keyVaultId: ${exampleKeyVault.id}
          storageAccountId: ${exampleAccount.id}
          identity:
            type: SystemAssigned
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        name: example
        properties:
          name: example
          storageAccountId: ${exampleAccount.id}
      exampleWorkspace2:
        type: azure:synapse:Workspace
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          identity:
            type: SystemAssigned
      exampleSparkPool:
        type: azure:synapse:SparkPool
        name: example
        properties:
          name: example
          synapseWorkspaceId: ${exampleWorkspace2.id}
          nodeSizeFamily: MemoryOptimized
          nodeSize: Small
          nodeCount: 3
      exampleSynapseSpark:
        type: azure:machinelearning:SynapseSpark
        name: example
        properties:
          name: example
          machineLearningWorkspaceId: ${exampleWorkspace.id}
          location: ${example.location}
          synapseSparkPoolId: ${exampleSparkPool.id}
          identity:
            type: SystemAssigned
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create SynapseSpark Resource

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

    Constructor syntax

    new SynapseSpark(name: string, args: SynapseSparkArgs, opts?: CustomResourceOptions);
    @overload
    def SynapseSpark(resource_name: str,
                     args: SynapseSparkArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def SynapseSpark(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     machine_learning_workspace_id: Optional[str] = None,
                     synapse_spark_pool_id: Optional[str] = None,
                     description: Optional[str] = None,
                     identity: Optional[SynapseSparkIdentityArgs] = None,
                     local_auth_enabled: Optional[bool] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewSynapseSpark(ctx *Context, name string, args SynapseSparkArgs, opts ...ResourceOption) (*SynapseSpark, error)
    public SynapseSpark(string name, SynapseSparkArgs args, CustomResourceOptions? opts = null)
    public SynapseSpark(String name, SynapseSparkArgs args)
    public SynapseSpark(String name, SynapseSparkArgs args, CustomResourceOptions options)
    
    type: azure:machinelearning:SynapseSpark
    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 SynapseSparkArgs
    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 SynapseSparkArgs
    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 SynapseSparkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynapseSparkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SynapseSparkArgs
    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 synapseSparkResource = new Azure.MachineLearning.SynapseSpark("synapseSparkResource", new()
    {
        MachineLearningWorkspaceId = "string",
        SynapseSparkPoolId = "string",
        Description = "string",
        Identity = new Azure.MachineLearning.Inputs.SynapseSparkIdentityArgs
        {
            Type = "string",
            IdentityIds = new[]
            {
                "string",
            },
            PrincipalId = "string",
            TenantId = "string",
        },
        LocalAuthEnabled = false,
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := machinelearning.NewSynapseSpark(ctx, "synapseSparkResource", &machinelearning.SynapseSparkArgs{
    	MachineLearningWorkspaceId: pulumi.String("string"),
    	SynapseSparkPoolId:         pulumi.String("string"),
    	Description:                pulumi.String("string"),
    	Identity: &machinelearning.SynapseSparkIdentityArgs{
    		Type: pulumi.String("string"),
    		IdentityIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrincipalId: pulumi.String("string"),
    		TenantId:    pulumi.String("string"),
    	},
    	LocalAuthEnabled: pulumi.Bool(false),
    	Location:         pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var synapseSparkResource = new SynapseSpark("synapseSparkResource", SynapseSparkArgs.builder()
        .machineLearningWorkspaceId("string")
        .synapseSparkPoolId("string")
        .description("string")
        .identity(SynapseSparkIdentityArgs.builder()
            .type("string")
            .identityIds("string")
            .principalId("string")
            .tenantId("string")
            .build())
        .localAuthEnabled(false)
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    synapse_spark_resource = azure.machinelearning.SynapseSpark("synapseSparkResource",
        machine_learning_workspace_id="string",
        synapse_spark_pool_id="string",
        description="string",
        identity={
            "type": "string",
            "identity_ids": ["string"],
            "principal_id": "string",
            "tenant_id": "string",
        },
        local_auth_enabled=False,
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const synapseSparkResource = new azure.machinelearning.SynapseSpark("synapseSparkResource", {
        machineLearningWorkspaceId: "string",
        synapseSparkPoolId: "string",
        description: "string",
        identity: {
            type: "string",
            identityIds: ["string"],
            principalId: "string",
            tenantId: "string",
        },
        localAuthEnabled: false,
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:machinelearning:SynapseSpark
    properties:
        description: string
        identity:
            identityIds:
                - string
            principalId: string
            tenantId: string
            type: string
        localAuthEnabled: false
        location: string
        machineLearningWorkspaceId: string
        name: string
        synapseSparkPoolId: string
        tags:
            string: string
    

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

    MachineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    SynapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    Description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    Location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    Name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    MachineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    SynapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    Description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Identity SynapseSparkIdentityArgs
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    Location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    Name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId String
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    description String
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location String
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    name String
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    machine_learning_workspace_id str
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapse_spark_pool_id str
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    description str
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentityArgs
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    local_auth_enabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location str
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    name str
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId String
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    description String
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity Property Map
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location String
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    name String
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.

    Outputs

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

    Get an existing SynapseSpark 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?: SynapseSparkState, opts?: CustomResourceOptions): SynapseSpark
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            identity: Optional[SynapseSparkIdentityArgs] = None,
            local_auth_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            machine_learning_workspace_id: Optional[str] = None,
            name: Optional[str] = None,
            synapse_spark_pool_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> SynapseSpark
    func GetSynapseSpark(ctx *Context, name string, id IDInput, state *SynapseSparkState, opts ...ResourceOption) (*SynapseSpark, error)
    public static SynapseSpark Get(string name, Input<string> id, SynapseSparkState? state, CustomResourceOptions? opts = null)
    public static SynapseSpark get(String name, Output<String> id, SynapseSparkState 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:
    Description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    Location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    MachineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    Name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    SynapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    Identity SynapseSparkIdentityArgs
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    Location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    MachineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    Name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    SynapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    description String
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location String
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    name String
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId String
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    description string
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentity
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location string
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    name string
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId string
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    description str
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity SynapseSparkIdentityArgs
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    local_auth_enabled bool
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location str
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    machine_learning_workspace_id str
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    name str
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapse_spark_pool_id str
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    description String
    The description of the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    identity Property Map
    An identity block as defined below. Changing this forces a new Machine Learning Synapse Spark to be created.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled. Defaults to true. Changing this forces a new Machine Learning Synapse Spark to be created.
    location String
    The Azure Region where the Machine Learning Synapse Spark should exist. Changing this forces a new Machine Learning Synapse Spark to be created.
    machineLearningWorkspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning Synapse Spark to be created.
    name String
    The name which should be used for this Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.
    synapseSparkPoolId String
    The ID of the linked Synapse Spark Pool. Changing this forces a new Machine Learning Synapse Spark to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Machine Learning Synapse Spark. Changing this forces a new Machine Learning Synapse Spark to be created.

    Supporting Types

    SynapseSparkIdentity, SynapseSparkIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    TenantId string
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    TenantId string
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    tenantId String
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    tenantId string
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    tenant_id str
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Machine Learning Synapse Spark. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Machine Learning Synapse Spark. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.
    tenantId String
    The Tenant ID for the Service Principal associated with the Managed Service Identity of this Machine Learning Synapse Spark.

    Import

    Machine Learning Synapse Sparks can be imported using the resource id, e.g.

    $ pulumi import azure:machinelearning/synapseSpark:SynapseSpark example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.MachineLearningServices/workspaces/workspace1/computes/compute1
    

    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