1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. SynchronizationJobProvisionOnDemand
Azure Active Directory (Azure AD) v5.53.2 published on Monday, Jul 15, 2024 by Pulumi

azuread.SynchronizationJobProvisionOnDemand

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v5.53.2 published on Monday, Jul 15, 2024 by Pulumi

    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 exampleApplication = new azuread.Application("example", {
        displayName: "example",
        templateId: example.then(example => example.templateId),
        featureTags: [{
            enterprise: true,
            gallery: true,
        }],
    });
    const exampleServicePrincipal = new azuread.ServicePrincipal("example", {
        clientId: exampleApplication.clientId,
        useExisting: true,
    });
    const exampleSynchronizationSecret = new azuread.SynchronizationSecret("example", {
        servicePrincipalId: exampleServicePrincipal.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: exampleServicePrincipal.id,
        templateId: "dataBricks",
        enabled: true,
    });
    const exampleSynchronizationJobProvisionOnDemand = new azuread.SynchronizationJobProvisionOnDemand("example", {
        servicePrincipalId: exampleServicePrincipal.id,
        synchronizationJobId: exampleSynchronizationJob.id,
        parameters: [{
            ruleId: "",
            subjects: [{
                objectId: exampleGroup.objectId,
                objectTypeName: "Group",
            }],
        }],
    });
    
    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 = azuread.Application("example",
        display_name="example",
        template_id=example.template_id,
        feature_tags=[{
            "enterprise": True,
            "gallery": True,
        }])
    example_service_principal = azuread.ServicePrincipal("example",
        client_id=example_application.client_id,
        use_existing=True)
    example_synchronization_secret = azuread.SynchronizationSecret("example",
        service_principal_id=example_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_service_principal.id,
        template_id="dataBricks",
        enabled=True)
    example_synchronization_job_provision_on_demand = azuread.SynchronizationJobProvisionOnDemand("example",
        service_principal_id=example_service_principal.id,
        synchronization_job_id=example_synchronization_job.id,
        parameters=[{
            "ruleId": "",
            "subjects": [{
                "objectId": example_group.object_id,
                "objectTypeName": "Group",
            }],
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := azuread.GetClientConfig(ctx, nil, 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
    		}
    		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
    			DisplayName: pulumi.String("example"),
    			TemplateId:  pulumi.String(example.TemplateId),
    			FeatureTags: azuread.ApplicationFeatureTagArray{
    				&azuread.ApplicationFeatureTagArgs{
    					Enterprise: pulumi.Bool(true),
    					Gallery:    pulumi.Bool(true),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
    			ClientId:    exampleApplication.ClientId,
    			UseExisting: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuread.NewSynchronizationSecret(ctx, "example", &azuread.SynchronizationSecretArgs{
    			ServicePrincipalId: exampleServicePrincipal.ID(),
    			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: exampleServicePrincipal.ID(),
    			TemplateId:         pulumi.String("dataBricks"),
    			Enabled:            pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuread.NewSynchronizationJobProvisionOnDemand(ctx, "example", &azuread.SynchronizationJobProvisionOnDemandArgs{
    			ServicePrincipalId:   exampleServicePrincipal.ID(),
    			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
    	})
    }
    
    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 exampleApplication = new AzureAD.Application("example", new()
        {
            DisplayName = "example",
            TemplateId = example.Apply(getApplicationTemplateResult => getApplicationTemplateResult.TemplateId),
            FeatureTags = new[]
            {
                new AzureAD.Inputs.ApplicationFeatureTagArgs
                {
                    Enterprise = true,
                    Gallery = true,
                },
            },
        });
    
        var exampleServicePrincipal = new AzureAD.ServicePrincipal("example", new()
        {
            ClientId = exampleApplication.ClientId,
            UseExisting = true,
        });
    
        var exampleSynchronizationSecret = new AzureAD.SynchronizationSecret("example", new()
        {
            ServicePrincipalId = exampleServicePrincipal.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 = exampleServicePrincipal.Id,
            TemplateId = "dataBricks",
            Enabled = true,
        });
    
        var exampleSynchronizationJobProvisionOnDemand = new AzureAD.SynchronizationJobProvisionOnDemand("example", new()
        {
            ServicePrincipalId = exampleServicePrincipal.Id,
            SynchronizationJobId = exampleSynchronizationJob.Id,
            Parameters = new[]
            {
                new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterArgs
                {
                    RuleId = "",
                    Subjects = new[]
                    {
                        new AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterSubjectArgs
                        {
                            ObjectId = exampleGroup.ObjectId,
                            ObjectTypeName = "Group",
                        },
                    },
                },
            },
        });
    
    });
    
    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.Application;
    import com.pulumi.azuread.ApplicationArgs;
    import com.pulumi.azuread.inputs.ApplicationFeatureTagArgs;
    import com.pulumi.azuread.ServicePrincipal;
    import com.pulumi.azuread.ServicePrincipalArgs;
    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 exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
                .displayName("example")
                .templateId(example.applyValue(getApplicationTemplateResult -> getApplicationTemplateResult.templateId()))
                .featureTags(ApplicationFeatureTagArgs.builder()
                    .enterprise(true)
                    .gallery(true)
                    .build())
                .build());
    
            var exampleServicePrincipal = new ServicePrincipal("exampleServicePrincipal", ServicePrincipalArgs.builder()
                .clientId(exampleApplication.clientId())
                .useExisting(true)
                .build());
    
            var exampleSynchronizationSecret = new SynchronizationSecret("exampleSynchronizationSecret", SynchronizationSecretArgs.builder()
                .servicePrincipalId(exampleServicePrincipal.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(exampleServicePrincipal.id())
                .templateId("dataBricks")
                .enabled(true)
                .build());
    
            var exampleSynchronizationJobProvisionOnDemand = new SynchronizationJobProvisionOnDemand("exampleSynchronizationJobProvisionOnDemand", SynchronizationJobProvisionOnDemandArgs.builder()
                .servicePrincipalId(exampleServicePrincipal.id())
                .synchronizationJobId(exampleSynchronizationJob.id())
                .parameters(SynchronizationJobProvisionOnDemandParameterArgs.builder()
                    .ruleId("")
                    .subjects(SynchronizationJobProvisionOnDemandParameterSubjectArgs.builder()
                        .objectId(exampleGroup.objectId())
                        .objectTypeName("Group")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleGroup:
        type: azuread:Group
        name: example
        properties:
          displayName: example
          owners:
            - ${current.objectId}
          securityEnabled: true
      exampleApplication:
        type: azuread:Application
        name: example
        properties:
          displayName: example
          templateId: ${example.templateId}
          featureTags:
            - enterprise: true
              gallery: true
      exampleServicePrincipal:
        type: azuread:ServicePrincipal
        name: example
        properties:
          clientId: ${exampleApplication.clientId}
          useExisting: true
      exampleSynchronizationSecret:
        type: azuread:SynchronizationSecret
        name: example
        properties:
          servicePrincipalId: ${exampleServicePrincipal.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: ${exampleServicePrincipal.id}
          templateId: dataBricks
          enabled: true
      exampleSynchronizationJobProvisionOnDemand:
        type: azuread:SynchronizationJobProvisionOnDemand
        name: example
        properties:
          servicePrincipalId: ${exampleServicePrincipal.id}
          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
    

    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 string
    The unique name of the resource.
    args SynchronizationJobProvisionOnDemandArgs
    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 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 string
    The unique name of the resource.
    args SynchronizationJobProvisionOnDemandArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynchronizationJobProvisionOnDemandArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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" },
        },
    });
    
    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"),
    	},
    })
    
    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());
    
    synchronization_job_provision_on_demand_resource = azuread.SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource",
        parameters=[{
            "ruleId": "string",
            "subjects": [{
                "objectId": "string",
                "objectTypeName": "string",
            }],
        }],
        service_principal_id="string",
        synchronization_job_id="string",
        triggers={
            "string": "string",
        })
    
    const synchronizationJobProvisionOnDemandResource = new azuread.SynchronizationJobProvisionOnDemand("synchronizationJobProvisionOnDemandResource", {
        parameters: [{
            ruleId: "string",
            subjects: [{
                objectId: "string",
                objectTypeName: "string",
            }],
        }],
        servicePrincipalId: "string",
        synchronizationJobId: "string",
        triggers: {
            string: "string",
        },
    });
    
    type: azuread:SynchronizationJobProvisionOnDemand
    properties:
        parameters:
            - ruleId: string
              subjects:
                - objectId: string
                  objectTypeName: string
        servicePrincipalId: string
        synchronizationJobId: string
        triggers:
            string: string
    

    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

    The SynchronizationJobProvisionOnDemand resource accepts the following input properties:

    Parameters List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameter>
    One or more parameter blocks as documented below.
    ServicePrincipalId string
    The object ID of the service principal for the synchronization job.
    SynchronizationJobId string
    Identifier of the synchronization template this job is based on.
    Triggers Dictionary<string, string>
    Parameters []SynchronizationJobProvisionOnDemandParameterArgs
    One or more parameter blocks as documented below.
    ServicePrincipalId string
    The object ID of the service principal for the synchronization job.
    SynchronizationJobId string
    Identifier of the synchronization template this job is based on.
    Triggers map[string]string
    parameters List<SynchronizationJobProvisionOnDemandParameter>
    One or more parameter blocks as documented below.
    servicePrincipalId String
    The object ID of the service principal for the synchronization job.
    synchronizationJobId String
    Identifier of the synchronization template this job is based on.
    triggers Map<String,String>
    parameters SynchronizationJobProvisionOnDemandParameter[]
    One or more parameter blocks as documented below.
    servicePrincipalId string
    The object ID of the service principal for the synchronization job.
    synchronizationJobId string
    Identifier of the synchronization template this job is based on.
    triggers {[key: string]: string}
    parameters Sequence[SynchronizationJobProvisionOnDemandParameterArgs]
    One or more parameter blocks as documented below.
    service_principal_id str
    The object ID of the service principal for the synchronization job.
    synchronization_job_id str
    Identifier of the synchronization template this job is based on.
    triggers Mapping[str, str]
    parameters List<Property Map>
    One or more parameter blocks as documented below.
    servicePrincipalId String
    The object ID of the service principal for the synchronization job.
    synchronizationJobId String
    Identifier of the synchronization template this job is based on.
    triggers 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Parameters List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameter>
    One or more parameter blocks as documented below.
    ServicePrincipalId string
    The object ID of the service principal for the synchronization job.
    SynchronizationJobId string
    Identifier of the synchronization template this job is based on.
    Triggers Dictionary<string, string>
    Parameters []SynchronizationJobProvisionOnDemandParameterArgs
    One or more parameter blocks as documented below.
    ServicePrincipalId string
    The object ID of the service principal for the synchronization job.
    SynchronizationJobId string
    Identifier of the synchronization template this job is based on.
    Triggers map[string]string
    parameters List<SynchronizationJobProvisionOnDemandParameter>
    One or more parameter blocks as documented below.
    servicePrincipalId String
    The object ID of the service principal for the synchronization job.
    synchronizationJobId String
    Identifier of the synchronization template this job is based on.
    triggers Map<String,String>
    parameters SynchronizationJobProvisionOnDemandParameter[]
    One or more parameter blocks as documented below.
    servicePrincipalId string
    The object ID of the service principal for the synchronization job.
    synchronizationJobId string
    Identifier of the synchronization template this job is based on.
    triggers {[key: string]: string}
    parameters Sequence[SynchronizationJobProvisionOnDemandParameterArgs]
    One or more parameter blocks as documented below.
    service_principal_id str
    The object ID of the service principal for the synchronization job.
    synchronization_job_id str
    Identifier of the synchronization template this job is based on.
    triggers Mapping[str, str]
    parameters List<Property Map>
    One or more parameter blocks as documented below.
    servicePrincipalId String
    The object ID of the service principal for the synchronization job.
    synchronizationJobId String
    Identifier of the synchronization template this job is based on.
    triggers Map<String>

    Supporting Types

    SynchronizationJobProvisionOnDemandParameter, SynchronizationJobProvisionOnDemandParameterArgs

    RuleId 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 List<Pulumi.AzureAD.Inputs.SynchronizationJobProvisionOnDemandParameterSubject>
    One or more subject blocks as documented below.
    RuleId 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 []SynchronizationJobProvisionOnDemandParameterSubject
    One or more subject blocks as documented below.
    ruleId 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 List<SynchronizationJobProvisionOnDemandParameterSubject>
    One or more subject blocks as documented below.
    ruleId 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 SynchronizationJobProvisionOnDemandParameterSubject[]
    One or more subject blocks as documented below.
    rule_id 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 Sequence[SynchronizationJobProvisionOnDemandParameterSubject]
    One or more subject blocks as documented below.
    ruleId 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 List<Property Map>
    One or more subject blocks as documented below.

    SynchronizationJobProvisionOnDemandParameterSubject, SynchronizationJobProvisionOnDemandParameterSubjectArgs

    ObjectId 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 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 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 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 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 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 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 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 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 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 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 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.
    azuread logo
    Azure Active Directory (Azure AD) v5.53.2 published on Monday, Jul 15, 2024 by Pulumi