Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. databricks
  5. AccessConnector

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.databricks.AccessConnector

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Databricks Access Connector

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccessConnector = new azure.databricks.AccessConnector("example", {
    name: "example-resource",
    resourceGroupName: example.name,
    location: example.location,
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        Environment: "Production",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_access_connector = azure.databricks.AccessConnector("example",
    name="example-resource",
    resource_group_name=example.name,
    location=example.location,
    identity={
        "type": "SystemAssigned",
    },
    tags={
        "Environment": "Production",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewAccessConnector(ctx, "example", &databricks.AccessConnectorArgs{
			Name:              pulumi.String("example-resource"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Identity: &databricks.AccessConnectorIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

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

    var exampleAccessConnector = new Azure.DataBricks.AccessConnector("example", new()
    {
        Name = "example-resource",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Identity = new Azure.DataBricks.Inputs.AccessConnectorIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Tags = 
        {
            { "Environment", "Production" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.databricks.AccessConnector;
import com.pulumi.azure.databricks.AccessConnectorArgs;
import com.pulumi.azure.databricks.inputs.AccessConnectorIdentityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccessConnector = new AccessConnector("exampleAccessConnector", AccessConnectorArgs.builder()
            .name("example-resource")
            .resourceGroupName(example.name())
            .location(example.location())
            .identity(AccessConnectorIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .tags(Map.of("Environment", "Production"))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccessConnector:
    type: azure:databricks:AccessConnector
    name: example
    properties:
      name: example-resource
      resourceGroupName: ${example.name}
      location: ${example.location}
      identity:
        type: SystemAssigned
      tags:
        Environment: Production
Copy

Create AccessConnector Resource

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

Constructor syntax

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

@overload
def AccessConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    identity: Optional[AccessConnectorIdentityArgs] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
func NewAccessConnector(ctx *Context, name string, args AccessConnectorArgs, opts ...ResourceOption) (*AccessConnector, error)
public AccessConnector(string name, AccessConnectorArgs args, CustomResourceOptions? opts = null)
public AccessConnector(String name, AccessConnectorArgs args)
public AccessConnector(String name, AccessConnectorArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccessConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AccessConnectorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AccessConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccessConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccessConnectorArgs
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 accessConnectorResource = new Azure.DataBricks.AccessConnector("accessConnectorResource", new()
{
    ResourceGroupName = "string",
    Identity = new Azure.DataBricks.Inputs.AccessConnectorIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := databricks.NewAccessConnector(ctx, "accessConnectorResource", &databricks.AccessConnectorArgs{
	ResourceGroupName: pulumi.String("string"),
	Identity: &databricks.AccessConnectorIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var accessConnectorResource = new AccessConnector("accessConnectorResource", AccessConnectorArgs.builder()
    .resourceGroupName("string")
    .identity(AccessConnectorIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
access_connector_resource = azure.databricks.AccessConnector("accessConnectorResource",
    resource_group_name="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const accessConnectorResource = new azure.databricks.AccessConnector("accessConnectorResource", {
    resourceGroupName: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:databricks:AccessConnector
properties:
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
Identity AccessConnectorIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
Identity AccessConnectorIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
identity AccessConnectorIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
identity AccessConnectorIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
identity AccessConnectorIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

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

Get an existing AccessConnector 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?: AccessConnectorState, opts?: CustomResourceOptions): AccessConnector
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        identity: Optional[AccessConnectorIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> AccessConnector
func GetAccessConnector(ctx *Context, name string, id IDInput, state *AccessConnectorState, opts ...ResourceOption) (*AccessConnector, error)
public static AccessConnector Get(string name, Input<string> id, AccessConnectorState? state, CustomResourceOptions? opts = null)
public static AccessConnector get(String name, Output<String> id, AccessConnectorState state, CustomResourceOptions options)
resources:  _:    type: azure:databricks:AccessConnector    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Identity AccessConnectorIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Identity AccessConnectorIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
identity AccessConnectorIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
identity AccessConnectorIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
identity AccessConnectorIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Access Connector resource. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the Databricks Access Connector should exist. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

AccessConnectorIdentity
, AccessConnectorIdentityArgs

Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
IdentityIds List<string>

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

PrincipalId string
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
TenantId string
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
IdentityIds []string

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

PrincipalId string
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
TenantId string
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
identityIds List<String>

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

principalId String
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
tenantId String
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
type This property is required. string
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
identityIds string[]

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

principalId string
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
tenantId string
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
type This property is required. str
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
identity_ids Sequence[str]

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

principal_id str
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
tenant_id str
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on the Databricks Access Connector. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned.
identityIds List<String>

Specifies a list of User Assigned Managed Identity IDs to be assigned to the Databricks Access Connector. Only one User Assigned Managed Identity ID is supported per Databricks Access Connector resource.

NOTE: identity_ids are required when type is set to UserAssigned.

principalId String
The Principal ID of the System Assigned Managed Service Identity that is configured on this Access Connector.
tenantId String
The Tenant ID of the System Assigned Managed Service Identity that is configured on this Access Connector.

Import

Databricks Access Connectors can be imported using the resource id, e.g.

$ pulumi import azure:databricks/accessConnector:AccessConnector connector1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Databricks/accessConnectors/connector1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure