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

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.datafactory.CredentialUserManagedIdentity

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Create CredentialUserManagedIdentity Resource

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

    Constructor syntax

    new CredentialUserManagedIdentity(name: string, args: CredentialUserManagedIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def CredentialUserManagedIdentity(resource_name: str,
                                      args: CredentialUserManagedIdentityArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def CredentialUserManagedIdentity(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      data_factory_id: Optional[str] = None,
                                      identity_id: Optional[str] = None,
                                      annotations: Optional[Sequence[str]] = None,
                                      description: Optional[str] = None,
                                      name: Optional[str] = None)
    func NewCredentialUserManagedIdentity(ctx *Context, name string, args CredentialUserManagedIdentityArgs, opts ...ResourceOption) (*CredentialUserManagedIdentity, error)
    public CredentialUserManagedIdentity(string name, CredentialUserManagedIdentityArgs args, CustomResourceOptions? opts = null)
    public CredentialUserManagedIdentity(String name, CredentialUserManagedIdentityArgs args)
    public CredentialUserManagedIdentity(String name, CredentialUserManagedIdentityArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:CredentialUserManagedIdentity
    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 CredentialUserManagedIdentityArgs
    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 CredentialUserManagedIdentityArgs
    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 CredentialUserManagedIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CredentialUserManagedIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CredentialUserManagedIdentityArgs
    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 credentialUserManagedIdentityResource = new Azure.DataFactory.CredentialUserManagedIdentity("credentialUserManagedIdentityResource", new()
    {
        DataFactoryId = "string",
        IdentityId = "string",
        Annotations = new[]
        {
            "string",
        },
        Description = "string",
        Name = "string",
    });
    
    example, err := datafactory.NewCredentialUserManagedIdentity(ctx, "credentialUserManagedIdentityResource", &datafactory.CredentialUserManagedIdentityArgs{
    	DataFactoryId: pulumi.String("string"),
    	IdentityId:    pulumi.String("string"),
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var credentialUserManagedIdentityResource = new CredentialUserManagedIdentity("credentialUserManagedIdentityResource", CredentialUserManagedIdentityArgs.builder()
        .dataFactoryId("string")
        .identityId("string")
        .annotations("string")
        .description("string")
        .name("string")
        .build());
    
    credential_user_managed_identity_resource = azure.datafactory.CredentialUserManagedIdentity("credentialUserManagedIdentityResource",
        data_factory_id="string",
        identity_id="string",
        annotations=["string"],
        description="string",
        name="string")
    
    const credentialUserManagedIdentityResource = new azure.datafactory.CredentialUserManagedIdentity("credentialUserManagedIdentityResource", {
        dataFactoryId: "string",
        identityId: "string",
        annotations: ["string"],
        description: "string",
        name: "string",
    });
    
    type: azure:datafactory:CredentialUserManagedIdentity
    properties:
        annotations:
            - string
        dataFactoryId: string
        description: string
        identityId: string
        name: string
    

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

    DataFactoryId string
    The resource ID of the parent Data Factory
    IdentityId string
    The resource ID of the User Assigned Managed Identity
    Annotations List<string>
    (Optional) List of string annotations.
    Description string
    (Optional) Short text description
    Name string
    The desired name of the credential resource
    DataFactoryId string
    The resource ID of the parent Data Factory
    IdentityId string
    The resource ID of the User Assigned Managed Identity
    Annotations []string
    (Optional) List of string annotations.
    Description string
    (Optional) Short text description
    Name string
    The desired name of the credential resource
    dataFactoryId String
    The resource ID of the parent Data Factory
    identityId String
    The resource ID of the User Assigned Managed Identity
    annotations List<String>
    (Optional) List of string annotations.
    description String
    (Optional) Short text description
    name String
    The desired name of the credential resource
    dataFactoryId string
    The resource ID of the parent Data Factory
    identityId string
    The resource ID of the User Assigned Managed Identity
    annotations string[]
    (Optional) List of string annotations.
    description string
    (Optional) Short text description
    name string
    The desired name of the credential resource
    data_factory_id str
    The resource ID of the parent Data Factory
    identity_id str
    The resource ID of the User Assigned Managed Identity
    annotations Sequence[str]
    (Optional) List of string annotations.
    description str
    (Optional) Short text description
    name str
    The desired name of the credential resource
    dataFactoryId String
    The resource ID of the parent Data Factory
    identityId String
    The resource ID of the User Assigned Managed Identity
    annotations List<String>
    (Optional) List of string annotations.
    description String
    (Optional) Short text description
    name String
    The desired name of the credential resource

    Outputs

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

    Get an existing CredentialUserManagedIdentity 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?: CredentialUserManagedIdentityState, opts?: CustomResourceOptions): CredentialUserManagedIdentity
    @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,
            identity_id: Optional[str] = None,
            name: Optional[str] = None) -> CredentialUserManagedIdentity
    func GetCredentialUserManagedIdentity(ctx *Context, name string, id IDInput, state *CredentialUserManagedIdentityState, opts ...ResourceOption) (*CredentialUserManagedIdentity, error)
    public static CredentialUserManagedIdentity Get(string name, Input<string> id, CredentialUserManagedIdentityState? state, CustomResourceOptions? opts = null)
    public static CredentialUserManagedIdentity get(String name, Output<String> id, CredentialUserManagedIdentityState 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>
    (Optional) List of string annotations.
    DataFactoryId string
    The resource ID of the parent Data Factory
    Description string
    (Optional) Short text description
    IdentityId string
    The resource ID of the User Assigned Managed Identity
    Name string
    The desired name of the credential resource
    Annotations []string
    (Optional) List of string annotations.
    DataFactoryId string
    The resource ID of the parent Data Factory
    Description string
    (Optional) Short text description
    IdentityId string
    The resource ID of the User Assigned Managed Identity
    Name string
    The desired name of the credential resource
    annotations List<String>
    (Optional) List of string annotations.
    dataFactoryId String
    The resource ID of the parent Data Factory
    description String
    (Optional) Short text description
    identityId String
    The resource ID of the User Assigned Managed Identity
    name String
    The desired name of the credential resource
    annotations string[]
    (Optional) List of string annotations.
    dataFactoryId string
    The resource ID of the parent Data Factory
    description string
    (Optional) Short text description
    identityId string
    The resource ID of the User Assigned Managed Identity
    name string
    The desired name of the credential resource
    annotations Sequence[str]
    (Optional) List of string annotations.
    data_factory_id str
    The resource ID of the parent Data Factory
    description str
    (Optional) Short text description
    identity_id str
    The resource ID of the User Assigned Managed Identity
    name str
    The desired name of the credential resource
    annotations List<String>
    (Optional) List of string annotations.
    dataFactoryId String
    The resource ID of the parent Data Factory
    description String
    (Optional) Short text description
    identityId String
    The resource ID of the User Assigned Managed Identity
    name String
    The desired name of the credential resource

    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.84.0 published on Tuesday, Jul 16, 2024 by Pulumi