Skip to content

Latest commit

 

History

History
173 lines (132 loc) · 4.07 KB

Get-AzSynapseIntegrationRuntimeKey.md

File metadata and controls

173 lines (132 loc) · 4.07 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml
Az.Synapse
2.0.0

Get-AzSynapseIntegrationRuntimeKey

SYNOPSIS

Gets keys for a self-hosted integration runtime.

SYNTAX

GetByNameParameterSet (Default)

Get-AzSynapseIntegrationRuntimeKey [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

GetByParentObjectParameterSet

Get-AzSynapseIntegrationRuntimeKey -Name <String> -WorkspaceObject <PSSynapseWorkspace>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

GetByResourceIdParameterSet

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

GetByInputObjectParameterSet

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

DESCRIPTION

The Get-AzSynapseIntegrationRuntimeKey cmdlet gets keys for an integration runtime. The keys are used to register an integration runtime node.

EXAMPLES

Example 1

Get-AzSynapseIntegrationRuntimeKey -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir'

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

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

The integration runtime object.

Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime
Parameter Sets: GetByInputObjectParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The integration runtime name.

Type: System.String
Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet
Aliases: IntegrationRuntimeName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

Resource group name.

Type: System.String
Parameter Sets: GetByNameParameterSet
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

Resource identifier of Synapse integration runtime.

Type: System.String
Parameter Sets: GetByResourceIdParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WorkspaceName

Name of Synapse workspace.

Type: System.String
Parameter Sets: GetByNameParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
Parameter Sets: GetByParentObjectParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace

Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime

OUTPUTS

Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntimeKeys

NOTES

RELATED LINKS