Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. SynchronizationJobProvisionOnDemand
Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azuread

azuread.SynchronizationJobProvisionOnDemand

Explore with Pulumi AI

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

Manages synchronization job on demand provisioning associated with a service principal (enterprise application) within Azure Active Directory.

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: Synchronization.ReadWrite.All

Example Usage

Basic example

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

const current = azuread.getClientConfig({});
const exampleGroup = new azuread.Group("example", {
    displayName: "example",
    owners: [current.then(current => current.objectId)],
    securityEnabled: true,
});
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,
});
const exampleSynchronizationJobProvisionOnDemand = new azuread.SynchronizationJobProvisionOnDemand("example", {
    servicePrincipalId: exampleSynchronizationJob.servicePrincipalId,
    synchronizationJobId: exampleSynchronizationJob.id,
    parameters: [{
        ruleId: "",
        subjects: [{
            objectId: exampleGroup.objectId,
            objectTypeName: "Group",
        }],
    }],
});
Copy
import pulumi
import pulumi_azuread as azuread

current = azuread.get_client_config()
example_group = azuread.Group("example",
    display_name="example",
    owners=[current.object_id],
    security_enabled=True)
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)
example_synchronization_job_provision_on_demand = azuread.SynchronizationJobProvisionOnDemand("example",
    service_principal_id=example_synchronization_job.service_principal_id,
    synchronization_job_id=example_synchronization_job.id,
    parameters=[{
        "rule_id": "",
        "subjects": [{
            "object_id": example_group.object_id,
            "object_type_name": "Group",
        }],
    }])
