1. Packages
  2. Azure Native
  3. API Docs
  4. machinelearningservices
  5. LinkedService
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

azure-native.machinelearningservices.LinkedService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

    Linked service. Azure REST API version: 2020-09-01-preview. Prior API version in Azure Native 1.x: 2020-09-01-preview.

    Example Usage

    CreateLinkedService

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var linkedService = new AzureNative.MachineLearningServices.LinkedService("linkedService", new()
        {
            Identity = new AzureNative.MachineLearningServices.Inputs.IdentityArgs
            {
                Type = AzureNative.MachineLearningServices.ResourceIdentityType.SystemAssigned,
            },
            LinkName = "link-1",
            Location = "westus",
            Name = "link-1",
            Properties = new AzureNative.MachineLearningServices.Inputs.LinkedServicePropsArgs
            {
                LinkedServiceResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1",
            },
            ResourceGroupName = "resourceGroup-1",
            WorkspaceName = "workspace-1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/machinelearningservices/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := machinelearningservices.NewLinkedService(ctx, "linkedService", &machinelearningservices.LinkedServiceArgs{
    			Identity: &machinelearningservices.IdentityArgs{
    				Type: machinelearningservices.ResourceIdentityTypeSystemAssigned,
    			},
    			LinkName: pulumi.String("link-1"),
    			Location: pulumi.String("westus"),
    			Name:     pulumi.String("link-1"),
    			Properties: &machinelearningservices.LinkedServicePropsArgs{
    				LinkedServiceResourceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1"),
    			},
    			ResourceGroupName: pulumi.String("resourceGroup-1"),
    			WorkspaceName:     pulumi.String("workspace-1"),
    		})
    		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.azurenative.machinelearningservices.LinkedService;
    import com.pulumi.azurenative.machinelearningservices.LinkedServiceArgs;
    import com.pulumi.azurenative.machinelearningservices.inputs.IdentityArgs;
    import com.pulumi.azurenative.machinelearningservices.inputs.LinkedServicePropsArgs;
    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 linkedService = new LinkedService("linkedService", LinkedServiceArgs.builder()
                .identity(IdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .linkName("link-1")
                .location("westus")
                .name("link-1")
                .properties(LinkedServicePropsArgs.builder()
                    .linkedServiceResourceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1")
                    .build())
                .resourceGroupName("resourceGroup-1")
                .workspaceName("workspace-1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    linked_service = azure_native.machinelearningservices.LinkedService("linkedService",
        identity=azure_native.machinelearningservices.IdentityArgs(
            type=azure_native.machinelearningservices.ResourceIdentityType.SYSTEM_ASSIGNED,
        ),
        link_name="link-1",
        location="westus",
        name="link-1",
        properties=azure_native.machinelearningservices.LinkedServicePropsArgs(
            linked_service_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1",
        ),
        resource_group_name="resourceGroup-1",
        workspace_name="workspace-1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const linkedService = new azure_native.machinelearningservices.LinkedService("linkedService", {
        identity: {
            type: azure_native.machinelearningservices.ResourceIdentityType.SystemAssigned,
        },
        linkName: "link-1",
        location: "westus",
        name: "link-1",
        properties: {
            linkedServiceResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1",
        },
        resourceGroupName: "resourceGroup-1",
        workspaceName: "workspace-1",
    });
    
    resources:
      linkedService:
        type: azure-native:machinelearningservices:LinkedService
        properties:
          identity:
            type: SystemAssigned
          linkName: link-1
          location: westus
          name: link-1
          properties:
            linkedServiceResourceId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/Syn-1
          resourceGroupName: resourceGroup-1
          workspaceName: workspace-1
    

    Create LinkedService Resource

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

    Constructor syntax

    new LinkedService(name: string, args: LinkedServiceArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedService(resource_name: str,
                      args: LinkedServiceArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedService(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      identity: Optional[IdentityArgs] = None,
                      link_name: Optional[str] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      properties: Optional[LinkedServicePropsArgs] = None)
    func NewLinkedService(ctx *Context, name string, args LinkedServiceArgs, opts ...ResourceOption) (*LinkedService, error)
    public LinkedService(string name, LinkedServiceArgs args, CustomResourceOptions? opts = null)
    public LinkedService(String name, LinkedServiceArgs args)
    public LinkedService(String name, LinkedServiceArgs args, CustomResourceOptions options)
    
    type: azure-native:machinelearningservices:LinkedService
    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 LinkedServiceArgs
    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 LinkedServiceArgs
    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 LinkedServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var azure_nativeLinkedServiceResource = new AzureNative.MachineLearningServices.LinkedService("azure-nativeLinkedServiceResource", new()
    {
        ResourceGroupName = "string",
        WorkspaceName = "string",
        Identity = new AzureNative.MachineLearningServices.Inputs.IdentityArgs
        {
            Type = AzureNative.MachineLearningServices.ResourceIdentityType.SystemAssigned,
            UserAssignedIdentities = new[]
            {
                "string",
            },
        },
        LinkName = "string",
        Location = "string",
        Name = "string",
        Properties = new AzureNative.MachineLearningServices.Inputs.LinkedServicePropsArgs
        {
            LinkedServiceResourceId = "string",
            CreatedTime = "string",
            LinkType = AzureNative.MachineLearningServices.LinkedServiceLinkType.Synapse,
            ModifiedTime = "string",
        },
    });
    
    example, err := machinelearningservices.NewLinkedService(ctx, "azure-nativeLinkedServiceResource", &machinelearningservices.LinkedServiceArgs{
    ResourceGroupName: pulumi.String("string"),
    WorkspaceName: pulumi.String("string"),
    Identity: &machinelearningservices.IdentityArgs{
    Type: machinelearningservices.ResourceIdentityTypeSystemAssigned,
    UserAssignedIdentities: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    LinkName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    Properties: &machinelearningservices.LinkedServicePropsArgs{
    LinkedServiceResourceId: pulumi.String("string"),
    CreatedTime: pulumi.String("string"),
    LinkType: machinelearningservices.LinkedServiceLinkTypeSynapse,
    ModifiedTime: pulumi.String("string"),
    },
    })
    
    var azure_nativeLinkedServiceResource = new LinkedService("azure-nativeLinkedServiceResource", LinkedServiceArgs.builder()        
        .resourceGroupName("string")
        .workspaceName("string")
        .identity(IdentityArgs.builder()
            .type("SystemAssigned")
            .userAssignedIdentities("string")
            .build())
        .linkName("string")
        .location("string")
        .name("string")
        .properties(LinkedServicePropsArgs.builder()
            .linkedServiceResourceId("string")
            .createdTime("string")
            .linkType("Synapse")
            .modifiedTime("string")
            .build())
        .build());
    
    azure_native_linked_service_resource = azure_native.machinelearningservices.LinkedService("azure-nativeLinkedServiceResource",
        resource_group_name="string",
        workspace_name="string",
        identity=azure_native.machinelearningservices.IdentityArgs(
            type=azure_native.machinelearningservices.ResourceIdentityType.SYSTEM_ASSIGNED,
            user_assigned_identities=["string"],
        ),
        link_name="string",
        location="string",
        name="string",
        properties=azure_native.machinelearningservices.LinkedServicePropsArgs(
            linked_service_resource_id="string",
            created_time="string",
            link_type=azure_native.machinelearningservices.LinkedServiceLinkType.SYNAPSE,
            modified_time="string",
        ))
    
    const azure_nativeLinkedServiceResource = new azure_native.machinelearningservices.LinkedService("azure-nativeLinkedServiceResource", {
        resourceGroupName: "string",
        workspaceName: "string",
        identity: {
            type: azure_native.machinelearningservices.ResourceIdentityType.SystemAssigned,
            userAssignedIdentities: ["string"],
        },
        linkName: "string",
        location: "string",
        name: "string",
        properties: {
            linkedServiceResourceId: "string",
            createdTime: "string",
            linkType: azure_native.machinelearningservices.LinkedServiceLinkType.Synapse,
            modifiedTime: "string",
        },
    });
    
    type: azure-native:machinelearningservices:LinkedService
    properties:
        identity:
            type: SystemAssigned
            userAssignedIdentities:
                - string
        linkName: string
        location: string
        name: string
        properties:
            createdTime: string
            linkType: Synapse
            linkedServiceResourceId: string
            modifiedTime: string
        resourceGroupName: string
        workspaceName: string
    

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

    ResourceGroupName string
    Name of the resource group in which workspace is located.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    Identity Pulumi.AzureNative.MachineLearningServices.Inputs.Identity
    Identity for the resource.
    LinkName string
    Friendly name of the linked workspace
    Location string
    location of the linked service.
    Name string
    Friendly name of the linked service
    Properties Pulumi.AzureNative.MachineLearningServices.Inputs.LinkedServiceProps
    LinkedService specific properties.
    ResourceGroupName string
    Name of the resource group in which workspace is located.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    Identity IdentityArgs
    Identity for the resource.
    LinkName string
    Friendly name of the linked workspace
    Location string
    location of the linked service.
    Name string
    Friendly name of the linked service
    Properties LinkedServicePropsArgs
    LinkedService specific properties.
    resourceGroupName String
    Name of the resource group in which workspace is located.
    workspaceName String
    Name of Azure Machine Learning workspace.
    identity Identity
    Identity for the resource.
    linkName String
    Friendly name of the linked workspace
    location String
    location of the linked service.
    name String
    Friendly name of the linked service
    properties LinkedServiceProps
    LinkedService specific properties.
    resourceGroupName string
    Name of the resource group in which workspace is located.
    workspaceName string
    Name of Azure Machine Learning workspace.
    identity Identity
    Identity for the resource.
    linkName string
    Friendly name of the linked workspace
    location string
    location of the linked service.
    name string
    Friendly name of the linked service
    properties LinkedServiceProps
    LinkedService specific properties.
    resource_group_name str
    Name of the resource group in which workspace is located.
    workspace_name str
    Name of Azure Machine Learning workspace.
    identity IdentityArgs
    Identity for the resource.
    link_name str
    Friendly name of the linked workspace
    location str
    location of the linked service.
    name str
    Friendly name of the linked service
    properties LinkedServicePropsArgs
    LinkedService specific properties.
    resourceGroupName String
    Name of the resource group in which workspace is located.
    workspaceName String
    Name of Azure Machine Learning workspace.
    identity Property Map
    Identity for the resource.
    linkName String
    Friendly name of the linked workspace
    location String
    location of the linked service.
    name String
    Friendly name of the linked service
    properties Property Map
    LinkedService specific properties.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type of linked service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type of linked service.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type of linked service.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource type of linked service.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource type of linked service.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type of linked service.

    Supporting Types

    Identity, IdentityArgs

    Type Pulumi.AzureNative.MachineLearningServices.ResourceIdentityType
    The identity type.
    UserAssignedIdentities List<string>
    The user assigned identities associated with the resource.
    Type ResourceIdentityType
    The identity type.
    UserAssignedIdentities []string
    The user assigned identities associated with the resource.
    type ResourceIdentityType
    The identity type.
    userAssignedIdentities List<String>
    The user assigned identities associated with the resource.
    type ResourceIdentityType
    The identity type.
    userAssignedIdentities string[]
    The user assigned identities associated with the resource.
    type ResourceIdentityType
    The identity type.
    user_assigned_identities Sequence[str]
    The user assigned identities associated with the resource.
    type "SystemAssigned" | "SystemAssigned,UserAssigned" | "UserAssigned" | "None"
    The identity type.
    userAssignedIdentities List<String>
    The user assigned identities associated with the resource.

    IdentityResponse, IdentityResponseArgs

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityResponse>
    The user assigned identities associated with the resource.
    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The user assigned identities associated with the resource.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The user assigned identities associated with the resource.
    principalId string
    The principal ID of resource identity.
    tenantId string
    The tenant ID of resource.
    type string
    The identity type.
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The user assigned identities associated with the resource.
    principal_id str
    The principal ID of resource identity.
    tenant_id str
    The tenant ID of resource.
    type str
    The identity type.
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The user assigned identities associated with the resource.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    userAssignedIdentities Map<Property Map>
    The user assigned identities associated with the resource.

    LinkedServiceLinkType, LinkedServiceLinkTypeArgs

    Synapse
    Synapse
    LinkedServiceLinkTypeSynapse
    Synapse
    Synapse
    Synapse
    Synapse
    Synapse
    SYNAPSE
    Synapse
    "Synapse"
    Synapse

    LinkedServiceProps, LinkedServicePropsArgs

    LinkedServiceResourceId string
    ResourceId of the link target of the linked service.
    CreatedTime string
    The creation time of the linked service.
    LinkType Pulumi.AzureNative.MachineLearningServices.LinkedServiceLinkType
    Type of the link target.
    ModifiedTime string
    The last modified time of the linked service.
    LinkedServiceResourceId string
    ResourceId of the link target of the linked service.
    CreatedTime string
    The creation time of the linked service.
    LinkType LinkedServiceLinkType
    Type of the link target.
    ModifiedTime string
    The last modified time of the linked service.
    linkedServiceResourceId String
    ResourceId of the link target of the linked service.
    createdTime String
    The creation time of the linked service.
    linkType LinkedServiceLinkType
    Type of the link target.
    modifiedTime String
    The last modified time of the linked service.
    linkedServiceResourceId string
    ResourceId of the link target of the linked service.
    createdTime string
    The creation time of the linked service.
    linkType LinkedServiceLinkType
    Type of the link target.
    modifiedTime string
    The last modified time of the linked service.
    linked_service_resource_id str
    ResourceId of the link target of the linked service.
    created_time str
    The creation time of the linked service.
    link_type LinkedServiceLinkType
    Type of the link target.
    modified_time str
    The last modified time of the linked service.
    linkedServiceResourceId String
    ResourceId of the link target of the linked service.
    createdTime String
    The creation time of the linked service.
    linkType "Synapse"
    Type of the link target.
    modifiedTime String
    The last modified time of the linked service.

    LinkedServicePropsResponse, LinkedServicePropsResponseArgs

    LinkedServiceResourceId string
    ResourceId of the link target of the linked service.
    CreatedTime string
    The creation time of the linked service.
    LinkType string
    Type of the link target.
    ModifiedTime string
    The last modified time of the linked service.
    LinkedServiceResourceId string
    ResourceId of the link target of the linked service.
    CreatedTime string
    The creation time of the linked service.
    LinkType string
    Type of the link target.
    ModifiedTime string
    The last modified time of the linked service.
    linkedServiceResourceId String
    ResourceId of the link target of the linked service.
    createdTime String
    The creation time of the linked service.
    linkType String
    Type of the link target.
    modifiedTime String
    The last modified time of the linked service.
    linkedServiceResourceId string
    ResourceId of the link target of the linked service.
    createdTime string
    The creation time of the linked service.
    linkType string
    Type of the link target.
    modifiedTime string
    The last modified time of the linked service.
    linked_service_resource_id str
    ResourceId of the link target of the linked service.
    created_time str
    The creation time of the linked service.
    link_type str
    Type of the link target.
    modified_time str
    The last modified time of the linked service.
    linkedServiceResourceId String
    ResourceId of the link target of the linked service.
    createdTime String
    The creation time of the linked service.
    linkType String
    Type of the link target.
    modifiedTime String
    The last modified time of the linked service.

    ResourceIdentityType, ResourceIdentityTypeArgs

    SystemAssigned
    SystemAssigned
    SystemAssigned_UserAssigned
    SystemAssigned,UserAssigned
    UserAssigned
    UserAssigned
    None
    None
    ResourceIdentityTypeSystemAssigned
    SystemAssigned
    ResourceIdentityType_SystemAssigned_UserAssigned
    SystemAssigned,UserAssigned
    ResourceIdentityTypeUserAssigned
    UserAssigned
    ResourceIdentityTypeNone
    None
    SystemAssigned
    SystemAssigned
    SystemAssigned_UserAssigned
    SystemAssigned,UserAssigned
    UserAssigned
    UserAssigned
    None
    None
    SystemAssigned
    SystemAssigned
    SystemAssigned_UserAssigned
    SystemAssigned,UserAssigned
    UserAssigned
    UserAssigned
    None
    None
    SYSTEM_ASSIGNED
    SystemAssigned
    SYSTEM_ASSIGNED_USER_ASSIGNED
    SystemAssigned,UserAssigned
    USER_ASSIGNED
    UserAssigned
    NONE
    None
    "SystemAssigned"
    SystemAssigned
    "SystemAssigned,UserAssigned"
    SystemAssigned,UserAssigned
    "UserAssigned"
    UserAssigned
    "None"
    None

    UserAssignedIdentityResponse, UserAssignedIdentityResponseArgs

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    The tenant ID of the user assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    The tenant ID of the user assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    The tenant ID of the user assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    tenantId string
    The tenant ID of the user assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    tenant_id str
    The tenant ID of the user assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    The tenant ID of the user assigned identity.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:machinelearningservices:LinkedService link-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedServices/{linkName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi