< Back
New-AzureRmDataFactoryV2IntegrationRuntimeKey
Post
NAME New-AzureRmDataFactoryV2IntegrationRuntimeKey
SYNOPSIS
Regenerate self-hosted integration runtime key.
SYNTAX
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] -KeyName {AuthKey1 | AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyName
{AuthKey1 | AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyName {AuthKey1 |
AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The cmdlet New-AzureRmDataFactoryV2IntegrationRuntimeKey regenerates the integration runtime key with the key name specified by 'KeyName'
parameter. The previous key will is invalid.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-KeyName <String>
The authentication key name of the self-hosted integration runtime.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys
NOTES
Example 1: Generate a new key for an integration runtime
PS C:\\> New-AzureRmDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir'
-KeyName authKey2
AuthKey1 AuthKey2
-------- --------
IR@89895504-f647-48fd-8dd3-42fa556d67e3@***
The cmdlet regenerates key 'authKey2' for integration runtime named 'test-selfhost-ir'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... runtimekey
Get-AzureRmDataFactoryV2IntegrationRuntimeKey
SYNOPSIS
Regenerate self-hosted integration runtime key.
SYNTAX
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] -KeyName {AuthKey1 | AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyName
{AuthKey1 | AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyName {AuthKey1 |
AuthKey2} [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The cmdlet New-AzureRmDataFactoryV2IntegrationRuntimeKey regenerates the integration runtime key with the key name specified by 'KeyName'
parameter. The previous key will is invalid.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-KeyName <String>
The authentication key name of the self-hosted integration runtime.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys
NOTES
Example 1: Generate a new key for an integration runtime
PS C:\\> New-AzureRmDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir'
-KeyName authKey2
AuthKey1 AuthKey2
-------- --------
IR@89895504-f647-48fd-8dd3-42fa556d67e3@***
The cmdlet regenerates key 'authKey2' for integration runtime named 'test-selfhost-ir'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... runtimekey
Get-AzureRmDataFactoryV2IntegrationRuntimeKey