Copy
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 {
		current, err := azuread.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		exampleGroup, err := azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName: pulumi.String("example"),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		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
		}
		exampleSynchronizationJob, 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
		}
		_, err = azuread.NewSynchronizationJobProvisionOnDemand(ctx, "example", &azuread.SynchronizationJobProvisionOnDemandArgs{
			ServicePrincipalId:   exampleSynchronizationJob.ServicePrincipalId,
			SynchronizationJobId: exampleSynchronizationJob.ID(),
			Parameters: azuread.SynchronizationJobProvisionOnDemandParameterArray{
				&azuread.SynchronizationJobProvisionOnDemandParameterArgs{
					RuleId: pulumi.String(""),
					Subjects: azuread.SynchronizationJobProvisionOnDemandParameterSubjectArray{
						&azuread.SynchronizationJobProvisionOnDemandParameterSubjectArgs{
							ObjectId:       exampleGroup.ObjectId,
							ObjectTypeName: pulumi.String("Group"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var current = AzureAD.GetClientConfig.Invoke();

    var exampleGroup = new AzureAD.Group("example", new()
    {
        DisplayName = "example",
        Owners = new[]
        {
            current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        },
        SecurityEnabled = true,
    });

    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,
    });

    var exampleSynchronizationJobProvisionOnDemand = new AzureAD.SynchronizationJobProvisionOnDemand("example", new()
    {
        ServicePrincipalId = exampleSynchronizationJob.ServicePrincipalId,
        SynchronizationJobId = exampleSynchronizationJob.Id,
        Parameters = new[]
        {
            new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterArgs
            {
                RuleId = "",
                Subjects = new[]
                {
                    new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterSubjectArgs
                    {
                        ObjectId = exampleGroup.ObjectId,
                        ObjectTypeName = "Group",
                    },
                },
            },
        },
    });

});
Copy
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.Group;
import com.pulumi.azuread.GroupArgs;
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 com.pulumi.azuread.SynchronizationJobProvisionOnDemand;
import com.pulumi.azuread.SynchronizationJobProvisionOnDemandArgs;
import com.pulumi.azuread.inputs.SynchronizationJobProvisionOnDemandParameterArgs;
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 = AzureadFunctions.getClientConfig();

        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
            .displayName("example")
            .owners(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .securityEnabled(true)
            .build());

        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());

        var exampleSynchronizationJobProvisionOnDemand = new SynchronizationJobProvisionOnDemand("exampleSynchronizationJobProvisionOnDemand", SynchronizationJobProvisionOnDemandArgs.builder()
            .servicePrincipalId(exampleSynchronizationJob.servicePrincipalId())
            .synchronizationJobId(exampleSynchronizationJob.id())
            .parameters(SynchronizationJobProvisionOnDemandParameterArgs.builder()
                .ruleId("")
                .subjects(SynchronizationJobProvisionOnDemandParameterSubjectArgs.builder()
                    .objectId(exampleGroup.objectId())
                    .objectTypeName("Group")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  exampleGroup:
    type: azuread:Group
    name: example
    properties:
      displayName: example
      owners:
        - ${current.objectId}
      securityEnabled: true
  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
  exampleSynchronizationJobProvisionOnDemand:
    type: azuread:SynchronizationJobProvisionOnDemand
    name: example
    properties:
      servicePrincipalId: ${exampleSynchronizationJob.servicePrincipalId}
      synchronizationJobId: ${exampleSynchronizationJob.id}
      parameters:
        - ruleId: ""
          subjects:
            - objectId: ${exampleGroup.objectId}
              objectTypeName: Group
variables:
  current:
    fn::invoke:
      function: azuread:getClientConfig
      arguments: {}
  example:
    fn::invoke:
      function: azuread:getApplicationTemplate
      arguments:
        displayName: Azure Databricks SCIM Provisioning Connector
  exampleGetServicePrincipal:
    fn::invoke:
      function: azuread:getServicePrincipal
      arguments:
        objectId: ${exampleApplicationFromTemplate.servicePrincipalObjectId}
Copy

Create SynchronizationJobProvisionOnDemand Resource

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

Constructor syntax

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

@overload
def SynchronizationJobProvisionOnDemand(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        parameters: Optional[Sequence[SynchronizationJobProvisionOnDemandParameterArgs]] = None,
                                        service_principal_id: Optional[str] = None,
                                        synchronization_job_id: Optional[str] = None,
                                        triggers: Optional[Mapping[str, str]] = None)
func NewSynchronizationJobProvisionOnDemand(ctx *Context, name string, args SynchronizationJobProvisionOnDemandArgs, opts ...ResourceOption) (*SynchronizationJobProvisionOnDemand, error)
public SynchronizationJobProvisionOnDemand(string name, SynchronizationJobProvisionOnDemandArgs args, CustomResourceOptions? opts = null)
public SynchronizationJobProvisionOnDemand(String name, SynchronizationJobProvisionOnDemandArgs args)
public SynchronizationJobProvisionOnDemand(String name, SynchronizationJobProvisionOnDemandArgs args, CustomResourceOptions options)

type: azuread:SynchronizationJobProvisionOnDemand
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. SynchronizationJobProvisionOnDemandArgs
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. SynchronizationJobProvisionOnDemandArgs
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. SynchronizationJobProvisionOnDemandArgs
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. SynchronizationJobProvisionOnDemandArgs
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. SynchronizationJobProvisionOnDemandArgs
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 synchronizationJobProvisionOnDemandResource = new AzureAD.SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource", new()
{
    Parameters = new[]
    {
        new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterArgs
        {
            RuleId = "string",
            Subjects = new[]
            {
                new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterSubjectArgs
                {
                    ObjectId = "string",
                    ObjectTypeName = "string",
                },
            },
        },
    },
    ServicePrincipalId = "string",
    SynchronizationJobId = "string",
    Triggers = 
    {
        { "string", "string" },
    },
});
Copy
example, err := azuread.NewSynchronizationJobProvisionOnDemand(ctx, "synchronizationJobProvisionOnDemandResource", &azuread.SynchronizationJobProvisionOnDemandArgs{
	Parameters: azuread.SynchronizationJobProvisionOnDemandParameterArray{
		&azuread.SynchronizationJobProvisionOnDemandParameterArgs{
			RuleId: pulumi.String("string"),
			Subjects: azuread.SynchronizationJobProvisionOnDemandParameterSubjectArray{
				&azuread.SynchronizationJobProvisionOnDemandParameterSubjectArgs{
					ObjectId:       pulumi.String("string"),
					ObjectTypeName: pulumi.String("string"),
				},
			},
		},
	},
	ServicePrincipalId:   pulumi.String("string"),
	SynchronizationJobId: pulumi.String("string"),
	Triggers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var synchronizationJobProvisionOnDemandResource = new SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource", SynchronizationJobProvisionOnDemandArgs.builder()
    .parameters(SynchronizationJobProvisionOnDemandParameterArgs.builder()
        .ruleId("string")
        .subjects(SynchronizationJobProvisionOnDemandParameterSubjectArgs.builder()
            .objectId("string")
            .objectTypeName("string")
            .build())
        .build())
    .servicePrincipalId("string")
    .synchronizationJobId("string")
    .triggers(Map.of("string", "string"))
    .build());
Copy
synchronization_job_provision_on_demand_resource = azuread.SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource",
    parameters=[{
        "rule_id": "string",
        "subjects": [{
            "object_id": "string",
            "object_type_name": "string",
        }],
    }],
    service_principal_id="string",
    synchronization_job_id="string",
    triggers={
        "string": "string",
    })
Copy
const synchronizationJobProvisionOnDemandResource = new azuread.SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource", {
    parameters: [{
        ruleId: "string",
        subjects: [{
            objectId: "string",
            objectTypeName: "string",
        }],
    }],
    servicePrincipalId: "string",
    synchronizationJobId: "string",
    triggers: {
        string: "string",
    },
});
Copy
type: azuread:SynchronizationJobProvisionOnDemand
properties:
    parameters:
        - ruleId: string
          subjects:
            - objectId: string
              objectTypeName: string
    servicePrincipalId: string
    synchronizationJobId: string
    triggers:
        string: string
Copy

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

Parameters
This property is required.
Changes to this property will trigger replacement.
List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameter>
One or more parameter blocks as documented below.
ServicePrincipalId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the service principal for the synchronization job.
SynchronizationJobId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the synchronization job.
Triggers Changes to this property will trigger replacement. Dictionary<string, string>
Parameters
This property is required.
Changes to this property will trigger replacement.
[]SynchronizationJobProvisionOnDemandParameterArgs
One or more parameter blocks as documented below.
ServicePrincipalId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the service principal for the synchronization job.
SynchronizationJobId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the synchronization job.
Triggers Changes to this property will trigger replacement. map[string]string
parameters
This property is required.
Changes to this property will trigger replacement.
List<SynchronizationJobProvisionOnDemandParameter>
One or more parameter blocks as documented below.
servicePrincipalId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the service principal for the synchronization job.
synchronizationJobId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Map<String,String>
parameters
This property is required.
Changes to this property will trigger replacement.
SynchronizationJobProvisionOnDemandParameter[]
One or more parameter blocks as documented below.
servicePrincipalId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the service principal for the synchronization job.
synchronizationJobId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. {[key: string]: string}
parameters
This property is required.
Changes to this property will trigger replacement.
Sequence[SynchronizationJobProvisionOnDemandParameterArgs]
One or more parameter blocks as documented below.
service_principal_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the service principal for the synchronization job.
synchronization_job_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Mapping[str, str]
parameters
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
One or more parameter blocks as documented below.
servicePrincipalId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the service principal for the synchronization job.
synchronizationJobId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Map<String>

Outputs

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

Get an existing SynchronizationJobProvisionOnDemand 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?: SynchronizationJobProvisionOnDemandState, opts?: CustomResourceOptions): SynchronizationJobProvisionOnDemand
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        parameters: Optional[Sequence[SynchronizationJobProvisionOnDemandParameterArgs]] = None,
        service_principal_id: Optional[str] = None,
        synchronization_job_id: Optional[str] = None,
        triggers: Optional[Mapping[str, str]] = None) -> SynchronizationJobProvisionOnDemand
