Edit

Share via

Get-AzSynapseIntegrationRuntime

Module:
Az.Synapse Module

Gets information about integration runtime resources.

Syntax

GetByNameParameterSet (Default) 

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

GetByParentObjectParameterSet 

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

GetByResourceIdParameterSet 

Get-AzSynapseIntegrationRuntime
    -ResourceId <String>
    [-Status]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByInputObjectParameterSet 

Get-AzSynapseIntegrationRuntime
    -InputObject <PSIntegrationRuntime>
    [-Status]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzSynapseIntegrationRuntime cmdlet gets information about integration runtimes in a workspace. If you specify the name of an integration runtime, this cmdlet gets information about that integration runtime. If you do not specify a name, this cmdlet gets information about all of the integration runtimes in a workspace.

Examples

Example 1

Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace

List all integration runtimes in the workspace named ContosoWorkspace.

Example 2

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

This command displays information about the integration runtime named 'test-selfhost-ir' in the workspace named ContosoWorkspace.

Example 3

Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' -Status

This command displays detail status about the integration runtime named 'test-selfhost-ir' in the workspace named ContosoWorkspace.

Parameters

-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

GetByInputObjectParameterSet
Position:Named
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

GetByNameParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByParentObjectParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Resource group name.

Parameter properties

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

Parameter sets

GetByNameParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

Resource identifier of Synapse integration runtime.

Parameter properties

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

Parameter sets

GetByResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

The integration runtime detail status.

Parameter properties

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

Parameter sets

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

-WorkspaceName

Name of Synapse workspace.

Parameter properties

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

Parameter sets

GetByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

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

Parameter sets

GetByParentObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
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

PSSynapseWorkspace

PSIntegrationRuntime

Outputs

PSIntegrationRuntime