Update-AzDataFactoryV2

Reference

Module:: Az.DataFactory

Updates the properties of a data factory.

Syntax

Update-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>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-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>
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDataFactoryV2
      [-IdentityType <String>]
      [-PublicNetworkAccess <String>]
      [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>]
      [-EncryptionVaultBaseUrl <String>]
      [-EncryptionKeyName <String>]
      [-EncryptionKeyVersion <String>]
      [-EncryptionUserAssignedIdentity <String>]
      [-ResourceId] <String>
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzDataFactoryV2 cmdlet updates tags or identity properties of a data factory.

Examples

Example 1

Update-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Tag @{myNewTagName = "myTagValue"}

Confirm
Are you sure you want to update properties of the data factory 'WikiADF' in resource group 'ADF'?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y


DataFactoryName   : WikiADF
DataFactoryId     : /subscriptions/1e42591f-1f0c-4c5a-b7f2-a268f6105ec5/resourceGroups/adf/providers/Microsoft.DataF
                    actory/factories/wikiadf
ResourceGroupName : ADF
Location          : EastUS
Tags              : {[myNewTagName, myTagValue]}
Identity          :
ProvisioningState : Succeeded

This command updates the tags for the factory WikiADF to a dictionary containing a tag named myNewTagName with value myTagValue.

Parameters

-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

-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

-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:	0
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:	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

-ResourceGroupName

The resource group name.

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

-ResourceId

The Azure resource ID.

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

-Tag

The tags of the data factory.

Type:	Hashtable
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 would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

PSDataFactory

String

Outputs