func GetSynchronizationJobProvisionOnDemand(ctx *Context, name string, id IDInput, state *SynchronizationJobProvisionOnDemandState, opts ...ResourceOption) (*SynchronizationJobProvisionOnDemand, error)
public static SynchronizationJobProvisionOnDemand Get(string name, Input<string> id, SynchronizationJobProvisionOnDemandState? state, CustomResourceOptions? opts = null)
public static SynchronizationJobProvisionOnDemand get(String name, Output<String> id, SynchronizationJobProvisionOnDemandState state, CustomResourceOptions options)
resources:  _:    type: azuread:SynchronizationJobProvisionOnDemand    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:
Parameters Changes to this property will trigger replacement. List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameter>
One or more parameter blocks as documented below.
ServicePrincipalId Changes to this property will trigger replacement. string
The ID of the service principal for the synchronization job.
SynchronizationJobId Changes to this property will trigger replacement. string
The ID of the synchronization job.
Triggers Changes to this property will trigger replacement. Dictionary<string, string>
Parameters Changes to this property will trigger replacement. []SynchronizationJobProvisionOnDemandParameterArgs
One or more parameter blocks as documented below.
ServicePrincipalId Changes to this property will trigger replacement. string
The ID of the service principal for the synchronization job.
SynchronizationJobId Changes to this property will trigger replacement. string
The ID of the synchronization job.
Triggers Changes to this property will trigger replacement. map[string]string
parameters Changes to this property will trigger replacement. List<SynchronizationJobProvisionOnDemandParameter>
One or more parameter blocks as documented below.
servicePrincipalId Changes to this property will trigger replacement. String
The ID of the service principal for the synchronization job.
synchronizationJobId Changes to this property will trigger replacement. String
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Map<String,String>
parameters Changes to this property will trigger replacement. SynchronizationJobProvisionOnDemandParameter[]
One or more parameter blocks as documented below.
servicePrincipalId Changes to this property will trigger replacement. string
The ID of the service principal for the synchronization job.
synchronizationJobId Changes to this property will trigger replacement. string
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. {[key: string]: string}
parameters Changes to this property will trigger replacement. Sequence[SynchronizationJobProvisionOnDemandParameterArgs]
One or more parameter blocks as documented below.
service_principal_id Changes to this property will trigger replacement. str
The ID of the service principal for the synchronization job.
synchronization_job_id Changes to this property will trigger replacement. str
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Mapping[str, str]
parameters Changes to this property will trigger replacement. List<Property Map>
One or more parameter blocks as documented below.
servicePrincipalId Changes to this property will trigger replacement. String
The ID of the service principal for the synchronization job.
synchronizationJobId Changes to this property will trigger replacement. String
The ID of the synchronization job.
triggers Changes to this property will trigger replacement. Map<String>

