Update-AzSynapseIntegrationRuntime

Reference

Module:: Az.Synapse

Updates an integration runtime.

Syntax

Update-AzSynapseIntegrationRuntime
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      -IntegrationRuntimeName <String>
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseIntegrationRuntime
      -IntegrationRuntimeName <String>
      -WorkspaceObject <PSSynapseWorkspace>
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseIntegrationRuntime
      -ResourceId <String>
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseIntegrationRuntime
      -InputObject <PSIntegrationRuntime>
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzSynapseIntegrationRuntime cmdlet updates integration runtime properties. Currently the cmdlet only supports updating 'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime.

Examples

Example 1

$ts = New-TimeSpan -Hours 3
Update-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -AutoUpdate Off -AutoUpdateDelayOffset $ts

The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'.

Parameters

-AutoUpdate

Enable or disable the self-hosted integration runtime auto-update.

Type:	String
Accepted values:	On, Off
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoUpdateDelayOffset

The time of the day for the self-hosted integration runtime auto-update.

Type:	Nullable<T>[TimeSpan]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-InputObject

The integration runtime object.

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

-IntegrationRuntimeName

The integration runtime name.

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

PSSelfHostedIntegrationRuntimeStatus

Share via