Start-AzSynapseIntegrationRuntime

  • Reference
Module:
Az.Synapse

Starts a managed dedicated integration runtime.

Syntax

Start-AzSynapseIntegrationRuntime
     [-ResourceGroupName <String>]
     -WorkspaceName <String>
     -Name <String>
     [-Force]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzSynapseIntegrationRuntime
     -Name <String>
     -WorkspaceObject <PSSynapseWorkspace>
     [-Force]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzSynapseIntegrationRuntime
     -ResourceId <String>
     [-Force]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzSynapseIntegrationRuntime
     -InputObject <PSIntegrationRuntime>
     [-Force]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzSynapseIntegrationRuntime cmdlet starts a managed dedicated integration runtime. The resource is provisioned and after the operation the state is 'Started'.

Examples

Example 1

Start-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-dedicated-ir'

This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Start-AzSynapseIntegrationRuntime -Name 'test-dedicated-ir'

This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline.

Example 3

Start-AzSynapseIntegrationRuntime -ResourceId '/subscriptions/0000abcd-1a1b-12ab-1234-0000abcd00aa/resourceGroups/Contosorg/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/integrationruntimes/test-dedicated-ir'

This cmdlet starts a managed dedicated integration runtime using ResourceId in workspace ContosoWorkspace.

Example 4

$ir = Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name test-dedicated-ir -ResourceGroupName Contosorg
$ir | Start-AzSynapseIntegrationRuntime

This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-Force

Do not ask for confirmation.

Type:SwitchParameter
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
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

Inputs

PSSynapseWorkspace

PSIntegrationRuntime

Outputs

PSManagedIntegrationRuntimeStatus