Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. SynchronizationSecret
Azure Active Directory (Azure AD) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
pulumi/pulumi-azuread

azuread.SynchronizationSecret

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
pulumi/pulumi-azuread

    Manages synchronization secrets 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: Application.ReadWrite.All or Directory.ReadWrite.All

    Example Usage

    Basic example

    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: "abc",
        },
        {
            key: "SecretToken",
            value: "some-token",
        },
    ],
});

    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": "abc",
        },
        {
            "key": "SecretToken",
            "value": "some-token",
        },
    ])

    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("abc"),
				},
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("SecretToken"),
					Value: pulumi.String("some-token"),
				},
			},
		})
		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 = "abc",
            },
            new AzureAD.Inputs.SynchronizationSecretCredentialArgs
            {
                Key = "SecretToken",
                Value = "some-token",
            },
        },
    });

});

    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 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("abc")
                    .build(),
                SynchronizationSecretCredentialArgs.builder()
                    .key("SecretToken")
                    .value("some-token")
                    .build())
            .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: abc
        - key: SecretToken
          value: some-token
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 SynchronizationSecret Resource

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

    Constructor syntax

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

@overload
def SynchronizationSecret(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          service_principal_id: Optional[str] = None,
                          credentials: Optional[Sequence[SynchronizationSecretCredentialArgs]] = None)
    func NewSynchronizationSecret(ctx *Context, name string, args SynchronizationSecretArgs, opts ...ResourceOption) (*SynchronizationSecret, error)
    public SynchronizationSecret(string name, SynchronizationSecretArgs args, CustomResourceOptions? opts = null)
    public SynchronizationSecret(String name, SynchronizationSecretArgs args)
public SynchronizationSecret(String name, SynchronizationSecretArgs args, CustomResourceOptions options)

    type: azuread:SynchronizationSecret
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 SynchronizationSecretArgs
    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 SynchronizationSecretArgs
    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 SynchronizationSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynchronizationSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SynchronizationSecretArgs
    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 synchronizationSecretResource = new AzureAD.SynchronizationSecret("synchronizationSecretResource", new()
{
    ServicePrincipalId = "string",
    Credentials = new[]
    {
        new AzureAD.Inputs.SynchronizationSecretCredentialArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := azuread.NewSynchronizationSecret(ctx, "synchronizationSecretResource", &azuread.SynchronizationSecretArgs{
	ServicePrincipalId: pulumi.String("string"),
	Credentials: azuread.SynchronizationSecretCredentialArray{
		&azuread.SynchronizationSecretCredentialArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var synchronizationSecretResource = new SynchronizationSecret("synchronizationSecretResource", SynchronizationSecretArgs.builder()
    .servicePrincipalId("string")
    .credentials(SynchronizationSecretCredentialArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    synchronization_secret_resource = azuread.SynchronizationSecret("synchronizationSecretResource",
    service_principal_id="string",
    credentials=[{
        "key": "string",
        "value": "string",
    }])

    const synchronizationSecretResource = new azuread.SynchronizationSecret("synchronizationSecretResource", {
    servicePrincipalId: "string",
    credentials: [{
        key: "string",
        value: "string",
    }],
});

    type: azuread:SynchronizationSecret
properties:
    credentials:
        - key: string
          value: string
    servicePrincipalId: string

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

    ServicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    Credentials List<Pulumi.AzureAD.Inputs.SynchronizationSecretCredential>
    One or more credential blocks as documented below.
    ServicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    Credentials []SynchronizationSecretCredentialArgs
    One or more credential blocks as documented below.
    servicePrincipalId String
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials List<SynchronizationSecretCredential>
    One or more credential blocks as documented below.
    servicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials SynchronizationSecretCredential[]
    One or more credential blocks as documented below.
    service_principal_id str
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials Sequence[SynchronizationSecretCredentialArgs]
    One or more credential blocks as documented below.
    servicePrincipalId String
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials List<Property Map>
    One or more credential blocks as documented below.

    Outputs

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

    Get an existing SynchronizationSecret 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?: SynchronizationSecretState, opts?: CustomResourceOptions): SynchronizationSecret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[Sequence[SynchronizationSecretCredentialArgs]] = None,
        service_principal_id: Optional[str] = None) -> SynchronizationSecret
    func GetSynchronizationSecret(ctx *Context, name string, id IDInput, state *SynchronizationSecretState, opts ...ResourceOption) (*SynchronizationSecret, error)
    public static SynchronizationSecret Get(string name, Input<string> id, SynchronizationSecretState? state, CustomResourceOptions? opts = null)
    public static SynchronizationSecret get(String name, Output<String> id, SynchronizationSecretState 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:
    Credentials List<Pulumi.AzureAD.Inputs.SynchronizationSecretCredential>
    One or more credential blocks as documented below.
    ServicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    Credentials []SynchronizationSecretCredentialArgs
    One or more credential blocks as documented below.
    ServicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials List<SynchronizationSecretCredential>
    One or more credential blocks as documented below.
    servicePrincipalId String
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials SynchronizationSecretCredential[]
    One or more credential blocks as documented below.
    servicePrincipalId string
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials Sequence[SynchronizationSecretCredentialArgs]
    One or more credential blocks as documented below.
    service_principal_id str
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
    credentials List<Property Map>
    One or more credential blocks as documented below.
    servicePrincipalId String
    The ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.

    Supporting Types

    SynchronizationSecretCredential, SynchronizationSecretCredentialArgs

    Key string
    The key of the secret.
    Value string
    The value of the secret.
    Key string
    The key of the secret.
    Value string
    The value of the secret.
    key String
    The key of the secret.
    value String
    The value of the secret.
    key string
    The key of the secret.
    value string
    The value of the secret.
    key str
    The key of the secret.
    value str
    The value of the secret.
    key String
    The key of the secret.
    value String
    The value of the secret.

    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) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
    pulumi/pulumi-azuread