Azure Active Directory (Azure AD) v6.4.0, Apr 7 25

Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi

azuread.SynchronizationJob

Explore with Pulumi AI

Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi

API Permissions

The following API permissions are required in order to use this resource.

When authenticated with a service principal, this resource requires one of the following application roles: Application.ReadWrite.All or Directory.ReadWrite.All

Example Usage

Basic example

TypeScript
Python
Go
C#
Java
YAML

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

const example = azuread.getApplicationTemplate({
    displayName: "Azure Databricks SCIM Provisioning Connector",
});
const exampleApplicationFromTemplate = new azuread.ApplicationFromTemplate("example", {
    displayName: "example",
    templateId: example.then(example => example.templateId),
});
const exampleGetServicePrincipal = azuread.getServicePrincipalOutput({
    objectId: exampleApplicationFromTemplate.servicePrincipalObjectId,
});
const exampleSynchronizationSecret = new azuread.SynchronizationSecret("example", {
    servicePrincipalId: exampleGetServicePrincipal.apply(exampleGetServicePrincipal => exampleGetServicePrincipal.id),
    credentials: [
        {
            key: "BaseAddress",
            value: "https://adb-example.azuredatabricks.net/api/2.0/preview/scim",
        },
        {
            key: "SecretToken",
            value: "some-token",
        },
    ],
});
const exampleSynchronizationJob = new azuread.SynchronizationJob("example", {
    servicePrincipalId: exampleGetServicePrincipal.apply(exampleGetServicePrincipal => exampleGetServicePrincipal.id),
    templateId: "dataBricks",
    enabled: true,
});

import pulumi
import pulumi_azuread as azuread

example = azuread.get_application_template(display_name="Azure Databricks SCIM Provisioning Connector")
example_application_from_template = azuread.ApplicationFromTemplate("example",
    display_name="example",
    template_id=example.template_id)
example_get_service_principal = azuread.get_service_principal_output(object_id=example_application_from_template.service_principal_object_id)
example_synchronization_secret = azuread.SynchronizationSecret("example",
    service_principal_id=example_get_service_principal.id,
    credentials=[
        {
            "key": "BaseAddress",
            "value": "https://adb-example.azuredatabricks.net/api/2.0/preview/scim",
        },
        {
            "key": "SecretToken",
            "value": "some-token",
        },
    ])
example_synchronization_job = azuread.SynchronizationJob("example",
    service_principal_id=example_get_service_principal.id,
    template_id="dataBricks",
    enabled=True)

package main

