Get-AzureRmDataFactoryV2IntegrationRuntimeKey
Gets keys for a self-hosted integration runtime.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmDataFactoryV2IntegrationRuntimeKey
[-Name] <String>
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntimeKey
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntimeKey
[-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
PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntimeKey -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.
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: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
The integration runtime object.
Type: | PSIntegrationRuntime |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The integration runtime name.
Type: | String |
Aliases: | IntegrationRuntimeName |
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 |
-ResourceId
The Azure resource ID.
Type: | String |
Aliases: | Id |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: InputObject (ByValue)