Share via

Microsoft.DataFactory factories/credentials

  • Article

Bicep resource definition

The factories/credentials resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/credentials resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/credentials@2018-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    annotations: [
      any
    ]
    description: 'string'
    type: 'string'
    typeProperties: {
      resourceId: 'string'
    }
    {customized property}: any()
  }
}

Property values

factories/credentials

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: factories
properties Managed Identity Credential properties. ManagedIdentityCredential (required)

ManagedIdentityCredential

Name Description Value
annotations List of tags that can be used for describing the Credential. any[]
description Credential description. string
type Type of credential. string (required)
typeProperties Managed identity credential properties. ManagedIdentityTypeProperties
{customized property} For Bicep, you can use the any() function.

ManagedIdentityTypeProperties

Name Description Value
resourceId The resource id of user assigned managed identity string

ARM template resource definition

The factories/credentials resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/credentials resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/credentials",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ object ],
    "description": "string",
    "type": "string",
    "typeProperties": {
      "resourceId": "string"
    },
    "{customized property}": {}
  }
}

Property values

factories/credentials

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/credentials'
apiVersion The resource api version '2018-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Managed Identity Credential properties. ManagedIdentityCredential (required)

ManagedIdentityCredential

Name Description Value
annotations List of tags that can be used for describing the Credential. any[]
description Credential description. string
type Type of credential. string (required)
typeProperties Managed identity credential properties. ManagedIdentityTypeProperties
{customized property}

ManagedIdentityTypeProperties

Name Description Value
resourceId The resource id of user assigned managed identity string

Terraform (AzAPI provider) resource definition

The factories/credentials resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/credentials resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/credentials@2018-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      annotations = [ object ]
      description = "string"
      type = "string"
      typeProperties = {
        resourceId = "string"
      }
    }
  })
}

Property values

factories/credentials

Name Description Value
type The resource type "Microsoft.DataFactory/factories/credentials@2018-06-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Managed Identity Credential properties. ManagedIdentityCredential (required)

ManagedIdentityCredential

Name Description Value
annotations List of tags that can be used for describing the Credential. any[]
description Credential description. string
type Type of credential. string (required)
typeProperties Managed identity credential properties. ManagedIdentityTypeProperties
{customized property}

ManagedIdentityTypeProperties

Name Description Value
resourceId The resource id of user assigned managed identity string