Supporting Types

SynchronizationJobProvisionOnDemandParameter
, SynchronizationJobProvisionOnDemandParameterArgs

RuleId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
Subjects
This property is required.
Changes to this property will trigger replacement.
List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterSubject>
One or more subject blocks as documented below.
RuleId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
Subjects
This property is required.
Changes to this property will trigger replacement.
[]SynchronizationJobProvisionOnDemandParameterSubject
One or more subject blocks as documented below.
ruleId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
subjects
This property is required.
Changes to this property will trigger replacement.
List<SynchronizationJobProvisionOnDemandParameterSubject>
One or more subject blocks as documented below.
ruleId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
subjects
This property is required.
Changes to this property will trigger replacement.
SynchronizationJobProvisionOnDemandParameterSubject[]
One or more subject blocks as documented below.
rule_id
This property is required.
Changes to this property will trigger replacement.
str
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
subjects
This property is required.
Changes to this property will trigger replacement.
Sequence[SynchronizationJobProvisionOnDemandParameterSubject]
One or more subject blocks as documented below.
ruleId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the synchronization rule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
subjects
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
One or more subject blocks as documented below.

SynchronizationJobProvisionOnDemandParameterSubject
, SynchronizationJobProvisionOnDemandParameterSubjectArgs

ObjectId This property is required. string
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
ObjectTypeName This property is required. string
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.
ObjectId This property is required. string
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
ObjectTypeName This property is required. string
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.
objectId This property is required. String
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
objectTypeName This property is required. String
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.
objectId This property is required. string
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
objectTypeName This property is required. string
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.
object_id This property is required. str
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
object_type_name This property is required. str
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.
objectId This property is required. String
The identifier of an object to which a synchronization job is to be applied. Can be one of the following: (1) An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD. (2) The user ID for synchronization from Azure AD to a third-party. (3) The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.
objectTypeName This property is required. String
The type of the object to which a synchronization job is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD, User for synchronizing a user between Azure AD and a third-party application, Worker for synchronization a user between Workday and either Active Directory or Azure AD, Group for synchronizing a group between Azure AD and a third-party application.

Import

This resource does not support importing.

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