import (
	"github.com/pulumi/pulumi-azuread/sdk/v6/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Azure Databricks SCIM Provisioning Connector"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplicationFromTemplate, err := azuread.NewApplicationFromTemplate(ctx, "example", &azuread.ApplicationFromTemplateArgs{
			DisplayName: pulumi.String("example"),
			TemplateId:  pulumi.String(example.TemplateId),
		})
		if err != nil {
			return err
		}
		exampleGetServicePrincipal := azuread.LookupServicePrincipalOutput(ctx, azuread.GetServicePrincipalOutputArgs{
			ObjectId: exampleApplicationFromTemplate.ServicePrincipalObjectId,
		}, nil)
		_, err = azuread.NewSynchronizationSecret(ctx, "example", &azuread.SynchronizationSecretArgs{
			ServicePrincipalId: pulumi.String(exampleGetServicePrincipal.ApplyT(func(exampleGetServicePrincipal azuread.GetServicePrincipalResult) (*string, error) {
				return &exampleGetServicePrincipal.Id, nil
			}).(pulumi.StringPtrOutput)),
			Credentials: azuread.SynchronizationSecretCredentialArray{
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("BaseAddress"),
					Value: pulumi.String("https://adb-example.azuredatabricks.net/api/2.0/preview/scim"),
				},
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("SecretToken"),
					Value: pulumi.String("some-token"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewSynchronizationJob(ctx, "example", &azuread.SynchronizationJobArgs{
			ServicePrincipalId: pulumi.String(exampleGetServicePrincipal.ApplyT(func(exampleGetServicePrincipal azuread.GetServicePrincipalResult) (*string, error) {
				return &exampleGetServicePrincipal.Id, nil
			}).(pulumi.StringPtrOutput)),
			TemplateId: pulumi.String("dataBricks"),
			Enabled:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = AzureAD.GetApplicationTemplate.Invoke(new()
    {
        DisplayName = "Azure Databricks SCIM Provisioning Connector",
    });

    var exampleApplicationFromTemplate = new AzureAD.ApplicationFromTemplate("example", new()
    {
        DisplayName = "example",
        TemplateId = example.Apply(getApplicationTemplateResult => getApplicationTemplateResult.TemplateId),
    });

    var exampleGetServicePrincipal = AzureAD.GetServicePrincipal.Invoke(new()
    {
        ObjectId = exampleApplicationFromTemplate.ServicePrincipalObjectId,
    });

    var exampleSynchronizationSecret = new AzureAD.SynchronizationSecret("example", new()
    {
        ServicePrincipalId = exampleGetServicePrincipal.Apply(getServicePrincipalResult => getServicePrincipalResult.Id),
        Credentials = new[]
        {
            new AzureAD.Inputs.SynchronizationSecretCredentialArgs
            {
                Key = "BaseAddress",
                Value = "https://adb-example.azuredatabricks.net/api/2.0/preview/scim",
            },
            new AzureAD.Inputs.SynchronizationSecretCredentialArgs
            {
                Key = "SecretToken",
                Value = "some-token",
            },
        },
    });

    var exampleSynchronizationJob = new AzureAD.SynchronizationJob("example", new()
    {
        ServicePrincipalId = exampleGetServicePrincipal.Apply(getServicePrincipalResult => getServicePrincipalResult.Id),
        TemplateId = "dataBricks",
        Enabled = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetApplicationTemplateArgs;
import com.pulumi.azuread.ApplicationFromTemplate;
import com.pulumi.azuread.ApplicationFromTemplateArgs;
import com.pulumi.azuread.inputs.GetServicePrincipalArgs;
import com.pulumi.azuread.SynchronizationSecret;
import com.pulumi.azuread.SynchronizationSecretArgs;
import com.pulumi.azuread.inputs.SynchronizationSecretCredentialArgs;
import com.pulumi.azuread.SynchronizationJob;
import com.pulumi.azuread.SynchronizationJobArgs;
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 example = AzureadFunctions.getApplicationTemplate(GetApplicationTemplateArgs.builder()
            .displayName("Azure Databricks SCIM Provisioning Connector")
            .build());

        var exampleApplicationFromTemplate = new ApplicationFromTemplate("exampleApplicationFromTemplate", ApplicationFromTemplateArgs.builder()
            .displayName("example")
            .templateId(example.applyValue(getApplicationTemplateResult -> getApplicationTemplateResult.templateId()))
            .build());

        final var exampleGetServicePrincipal = AzureadFunctions.getServicePrincipal(GetServicePrincipalArgs.builder()
            .objectId(exampleApplicationFromTemplate.servicePrincipalObjectId())
            .build());

        var exampleSynchronizationSecret = new SynchronizationSecret("exampleSynchronizationSecret", SynchronizationSecretArgs.builder()
            .servicePrincipalId(exampleGetServicePrincipal.applyValue(getServicePrincipalResult -> getServicePrincipalResult).applyValue(exampleGetServicePrincipal -> exampleGetServicePrincipal.applyValue(getServicePrincipalResult -> getServicePrincipalResult.id())))
            .credentials(            
                SynchronizationSecretCredentialArgs.builder()
                    .key("BaseAddress")
                    .value("https://adb-example.azuredatabricks.net/api/2.0/preview/scim")
                    .build(),
                SynchronizationSecretCredentialArgs.builder()
                    .key("SecretToken")
                    .value("some-token")
                    .build())
            .build());

        var exampleSynchronizationJob = new SynchronizationJob("exampleSynchronizationJob", SynchronizationJobArgs.builder()
            .servicePrincipalId(exampleGetServicePrincipal.applyValue(getServicePrincipalResult -> getServicePrincipalResult).applyValue(exampleGetServicePrincipal -> exampleGetServicePrincipal.applyValue(getServicePrincipalResult -> getServicePrincipalResult.id())))
            .templateId("dataBricks")
            .enabled(true)
            .build());

    }
}

resources:
  exampleApplicationFromTemplate:
    type: azuread:ApplicationFromTemplate
    name: example
    properties:
      displayName: example
      templateId: ${example.templateId}
  exampleSynchronizationSecret:
    type: azuread:SynchronizationSecret
    name: example
    properties:
      servicePrincipalId: ${exampleGetServicePrincipal.id}
      credentials:
        - key: BaseAddress
          value: https://adb-example.azuredatabricks.net/api/2.0/preview/scim
        - key: SecretToken
          value: some-token
  exampleSynchronizationJob:
    type: azuread:SynchronizationJob
    name: example
    properties:
      servicePrincipalId: ${exampleGetServicePrincipal.id}
      templateId: dataBricks
      enabled: true
variables:
  example:
    fn::invoke:
      function: azuread:getApplicationTemplate
      arguments:
        displayName: Azure Databricks SCIM Provisioning Connector
  exampleGetServicePrincipal:
    fn::invoke:
      function: azuread:getServicePrincipal
      arguments:
        objectId: ${exampleApplicationFromTemplate.servicePrincipalObjectId}

Create SynchronizationJob Resource

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

new SynchronizationJob(name: string, args: SynchronizationJobArgs, opts?: CustomResourceOptions);

@overload
def SynchronizationJob(resource_name: str,
                       args: SynchronizationJobArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SynchronizationJob(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       service_principal_id: Optional[str] = None,
                       template_id: Optional[str] = None,
                       enabled: Optional[bool] = None)

func NewSynchronizationJob(ctx *Context, name string, args SynchronizationJobArgs, opts ...ResourceOption) (*SynchronizationJob, error)

public SynchronizationJob(string name, SynchronizationJobArgs args, CustomResourceOptions? opts = null)

public SynchronizationJob(String name, SynchronizationJobArgs args)
public SynchronizationJob(String name, SynchronizationJobArgs args, CustomResourceOptions options)

type: azuread:SynchronizationJob
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 SynchronizationJobArgs: 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 SynchronizationJobArgs: 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 SynchronizationJobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SynchronizationJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SynchronizationJobArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var synchronizationJobResource = new AzureAD.SynchronizationJob("synchronizationJobResource", new()
{
    ServicePrincipalId = "string",
    TemplateId = "string",
    Enabled = false,
});

example, err := azuread.NewSynchronizationJob(ctx, "synchronizationJobResource", &azuread.SynchronizationJobArgs{
	ServicePrincipalId: pulumi.String("string"),
	TemplateId:         pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
})

var synchronizationJobResource = new SynchronizationJob("synchronizationJobResource", SynchronizationJobArgs.builder()
    .servicePrincipalId("string")
    .templateId("string")
    .enabled(false)
    .build());

synchronization_job_resource = azuread.SynchronizationJob("synchronizationJobResource",
    service_principal_id="string",
    template_id="string",
    enabled=False)

const synchronizationJobResource = new azuread.SynchronizationJob("synchronizationJobResource", {
    servicePrincipalId: "string",
    templateId: "string",
    enabled: false,
});

type: azuread:SynchronizationJob
properties:
    enabled: false
    servicePrincipalId: string
    templateId: string

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

ServicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
TemplateId string: Identifier of the synchronization template this job is based on.
Enabled bool: Whether the provisioning job is enabled. Default state is true.

ServicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
TemplateId string: Identifier of the synchronization template this job is based on.
Enabled bool: Whether the provisioning job is enabled. Default state is true.

servicePrincipalId String: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId String: Identifier of the synchronization template this job is based on.
enabled Boolean: Whether the provisioning job is enabled. Default state is true.

servicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId string: Identifier of the synchronization template this job is based on.
enabled boolean: Whether the provisioning job is enabled. Default state is true.

service_principal_id str: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
template_id str: Identifier of the synchronization template this job is based on.
enabled bool: Whether the provisioning job is enabled. Default state is true.

servicePrincipalId String: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId String: Identifier of the synchronization template this job is based on.
enabled Boolean: Whether the provisioning job is enabled. Default state is true.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Schedules List<Pulumi.AzureAD.Outputs.SynchronizationJobSchedule>: A schedule list as documented below.

Id string: The provider-assigned unique ID for this managed resource.
Schedules []SynchronizationJobSchedule: A schedule list as documented below.

id String: The provider-assigned unique ID for this managed resource.
schedules List<SynchronizationJobSchedule>: A schedule list as documented below.

id string: The provider-assigned unique ID for this managed resource.
schedules SynchronizationJobSchedule[]: A schedule list as documented below.

id str: The provider-assigned unique ID for this managed resource.
schedules Sequence[SynchronizationJobSchedule]: A schedule list as documented below.

id String: The provider-assigned unique ID for this managed resource.
schedules List<Property Map>: A schedule list as documented below.

Look up Existing SynchronizationJob Resource

Get an existing SynchronizationJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: SynchronizationJobState, opts?: CustomResourceOptions): SynchronizationJob

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        schedules: Optional[Sequence[SynchronizationJobScheduleArgs]] = None,
        service_principal_id: Optional[str] = None,
        template_id: Optional[str] = None) -> SynchronizationJob

func GetSynchronizationJob(ctx *Context, name string, id IDInput, state *SynchronizationJobState, opts ...ResourceOption) (*SynchronizationJob, error)

public static SynchronizationJob Get(string name, Input<string> id, SynchronizationJobState? state, CustomResourceOptions? opts = null)

public static SynchronizationJob get(String name, Output<String> id, SynchronizationJobState state, CustomResourceOptions options)

resources:  _:    type: azuread:SynchronizationJob    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Enabled bool: Whether the provisioning job is enabled. Default state is true.
Schedules List<Pulumi.AzureAD.Inputs.SynchronizationJobSchedule>: A schedule list as documented below.
ServicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
TemplateId string: Identifier of the synchronization template this job is based on.

Enabled bool: Whether the provisioning job is enabled. Default state is true.
Schedules []SynchronizationJobScheduleArgs: A schedule list as documented below.
ServicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
TemplateId string: Identifier of the synchronization template this job is based on.

enabled Boolean: Whether the provisioning job is enabled. Default state is true.
schedules List<SynchronizationJobSchedule>: A schedule list as documented below.
servicePrincipalId String: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId String: Identifier of the synchronization template this job is based on.

enabled boolean: Whether the provisioning job is enabled. Default state is true.
schedules SynchronizationJobSchedule[]: A schedule list as documented below.
servicePrincipalId string: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId string: Identifier of the synchronization template this job is based on.

enabled bool: Whether the provisioning job is enabled. Default state is true.
schedules Sequence[SynchronizationJobScheduleArgs]: A schedule list as documented below.
service_principal_id str: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
template_id str: Identifier of the synchronization template this job is based on.

enabled Boolean: Whether the provisioning job is enabled. Default state is true.
schedules List<Property Map>: A schedule list as documented below.
servicePrincipalId String: The ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
templateId String: Identifier of the synchronization template this job is based on.

Supporting Types

SynchronizationJobSchedule
, SynchronizationJobScheduleArgs

Expiration string: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
Interval string: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
State string: State of the job.

Expiration string: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
Interval string: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
State string: State of the job.

expiration String: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
interval String: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
state String: State of the job.

expiration string: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
interval string: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
state string: State of the job.

expiration str: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
interval str: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
state str: State of the job.

expiration String: Date and time when this job will expire, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z).
interval String: The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
state String: State of the job.

Import

Synchronization jobs can be imported using the id, e.g.

$ pulumi import azuread:index/synchronizationJob:SynchronizationJob example 00000000-0000-0000-0000-000000000000/job/dataBricks.f5532fc709734b1a90e8a1fa9fd03a82.8442fd39-2183-419c-8732-74b6ce866bd5

-> This ID format is unique to Terraform and is composed of the Service Principal Object ID and the ID of the Synchronization Job Id in the format {servicePrincipalId}/job/{jobId}.

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

Package Details

Repository: Azure Active Directory (Azure AD) pulumi/pulumi-azuread
License: Apache-2.0
Notes: This Pulumi package is based on the azuread Terraform Provider.

Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi

pulumi/pulumi-azuread

azuread.SynchronizationJob

On this page

On this page

API Permissions

Example Usage

Create SynchronizationJob Resource

Constructor syntax

Parameters

Constructor example

SynchronizationJob Resource Properties

Inputs

Outputs

Look up Existing SynchronizationJob Resource

Supporting Types

SynchronizationJobSchedule
, SynchronizationJobScheduleArgs

Import

Package Details

On this page

On this page

azuread.SynchronizationJob

On this page

On this page

API Permissions

Example Usage

Create SynchronizationJob Resource

Constructor syntax

Parameters

Constructor example

SynchronizationJob Resource Properties

Inputs

Outputs

Look up Existing SynchronizationJob Resource

Supporting Types

SynchronizationJobSchedule, SynchronizationJobScheduleArgs

Import

Package Details

On this page

On this page

SynchronizationJobSchedule
, SynchronizationJobScheduleArgs