New-AzDataFactoryV2LinkedServiceEncryptedCredential

Reference

Module:: Az.DataFactory

Encrypt credential in linked service with specified integration runtime.

Syntax

New-AzDataFactoryV2LinkedServiceEncryptedCredential
   [-IntegrationRuntimeName] <String>
   [-DefinitionFile] <String>
   [-Force]
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataFactoryV2LinkedServiceEncryptedCredential
   [-IntegrationRuntimeName] <String>
   [-DefinitionFile] <String>
   [-Force]
   [-DataFactory] <PSDataFactory>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDataFactoryV2LinkedServiceEncryptedCredential cmdlet encrypt credential in linked service with specified integration runtime.

Please ensure the following prerequisites are met:

Remote access option is enabled on the self-hosted integration runtime.
Powershell 7.0 or higher is used to execute the cmdlet.

Examples

Example 1: Encrypt credentials in a linked service

This command encrypts credential in file C:\samples\WikiSample\TaxiDemo1.json with the integration runtime named test-selfhost-ir.

New-AzDataFactoryV2LinkedServiceEncryptedCredential -DataFactoryName WikiADF -DefinitionFile 'C:\samples\WikiSample\TaxiDemo1.json' -IntegrationRuntimeName 'test-selfhost-ir' -ResourceGroupName MyResourceGroup

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

-DataFactory

The data factory object.

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

-DataFactoryName

The data factory name.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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

-DefinitionFile

The JSON file path.

Type:	String
Aliases:	File
Position:	3
Default value:	None
Required:	True
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

-IntegrationRuntimeName

The integration runtime name.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
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

-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

Outputs