Edit

Share via

Get-AzDataFactoryV2IntegrationRuntimeKey

Module:
Az.DataFactory Module

Gets keys for a self-hosted integration runtime.

Syntax

ByIntegrationRuntimeName (Default) 

Get-AzDataFactoryV2IntegrationRuntimeKey
    [-Name] <String>
    [-ResourceGroupName] <String>
    [-DataFactoryName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceId 

Get-AzDataFactoryV2IntegrationRuntimeKey
    [-ResourceId] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByIntegrationRuntimeObject 

Get-AzDataFactoryV2IntegrationRuntimeKey
    [-InputObject] <PSIntegrationRuntime>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Get keys for an integration runtime. The keys are used to register an integration runtime node.

Examples

Example 1: Get integration runtime keys

Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir'

AuthKey1                                                 AuthKey2
--------                                                 --------
IR@89895504-f647-48fd-8dd3-42fa556d67e3******            IR@89895504-f647-48fd-8dd3-42fa556d67e3****

The cmdlet retrieves keys for an integration runtime named 'test-selfhost-ir'.

Parameters

-DataFactoryName

The data factory name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIntegrationRuntimeName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

The integration runtime object.

Parameter properties

Type:PSIntegrationRuntime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIntegrationRuntimeObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The integration runtime name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IntegrationRuntimeName

Parameter sets

ByIntegrationRuntimeName
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIntegrationRuntimeName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceId

The Azure resource ID.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

ByResourceId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSIntegrationRuntime

Outputs

PSIntegrationRuntimeKeys