azure-native.datafactory.CredentialOperation
Explore with Pulumi AI
Credential resource type. Azure REST API version: 2018-06-01. Prior API version in Azure Native 1.x: 2018-06-01.
Example Usage
Credentials_Create
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var credentialOperation = new AzureNative.DataFactory.CredentialOperation("credentialOperation", new()
    {
        CredentialName = "exampleCredential",
        FactoryName = "exampleFactoryName",
        Properties = new AzureNative.DataFactory.Inputs.ManagedIdentityCredentialArgs
        {
            ResourceId = "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami",
            Type = "ManagedIdentity",
        },
        ResourceGroupName = "exampleResourceGroup",
    });
});
package main
import (
	datafactory "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datafactory.NewCredentialOperation(ctx, "credentialOperation", &datafactory.CredentialOperationArgs{
			CredentialName: pulumi.String("exampleCredential"),
			FactoryName:    pulumi.String("exampleFactoryName"),
			Properties: &datafactory.ManagedIdentityCredentialArgs{
				ResourceId: pulumi.String("/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"),
				Type:       pulumi.String("ManagedIdentity"),
			},
			ResourceGroupName: pulumi.String("exampleResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datafactory.CredentialOperation;
import com.pulumi.azurenative.datafactory.CredentialOperationArgs;
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) {
        var credentialOperation = new CredentialOperation("credentialOperation", CredentialOperationArgs.builder()
            .credentialName("exampleCredential")
            .factoryName("exampleFactoryName")
            .properties(ManagedIdentityCredentialArgs.builder()
                .resourceId("/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami")
                .type("ManagedIdentity")
                .build())
            .resourceGroupName("exampleResourceGroup")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const credentialOperation = new azure_native.datafactory.CredentialOperation("credentialOperation", {
    credentialName: "exampleCredential",
    factoryName: "exampleFactoryName",
    properties: {
        resourceId: "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami",
        type: "ManagedIdentity",
    },
    resourceGroupName: "exampleResourceGroup",
});
import pulumi
import pulumi_azure_native as azure_native
credential_operation = azure_native.datafactory.CredentialOperation("credentialOperation",
    credential_name="exampleCredential",
    factory_name="exampleFactoryName",
    properties={
        "resource_id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami",
        "type": "ManagedIdentity",
    },
    resource_group_name="exampleResourceGroup")
resources:
  credentialOperation:
    type: azure-native:datafactory:CredentialOperation
    properties:
      credentialName: exampleCredential
      factoryName: exampleFactoryName
      properties:
        resourceId: /subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami
        type: ManagedIdentity
      resourceGroupName: exampleResourceGroup
Create CredentialOperation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CredentialOperation(name: string, args: CredentialOperationArgs, opts?: CustomResourceOptions);@overload
def CredentialOperation(resource_name: str,
                        args: CredentialOperationArgs,
                        opts: Optional[ResourceOptions] = None)
@overload
def CredentialOperation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        factory_name: Optional[str] = None,
                        properties: Optional[Union[ManagedIdentityCredentialArgs, ServicePrincipalCredentialArgs]] = None,
                        resource_group_name: Optional[str] = None,
                        credential_name: Optional[str] = None)func NewCredentialOperation(ctx *Context, name string, args CredentialOperationArgs, opts ...ResourceOption) (*CredentialOperation, error)public CredentialOperation(string name, CredentialOperationArgs args, CustomResourceOptions? opts = null)
public CredentialOperation(String name, CredentialOperationArgs args)
public CredentialOperation(String name, CredentialOperationArgs args, CustomResourceOptions options)
type: azure-native:datafactory:CredentialOperation
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 CredentialOperationArgs
- 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 CredentialOperationArgs
- 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 CredentialOperationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CredentialOperationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CredentialOperationArgs
- 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 credentialOperationResource = new AzureNative.DataFactory.CredentialOperation("credentialOperationResource", new()
{
    FactoryName = "string",
    Properties = new AzureNative.DataFactory.Inputs.ManagedIdentityCredentialArgs
    {
        Type = "ManagedIdentity",
        Annotations = new[]
        {
            "any",
        },
        Description = "string",
        ResourceId = "string",
    },
    ResourceGroupName = "string",
    CredentialName = "string",
});
example, err := datafactory.NewCredentialOperation(ctx, "credentialOperationResource", &datafactory.CredentialOperationArgs{
	FactoryName: pulumi.String("string"),
	Properties: &datafactory.ManagedIdentityCredentialArgs{
		Type: pulumi.String("ManagedIdentity"),
		Annotations: pulumi.Array{
			pulumi.Any("any"),
		},
		Description: pulumi.String("string"),
		ResourceId:  pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	CredentialName:    pulumi.String("string"),
})
var credentialOperationResource = new CredentialOperation("credentialOperationResource", CredentialOperationArgs.builder()
    .factoryName("string")
    .properties(ManagedIdentityCredentialArgs.builder()
        .type("ManagedIdentity")
        .annotations("any")
        .description("string")
        .resourceId("string")
        .build())
    .resourceGroupName("string")
    .credentialName("string")
    .build());
credential_operation_resource = azure_native.datafactory.CredentialOperation("credentialOperationResource",
    factory_name="string",
    properties={
        "type": "ManagedIdentity",
        "annotations": ["any"],
        "description": "string",
        "resource_id": "string",
    },
    resource_group_name="string",
    credential_name="string")
const credentialOperationResource = new azure_native.datafactory.CredentialOperation("credentialOperationResource", {
    factoryName: "string",
    properties: {
        type: "ManagedIdentity",
        annotations: ["any"],
        description: "string",
        resourceId: "string",
    },
    resourceGroupName: "string",
    credentialName: "string",
});
type: azure-native:datafactory:CredentialOperation
properties:
    credentialName: string
    factoryName: string
    properties:
        annotations:
            - any
        description: string
        resourceId: string
        type: ManagedIdentity
    resourceGroupName: string
CredentialOperation 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 CredentialOperation resource accepts the following input properties:
- FactoryName string
- The factory name.
- Properties
Pulumi.Azure | Pulumi.Native. Data Factory. Inputs. Managed Identity Credential Azure Native. Data Factory. Inputs. Service Principal Credential 
- Properties of credentials.
- ResourceGroup stringName 
- The resource group name.
- CredentialName string
- Credential name
- FactoryName string
- The factory name.
- Properties
ManagedIdentity | ServiceCredential Args Principal Credential Args 
- Properties of credentials.
- ResourceGroup stringName 
- The resource group name.
- CredentialName string
- Credential name
- factoryName String
- The factory name.
- properties
ManagedIdentity | ServiceCredential Principal Credential 
- Properties of credentials.
- resourceGroup StringName 
- The resource group name.
- credentialName String
- Credential name
- factoryName string
- The factory name.
- properties
ManagedIdentity | ServiceCredential Principal Credential 
- Properties of credentials.
- resourceGroup stringName 
- The resource group name.
- credentialName string
- Credential name
- factory_name str
- The factory name.
- properties
ManagedIdentity | ServiceCredential Args Principal Credential Args 
- Properties of credentials.
- resource_group_ strname 
- The resource group name.
- credential_name str
- Credential name
- factoryName String
- The factory name.
- properties Property Map | Property Map
- Properties of credentials.
- resourceGroup StringName 
- The resource group name.
- credentialName String
- Credential name
Outputs
All input properties are implicitly available as output properties. Additionally, the CredentialOperation resource produces the following output properties:
Supporting Types
AzureKeyVaultSecretReference, AzureKeyVaultSecretReferenceArgs          
- SecretName object
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- Store
Pulumi.Azure Native. Data Factory. Inputs. Linked Service Reference 
- The Azure Key Vault linked service reference.
- SecretVersion object
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- SecretName interface{}
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- Store
LinkedService Reference 
- The Azure Key Vault linked service reference.
- SecretVersion interface{}
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName Object
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference 
- The Azure Key Vault linked service reference.
- secretVersion Object
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference 
- The Azure Key Vault linked service reference.
- secretVersion any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secret_name Any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference 
- The Azure Key Vault linked service reference.
- secret_version Any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName Any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store Property Map
- The Azure Key Vault linked service reference.
- secretVersion Any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
AzureKeyVaultSecretReferenceResponse, AzureKeyVaultSecretReferenceResponseArgs            
- SecretName object
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- Store
Pulumi.Azure Native. Data Factory. Inputs. Linked Service Reference Response 
- The Azure Key Vault linked service reference.
- SecretVersion object
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- SecretName interface{}
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- Store
LinkedService Reference Response 
- The Azure Key Vault linked service reference.
- SecretVersion interface{}
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName Object
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference Response 
- The Azure Key Vault linked service reference.
- secretVersion Object
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference Response 
- The Azure Key Vault linked service reference.
- secretVersion any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secret_name Any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store
LinkedService Reference Response 
- The Azure Key Vault linked service reference.
- secret_version Any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
- secretName Any
- The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
- store Property Map
- The Azure Key Vault linked service reference.
- secretVersion Any
- The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
LinkedServiceReference, LinkedServiceReferenceArgs      
- ReferenceName string
- Reference LinkedService name.
- Type
string | Pulumi.Azure Native. Data Factory. Type 
- Linked service reference type.
- Parameters Dictionary<string, object>
- Arguments for LinkedService.
- ReferenceName string
- Reference LinkedService name.
- Type string | Type
- Linked service reference type.
- Parameters map[string]interface{}
- Arguments for LinkedService.
- referenceName String
- Reference LinkedService name.
- type String | Type
- Linked service reference type.
- parameters Map<String,Object>
- Arguments for LinkedService.
- referenceName string
- Reference LinkedService name.
- type string | Type
- Linked service reference type.
- parameters {[key: string]: any}
- Arguments for LinkedService.
- reference_name str
- Reference LinkedService name.
- type str | Type
- Linked service reference type.
- parameters Mapping[str, Any]
- Arguments for LinkedService.
- referenceName String
- Reference LinkedService name.
- type
String | "LinkedService Reference" 
- Linked service reference type.
- parameters Map<Any>
- Arguments for LinkedService.
LinkedServiceReferenceResponse, LinkedServiceReferenceResponseArgs        
- ReferenceName string
- Reference LinkedService name.
- Type string
- Linked service reference type.
- Parameters Dictionary<string, object>
- Arguments for LinkedService.
- ReferenceName string
- Reference LinkedService name.
- Type string
- Linked service reference type.
- Parameters map[string]interface{}
- Arguments for LinkedService.
- referenceName String
- Reference LinkedService name.
- type String
- Linked service reference type.
- parameters Map<String,Object>
- Arguments for LinkedService.
- referenceName string
- Reference LinkedService name.
- type string
- Linked service reference type.
- parameters {[key: string]: any}
- Arguments for LinkedService.
- reference_name str
- Reference LinkedService name.
- type str
- Linked service reference type.
- parameters Mapping[str, Any]
- Arguments for LinkedService.
- referenceName String
- Reference LinkedService name.
- type String
- Linked service reference type.
- parameters Map<Any>
- Arguments for LinkedService.
ManagedIdentityCredential, ManagedIdentityCredentialArgs      
- Annotations List<object>
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ResourceId string
- The resource id of user assigned managed identity
- Annotations []interface{}
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ResourceId string
- The resource id of user assigned managed identity
- annotations List<Object>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- resourceId String
- The resource id of user assigned managed identity
- annotations any[]
- List of tags that can be used for describing the Credential.
- description string
- Credential description.
- resourceId string
- The resource id of user assigned managed identity
- annotations Sequence[Any]
- List of tags that can be used for describing the Credential.
- description str
- Credential description.
- resource_id str
- The resource id of user assigned managed identity
- annotations List<Any>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- resourceId String
- The resource id of user assigned managed identity
ManagedIdentityCredentialResponse, ManagedIdentityCredentialResponseArgs        
- Annotations List<object>
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ResourceId string
- The resource id of user assigned managed identity
- Annotations []interface{}
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ResourceId string
- The resource id of user assigned managed identity
- annotations List<Object>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- resourceId String
- The resource id of user assigned managed identity
- annotations any[]
- List of tags that can be used for describing the Credential.
- description string
- Credential description.
- resourceId string
- The resource id of user assigned managed identity
- annotations Sequence[Any]
- List of tags that can be used for describing the Credential.
- description str
- Credential description.
- resource_id str
- The resource id of user assigned managed identity
- annotations List<Any>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- resourceId String
- The resource id of user assigned managed identity
ServicePrincipalCredential, ServicePrincipalCredentialArgs      
- Annotations List<object>
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ServicePrincipal objectId 
- The app ID of the service principal used to authenticate
- ServicePrincipal Pulumi.Key Azure Native. Data Factory. Inputs. Azure Key Vault Secret Reference 
- The key of the service principal used to authenticate.
- Tenant object
- The ID of the tenant to which the service principal belongs
- Annotations []interface{}
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ServicePrincipal interface{}Id 
- The app ID of the service principal used to authenticate
- ServicePrincipal AzureKey Key Vault Secret Reference 
- The key of the service principal used to authenticate.
- Tenant interface{}
- The ID of the tenant to which the service principal belongs
- annotations List<Object>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- servicePrincipal ObjectId 
- The app ID of the service principal used to authenticate
- servicePrincipal AzureKey Key Vault Secret Reference 
- The key of the service principal used to authenticate.
- tenant Object
- The ID of the tenant to which the service principal belongs
- annotations any[]
- List of tags that can be used for describing the Credential.
- description string
- Credential description.
- servicePrincipal anyId 
- The app ID of the service principal used to authenticate
- servicePrincipal AzureKey Key Vault Secret Reference 
- The key of the service principal used to authenticate.
- tenant any
- The ID of the tenant to which the service principal belongs
- annotations Sequence[Any]
- List of tags that can be used for describing the Credential.
- description str
- Credential description.
- service_principal_ Anyid 
- The app ID of the service principal used to authenticate
- service_principal_ Azurekey Key Vault Secret Reference 
- The key of the service principal used to authenticate.
- tenant Any
- The ID of the tenant to which the service principal belongs
- annotations List<Any>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- servicePrincipal AnyId 
- The app ID of the service principal used to authenticate
- servicePrincipal Property MapKey 
- The key of the service principal used to authenticate.
- tenant Any
- The ID of the tenant to which the service principal belongs
ServicePrincipalCredentialResponse, ServicePrincipalCredentialResponseArgs        
- Annotations List<object>
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ServicePrincipal objectId 
- The app ID of the service principal used to authenticate
- ServicePrincipal Pulumi.Key Azure Native. Data Factory. Inputs. Azure Key Vault Secret Reference Response 
- The key of the service principal used to authenticate.
- Tenant object
- The ID of the tenant to which the service principal belongs
- Annotations []interface{}
- List of tags that can be used for describing the Credential.
- Description string
- Credential description.
- ServicePrincipal interface{}Id 
- The app ID of the service principal used to authenticate
- ServicePrincipal AzureKey Key Vault Secret Reference Response 
- The key of the service principal used to authenticate.
- Tenant interface{}
- The ID of the tenant to which the service principal belongs
- annotations List<Object>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- servicePrincipal ObjectId 
- The app ID of the service principal used to authenticate
- servicePrincipal AzureKey Key Vault Secret Reference Response 
- The key of the service principal used to authenticate.
- tenant Object
- The ID of the tenant to which the service principal belongs
- annotations any[]
- List of tags that can be used for describing the Credential.
- description string
- Credential description.
- servicePrincipal anyId 
- The app ID of the service principal used to authenticate
- servicePrincipal AzureKey Key Vault Secret Reference Response 
- The key of the service principal used to authenticate.
- tenant any
- The ID of the tenant to which the service principal belongs
- annotations Sequence[Any]
- List of tags that can be used for describing the Credential.
- description str
- Credential description.
- service_principal_ Anyid 
- The app ID of the service principal used to authenticate
- service_principal_ Azurekey Key Vault Secret Reference Response 
- The key of the service principal used to authenticate.
- tenant Any
- The ID of the tenant to which the service principal belongs
- annotations List<Any>
- List of tags that can be used for describing the Credential.
- description String
- Credential description.
- servicePrincipal AnyId 
- The app ID of the service principal used to authenticate
- servicePrincipal Property MapKey 
- The key of the service principal used to authenticate.
- tenant Any
- The ID of the tenant to which the service principal belongs
Type, TypeArgs  
- LinkedService Reference 
- LinkedServiceReference
- TypeLinked Service Reference 
- LinkedServiceReference
- LinkedService Reference 
- LinkedServiceReference
- LinkedService Reference 
- LinkedServiceReference
- LINKED_SERVICE_REFERENCE
- LinkedServiceReference
- "LinkedService Reference" 
- LinkedServiceReference
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:datafactory:CredentialOperation exampleCredential /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0