1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. CredentialServicePrincipal

We recommend using Azure Native.

Azure Classic v5.79.0 published on Tuesday, May 28, 2024 by Pulumi

azure.datafactory.CredentialServicePrincipal

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.79.0 published on Tuesday, May 28, 2024 by Pulumi

    Manage a Data Factory Service Principal credential resource. These resources are used by Data Factory to access data sources.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const current = azure.core.getClientConfig({});
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "westeurope",
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleKeyVault = new azure.keyvault.KeyVault("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
        tenantId: current.then(current => current.tenantId),
        skuName: "premium",
        softDeleteRetentionDays: 7,
        accessPolicies: [{
            tenantId: current.then(current => current.tenantId),
            objectId: current.then(current => current.objectId),
            keyPermissions: [
                "Create",
                "Get",
            ],
            secretPermissions: [
                "Set",
                "Get",
                "Delete",
                "Purge",
                "Recover",
            ],
        }],
    });
    const exampleSecret = new azure.keyvault.Secret("example", {
        name: "example",
        value: "example-secret",
        keyVaultId: exampleKeyVault.id,
    });
    const exampleLinkedServiceKeyVault = new azure.datafactory.LinkedServiceKeyVault("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        keyVaultId: exampleKeyVault.id,
    });
    const exampleCredentialServicePrincipal = new azure.datafactory.CredentialServicePrincipal("example", {
        name: "example",
        description: "example description",
        dataFactoryId: exampleFactory.id,
        tenantId: current.then(current => current.tenantId),
        servicePrincipalId: current.then(current => current.clientId),
        servicePrincipalKey: {
            linkedServiceName: exampleLinkedServiceKeyVault.name,
            secretName: exampleSecret.name,
            secretVersion: exampleSecret.version,
        },
        annotations: [
            "1",
            "2",
        ],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    current = azure.core.get_client_config()
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="westeurope")
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example.location,
        resource_group_name=example.name)
    example_key_vault = azure.keyvault.KeyVault("example",
        name="example",
        location=example.location,
        resource_group_name=example.name,
        tenant_id=current.tenant_id,
        sku_name="premium",
        soft_delete_retention_days=7,
        access_policies=[azure.keyvault.KeyVaultAccessPolicyArgs(
            tenant_id=current.tenant_id,
            object_id=current.object_id,
            key_permissions=[
                "Create",
                "Get",
            ],
            secret_permissions=[
                "Set",
                "Get",
                "Delete",
                "Purge",
                "Recover",
            ],
        )])
    example_secret = azure.keyvault.Secret("example",
        name="example",
        value="example-secret",
        key_vault_id=example_key_vault.id)
    example_linked_service_key_vault = azure.datafactory.LinkedServiceKeyVault("example",
        name="example",
        data_factory_id=example_factory.id,
        key_vault_id=example_key_vault.id)
    example_credential_service_principal = azure.datafactory.CredentialServicePrincipal("example",
        name="example",
        description="example description",
        data_factory_id=example_factory.id,
        tenant_id=current.tenant_id,
        service_principal_id=current.client_id,
        service_principal_key=azure.datafactory.CredentialServicePrincipalServicePrincipalKeyArgs(
            linked_service_name=example_linked_service_key_vault.name,
            secret_name=example_secret.name,
            secret_version=example_secret.version,
        ),
        annotations=[
            "1",
            "2",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := core.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("westeurope"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
    			Name:                    pulumi.String("example"),
    			Location:                example.Location,
    			ResourceGroupName:       example.Name,
    			TenantId:                pulumi.String(current.TenantId),
    			SkuName:                 pulumi.String("premium"),
    			SoftDeleteRetentionDays: pulumi.Int(7),
    			AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
    				&keyvault.KeyVaultAccessPolicyArgs{
    					TenantId: pulumi.String(current.TenantId),
    					ObjectId: pulumi.String(current.ObjectId),
    					KeyPermissions: pulumi.StringArray{
    						pulumi.String("Create"),
    						pulumi.String("Get"),
    					},
    					SecretPermissions: pulumi.StringArray{
    						pulumi.String("Set"),
    						pulumi.String("Get"),
    						pulumi.String("Delete"),
    						pulumi.String("Purge"),
    						pulumi.String("Recover"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSecret, err := keyvault.NewSecret(ctx, "example", &keyvault.SecretArgs{
    			Name:       pulumi.String("example"),
    			Value:      pulumi.String("example-secret"),
    			KeyVaultId: exampleKeyVault.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLinkedServiceKeyVault, err := datafactory.NewLinkedServiceKeyVault(ctx, "example", &datafactory.LinkedServiceKeyVaultArgs{
    			Name:          pulumi.String("example"),
    			DataFactoryId: exampleFactory.ID(),
    			KeyVaultId:    exampleKeyVault.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewCredentialServicePrincipal(ctx, "example", &datafactory.CredentialServicePrincipalArgs{
    			Name:               pulumi.String("example"),
    			Description:        pulumi.String("example description"),
    			DataFactoryId:      exampleFactory.ID(),
    			TenantId:           pulumi.String(current.TenantId),
    			ServicePrincipalId: pulumi.String(current.ClientId),
    			ServicePrincipalKey: &datafactory.CredentialServicePrincipalServicePrincipalKeyArgs{
    				LinkedServiceName: exampleLinkedServiceKeyVault.Name,
    				SecretName:        exampleSecret.Name,
    				SecretVersion:     exampleSecret.Version,
    			},
    			Annotations: pulumi.StringArray{
    				pulumi.String("1"),
    				pulumi.String("2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Azure.Core.GetClientConfig.Invoke();
    
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "westeurope",
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            SkuName = "premium",
            SoftDeleteRetentionDays = 7,
            AccessPolicies = new[]
            {
                new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
                {
                    TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
                    ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
                    KeyPermissions = new[]
                    {
                        "Create",
                        "Get",
                    },
                    SecretPermissions = new[]
                    {
                        "Set",
                        "Get",
                        "Delete",
                        "Purge",
                        "Recover",
                    },
                },
            },
        });
    
        var exampleSecret = new Azure.KeyVault.Secret("example", new()
        {
            Name = "example",
            Value = "example-secret",
            KeyVaultId = exampleKeyVault.Id,
        });
    
        var exampleLinkedServiceKeyVault = new Azure.DataFactory.LinkedServiceKeyVault("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            KeyVaultId = exampleKeyVault.Id,
        });
    
        var exampleCredentialServicePrincipal = new Azure.DataFactory.CredentialServicePrincipal("example", new()
        {
            Name = "example",
            Description = "example description",
            DataFactoryId = exampleFactory.Id,
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            ServicePrincipalId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
            ServicePrincipalKey = new Azure.DataFactory.Inputs.CredentialServicePrincipalServicePrincipalKeyArgs
            {
                LinkedServiceName = exampleLinkedServiceKeyVault.Name,
                SecretName = exampleSecret.Name,
                SecretVersion = exampleSecret.Version,
            },
            Annotations = new[]
            {
                "1",
                "2",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.datafactory.Factory;
    import com.pulumi.azure.datafactory.FactoryArgs;
    import com.pulumi.azure.keyvault.KeyVault;
    import com.pulumi.azure.keyvault.KeyVaultArgs;
    import com.pulumi.azure.keyvault.inputs.KeyVaultAccessPolicyArgs;
    import com.pulumi.azure.keyvault.Secret;
    import com.pulumi.azure.keyvault.SecretArgs;
    import com.pulumi.azure.datafactory.LinkedServiceKeyVault;
    import com.pulumi.azure.datafactory.LinkedServiceKeyVaultArgs;
    import com.pulumi.azure.datafactory.CredentialServicePrincipal;
    import com.pulumi.azure.datafactory.CredentialServicePrincipalArgs;
    import com.pulumi.azure.datafactory.inputs.CredentialServicePrincipalServicePrincipalKeyArgs;
    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 = CoreFunctions.getClientConfig();
    
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("westeurope")
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .skuName("premium")
                .softDeleteRetentionDays(7)
                .accessPolicies(KeyVaultAccessPolicyArgs.builder()
                    .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                    .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                    .keyPermissions(                
                        "Create",
                        "Get")
                    .secretPermissions(                
                        "Set",
                        "Get",
                        "Delete",
                        "Purge",
                        "Recover")
                    .build())
                .build());
    
            var exampleSecret = new Secret("exampleSecret", SecretArgs.builder()
                .name("example")
                .value("example-secret")
                .keyVaultId(exampleKeyVault.id())
                .build());
    
            var exampleLinkedServiceKeyVault = new LinkedServiceKeyVault("exampleLinkedServiceKeyVault", LinkedServiceKeyVaultArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .keyVaultId(exampleKeyVault.id())
                .build());
    
            var exampleCredentialServicePrincipal = new CredentialServicePrincipal("exampleCredentialServicePrincipal", CredentialServicePrincipalArgs.builder()
                .name("example")
                .description("example description")
                .dataFactoryId(exampleFactory.id())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .servicePrincipalId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
                .servicePrincipalKey(CredentialServicePrincipalServicePrincipalKeyArgs.builder()
                    .linkedServiceName(exampleLinkedServiceKeyVault.name())
                    .secretName(exampleSecret.name())
                    .secretVersion(exampleSecret.version())
                    .build())
                .annotations(            
                    "1",
                    "2")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: westeurope
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleKeyVault:
        type: azure:keyvault:KeyVault
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
          tenantId: ${current.tenantId}
          skuName: premium
          softDeleteRetentionDays: 7
          accessPolicies:
            - tenantId: ${current.tenantId}
              objectId: ${current.objectId}
              keyPermissions:
                - Create
                - Get
              secretPermissions:
                - Set
                - Get
                - Delete
                - Purge
                - Recover
      exampleSecret:
        type: azure:keyvault:Secret
        name: example
        properties:
          name: example
          value: example-secret
          keyVaultId: ${exampleKeyVault.id}
      exampleLinkedServiceKeyVault:
        type: azure:datafactory:LinkedServiceKeyVault
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          keyVaultId: ${exampleKeyVault.id}
      exampleCredentialServicePrincipal:
        type: azure:datafactory:CredentialServicePrincipal
        name: example
        properties:
          name: example
          description: example description
          dataFactoryId: ${exampleFactory.id}
          tenantId: ${current.tenantId}
          servicePrincipalId: ${current.clientId}
          servicePrincipalKey:
            linkedServiceName: ${exampleLinkedServiceKeyVault.name}
            secretName: ${exampleSecret.name}
            secretVersion: ${exampleSecret.version}
          annotations:
            - '1'
            - '2'
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create CredentialServicePrincipal Resource

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

    Constructor syntax

    new CredentialServicePrincipal(name: string, args: CredentialServicePrincipalArgs, opts?: CustomResourceOptions);
    @overload
    def CredentialServicePrincipal(resource_name: str,
                                   args: CredentialServicePrincipalArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def CredentialServicePrincipal(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   data_factory_id: Optional[str] = None,
                                   service_principal_id: Optional[str] = None,
                                   tenant_id: Optional[str] = None,
                                   annotations: Optional[Sequence[str]] = None,
                                   description: Optional[str] = None,
                                   name: Optional[str] = None,
                                   service_principal_key: Optional[CredentialServicePrincipalServicePrincipalKeyArgs] = None)
    func NewCredentialServicePrincipal(ctx *Context, name string, args CredentialServicePrincipalArgs, opts ...ResourceOption) (*CredentialServicePrincipal, error)
    public CredentialServicePrincipal(string name, CredentialServicePrincipalArgs args, CustomResourceOptions? opts = null)
    public CredentialServicePrincipal(String name, CredentialServicePrincipalArgs args)
    public CredentialServicePrincipal(String name, CredentialServicePrincipalArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:CredentialServicePrincipal
    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 CredentialServicePrincipalArgs
    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 CredentialServicePrincipalArgs
    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 CredentialServicePrincipalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CredentialServicePrincipalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CredentialServicePrincipalArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var credentialServicePrincipalResource = new Azure.DataFactory.CredentialServicePrincipal("credentialServicePrincipalResource", new()
    {
        DataFactoryId = "string",
        ServicePrincipalId = "string",
        TenantId = "string",
        Annotations = new[]
        {
            "string",
        },
        Description = "string",
        Name = "string",
        ServicePrincipalKey = new Azure.DataFactory.Inputs.CredentialServicePrincipalServicePrincipalKeyArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
            SecretVersion = "string",
        },
    });
    
    example, err := datafactory.NewCredentialServicePrincipal(ctx, "credentialServicePrincipalResource", &datafactory.CredentialServicePrincipalArgs{
    	DataFactoryId:      pulumi.String("string"),
    	ServicePrincipalId: pulumi.String("string"),
    	TenantId:           pulumi.String("string"),
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	ServicePrincipalKey: &datafactory.CredentialServicePrincipalServicePrincipalKeyArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    		SecretVersion:     pulumi.String("string"),
    	},
    })
    
    var credentialServicePrincipalResource = new CredentialServicePrincipal("credentialServicePrincipalResource", CredentialServicePrincipalArgs.builder()        
        .dataFactoryId("string")
        .servicePrincipalId("string")
        .tenantId("string")
        .annotations("string")
        .description("string")
        .name("string")
        .servicePrincipalKey(CredentialServicePrincipalServicePrincipalKeyArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .secretVersion("string")
            .build())
        .build());
    
    credential_service_principal_resource = azure.datafactory.CredentialServicePrincipal("credentialServicePrincipalResource",
        data_factory_id="string",
        service_principal_id="string",
        tenant_id="string",
        annotations=["string"],
        description="string",
        name="string",
        service_principal_key=azure.datafactory.CredentialServicePrincipalServicePrincipalKeyArgs(
            linked_service_name="string",
            secret_name="string",
            secret_version="string",
        ))
    
    const credentialServicePrincipalResource = new azure.datafactory.CredentialServicePrincipal("credentialServicePrincipalResource", {
        dataFactoryId: "string",
        servicePrincipalId: "string",
        tenantId: "string",
        annotations: ["string"],
        description: "string",
        name: "string",
        servicePrincipalKey: {
            linkedServiceName: "string",
            secretName: "string",
            secretVersion: "string",
        },
    });
    
    type: azure:datafactory:CredentialServicePrincipal
    properties:
        annotations:
            - string
        dataFactoryId: string
        description: string
        name: string
        servicePrincipalId: string
        servicePrincipalKey:
            linkedServiceName: string
            secretName: string
            secretVersion: string
        tenantId: string
    

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

    DataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    ServicePrincipalId string
    The Client ID of the Service Principal.
    TenantId string
    The Tenant ID of the Service Principal.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Credential.
    Description string
    The description for the Data Factory Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    ServicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    DataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    ServicePrincipalId string
    The Client ID of the Service Principal.
    TenantId string
    The Tenant ID of the Service Principal.
    Annotations []string
    List of tags that can be used for describing the Data Factory Credential.
    Description string
    The description for the Data Factory Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    ServicePrincipalKey CredentialServicePrincipalServicePrincipalKeyArgs
    A service_principal_key block as defined below.
    dataFactoryId String
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    servicePrincipalId String
    The Client ID of the Service Principal.
    tenantId String
    The Tenant ID of the Service Principal.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Credential.
    description String
    The description for the Data Factory Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    dataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    servicePrincipalId string
    The Client ID of the Service Principal.
    tenantId string
    The Tenant ID of the Service Principal.
    annotations string[]
    List of tags that can be used for describing the Data Factory Credential.
    description string
    The description for the Data Factory Credential.
    name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    data_factory_id str
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    service_principal_id str
    The Client ID of the Service Principal.
    tenant_id str
    The Tenant ID of the Service Principal.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Credential.
    description str
    The description for the Data Factory Credential.
    name str
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    service_principal_key CredentialServicePrincipalServicePrincipalKeyArgs
    A service_principal_key block as defined below.
    dataFactoryId String
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    servicePrincipalId String
    The Client ID of the Service Principal.
    tenantId String
    The Tenant ID of the Service Principal.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Credential.
    description String
    The description for the Data Factory Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalKey Property Map
    A service_principal_key block as defined below.

    Outputs

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

    Get an existing CredentialServicePrincipal 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?: CredentialServicePrincipalState, opts?: CustomResourceOptions): CredentialServicePrincipal
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            annotations: Optional[Sequence[str]] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            service_principal_id: Optional[str] = None,
            service_principal_key: Optional[CredentialServicePrincipalServicePrincipalKeyArgs] = None,
            tenant_id: Optional[str] = None) -> CredentialServicePrincipal
    func GetCredentialServicePrincipal(ctx *Context, name string, id IDInput, state *CredentialServicePrincipalState, opts ...ResourceOption) (*CredentialServicePrincipal, error)
    public static CredentialServicePrincipal Get(string name, Input<string> id, CredentialServicePrincipalState? state, CustomResourceOptions? opts = null)
    public static CredentialServicePrincipal get(String name, Output<String> id, CredentialServicePrincipalState 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:
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Credential.
    DataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    ServicePrincipalId string
    The Client ID of the Service Principal.
    ServicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    TenantId string
    The Tenant ID of the Service Principal.
    Annotations []string
    List of tags that can be used for describing the Data Factory Credential.
    DataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    ServicePrincipalId string
    The Client ID of the Service Principal.
    ServicePrincipalKey CredentialServicePrincipalServicePrincipalKeyArgs
    A service_principal_key block as defined below.
    TenantId string
    The Tenant ID of the Service Principal.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Credential.
    dataFactoryId String
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    description String
    The description for the Data Factory Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalId String
    The Client ID of the Service Principal.
    servicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    tenantId String
    The Tenant ID of the Service Principal.
    annotations string[]
    List of tags that can be used for describing the Data Factory Credential.
    dataFactoryId string
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    description string
    The description for the Data Factory Credential.
    name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalId string
    The Client ID of the Service Principal.
    servicePrincipalKey CredentialServicePrincipalServicePrincipalKey
    A service_principal_key block as defined below.
    tenantId string
    The Tenant ID of the Service Principal.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Credential.
    data_factory_id str
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    description str
    The description for the Data Factory Credential.
    name str
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    service_principal_id str
    The Client ID of the Service Principal.
    service_principal_key CredentialServicePrincipalServicePrincipalKeyArgs
    A service_principal_key block as defined below.
    tenant_id str
    The Tenant ID of the Service Principal.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Credential.
    dataFactoryId String
    The Data Factory ID in which to associate the Credential with. Changing this forces a new resource.
    description String
    The description for the Data Factory Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    servicePrincipalId String
    The Client ID of the Service Principal.
    servicePrincipalKey Property Map
    A service_principal_key block as defined below.
    tenantId String
    The Tenant ID of the Service Principal.

    Supporting Types

    CredentialServicePrincipalServicePrincipalKey, CredentialServicePrincipalServicePrincipalKeyArgs

    LinkedServiceName string
    The name of the Linked Service to use for the Service Principal Key.
    SecretName string
    The name of the Secret in the Key Vault.
    SecretVersion string
    The version of the Secret in the Key Vault.
    LinkedServiceName string
    The name of the Linked Service to use for the Service Principal Key.
    SecretName string
    The name of the Secret in the Key Vault.
    SecretVersion string
    The version of the Secret in the Key Vault.
    linkedServiceName String
    The name of the Linked Service to use for the Service Principal Key.
    secretName String
    The name of the Secret in the Key Vault.
    secretVersion String
    The version of the Secret in the Key Vault.
    linkedServiceName string
    The name of the Linked Service to use for the Service Principal Key.
    secretName string
    The name of the Secret in the Key Vault.
    secretVersion string
    The version of the Secret in the Key Vault.
    linked_service_name str
    The name of the Linked Service to use for the Service Principal Key.
    secret_name str
    The name of the Secret in the Key Vault.
    secret_version str
    The version of the Secret in the Key Vault.
    linkedServiceName String
    The name of the Linked Service to use for the Service Principal Key.
    secretName String
    The name of the Secret in the Key Vault.
    secretVersion String
    The version of the Secret in the Key Vault.

    Import

    Data Factory Credentials can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/credentialServicePrincipal:CredentialServicePrincipal example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.DataFactory/factories/example/credentials/credential1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.79.0 published on Tuesday, May 28, 2024 by Pulumi