Edit

Share via

Set-AzDataFactoryV2

  • Reference
Module:
Az.DataFactory

Creates a data factory.

Syntax

Set-AzDataFactoryV2
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   [-DisablePublish]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-ResourceId] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   [-DisablePublish]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-ResourceId] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   -AccountName <String>
   -RepositoryName <String>
   -CollaborationBranch <String>
   -RootFolder <String>
   [-LastCommitId <String>]
   [-DisablePublish]
   -ProjectName <String>
   [-TenantId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-ResourceId] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   -AccountName <String>
   -RepositoryName <String>
   -CollaborationBranch <String>
   -RootFolder <String>
   [-LastCommitId <String>]
   [-DisablePublish]
   -HostName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   -AccountName <String>
   -RepositoryName <String>
   -CollaborationBranch <String>
   -RootFolder <String>
   [-LastCommitId <String>]
   [-DisablePublish]
   -HostName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   [-Location] <String>
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   -AccountName <String>
   -RepositoryName <String>
   -CollaborationBranch <String>
   -RootFolder <String>
   [-LastCommitId <String>]
   [-DisablePublish]
   -ProjectName <String>
   [-TenantId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   -InputObject <PSDataFactory>
   [[-Location] <String>]
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   [-DisablePublish]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   -InputObject <PSDataFactory>
   [[-Location] <String>]
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   [-AccountName <String>]
   [-RepositoryName <String>]
   [-CollaborationBranch <String>]
   [-RootFolder <String>]
   [-LastCommitId <String>]
   [-DisablePublish]
   -ProjectName <String>
   [-TenantId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2
   [-IdentityType <String>]
   [-PublicNetworkAccess <String>]
   [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
   [-EncryptionVaultBaseUrl <String>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyVersion <String>]
   [-EncryptionUserAssignedIdentity <String>]
   -InputObject <PSDataFactory>
   [[-Location] <String>]
   [[-Tag] <Hashtable>]
   [-Force]
   [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>]
   [-AccountName <String>]
   [-RepositoryName <String>]
   [-CollaborationBranch <String>]
   [-RootFolder <String>]
   [-LastCommitId <String>]
   [-DisablePublish]
   -HostName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzDataFactoryV2 cmdlet creates a data factory with the specified resource group name and location. Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline.

Examples

Example 1: Create a data factory

Set-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS"

DataFactoryName   : WikiADF
    DataFactoryId     : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf
    ResourceGroupName : ADF
    Location          : EastUS
    Tags              : {}
    Identity          : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity
    ProvisioningState : Succeeded
    RepoConfiguration :

Example 2: Create a data factory with repo configuration details using an existing factory object.

Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" | Set-AzDataFactoryV2 -AccountName msdata -RepositoryName ADFRepo -CollaborationBranch master -RootFolder / -ProjectName "Azure Data Factory"

DataFactoryName   : WikiADF
    DataFactoryId     : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf
    ResourceGroupName : ADF
    Location          : EastUS
    Tags              : {}
    Identity          : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity
    ProvisioningState : Succeeded
    RepoConfiguration : Microsoft.Azure.Management.DataFactory.Models.FactoryVSTSConfiguration

This command creates a data factory named WikiADF in the resource group named ADF in the EastUS location with Azure DevOps source control configuration.

Example 3: Create a data factory with GitHub repo configuration details using a new factory object.

Set-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Location 'EastUS' -HostName 'https://github.com' -AccountName msdata -RepositoryName ADFRepo -CollaborationBranch master -RootFolder /

DataFactoryName   : WikiADF
    DataFactoryId     : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf
    ResourceGroupName : ADF
    Location          : EastUS
    Tags              : {}
    Identity          : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity
    ProvisioningState : Succeeded
    RepoConfiguration : Microsoft.Azure.Management.DataFactory.Models.FactoryGitHubConfiguration

This command creates a data factory named WikiADF in the resource group named ADF in the EastUS location with GitHub source control configuration..

Parameters

-AccountName

The account name for repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-CollaborationBranch

The collaboration branch for repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisablePublish

Disable manual publish operation in ADF studio to favor automated publish.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionKeyName

The name of the key in Azure Key Vault to use as Customer Managed Key for encryption.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionKeyVersion

The version of the key used for CMK. If not provided, latest version will be used.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionUserAssignedIdentity

User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionVaultBaseUrl

The url of the Azure Key Vault used for encryption with CMK.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Runs the cmdlet without prompting for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GlobalParameterDefinition

The dictionary containing the global parameters of the data factory.

Type:IDictionary<TKey,TValue>[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostName

The host name for GitHub repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

The Identity type that will be associated with your DataFactory. Options are 'SystemAssigned', 'UserAssigned' or 'SystemAssigned,UserAssigned'

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The data factory object.

Type:PSDataFactory
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LastCommitId

The last commit id for repo configuration.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The data factory is created in this region.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The data factory name.

Type:String
Aliases:DataFactoryName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProjectName

The project name Azure DevOps for repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PublicNetworkAccess

Whether or not public network access is allowed for the data factory. Options are 'Enabled' or 'Disabled'

Type:String
Position:Named
Default value:Enabled
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RepositoryName

The repository name for repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

The Azure resource ID of V2 data factory.

Type:String
Aliases:Id, DataFactoryId
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RootFolder

The root folder for repo configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Tag

The tags of the data factory.

Type:Hashtable
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TenantId

The tenant id for Azure DevOps repo configuration.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserAssignedIdentity

The dictionary containing the user assigned identities of the data factory.

Type:IDictionary<TKey,TValue>[System.String,System.Object]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

PSDataFactory

Hashtable

Outputs

PSDataFactory

Notes

Keywords: azure, azurerm, arm, resource, management, manager, data, factories