Get-AzSynapseIntegrationRuntimeKey
Gets keys for a self-hosted integration runtime.
Syntax
Get-AzSynapseIntegrationRuntimeKey
[-ResourceGroupName <String>]
-WorkspaceName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzSynapseIntegrationRuntimeKey
-Name <String>
-WorkspaceObject <PSSynapseWorkspace>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzSynapseIntegrationRuntimeKey
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 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: | IAzureContextContainer |
| Aliases: | AzContext, 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: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The integration runtime name.
| Type: | String |
| Aliases: | IntegrationRuntimeName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
Resource identifier of Synapse integration runtime.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceName
Name of Synapse workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceObject
workspace input object, usually passed through the pipeline.
| Type: | PSSynapseWorkspace |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |