Stop-AzureRmDataFactoryV2IntegrationRuntime

Stops a managed dedicated integration runtime.

Syntax

Stop-AzureRmDataFactoryV2IntegrationRuntime
    [-Force]
    [-Name] <String>
    [-ResourceGroupName] <String>
    [-DataFactoryName] <String>
    [-WhatIf]
    [-Confirm]
Stop-AzureRmDataFactoryV2IntegrationRuntime
    [-Force]
    [-ResourceId] <String>
    [-WhatIf]
    [-Confirm]
Stop-AzureRmDataFactoryV2IntegrationRuntime
    [-Force]
    [-InputObject] <PSIntegrationRuntime>
    [-WhatIf]
    [-Confirm]

Description

The Stop-AzureRmDataFactoryV2IntegrationRuntime cmdlet stops a managed dedicated integration runtime in 'Started' state, which was started by the Start-AzureRmDataFactoryV2IntegrationRuntime cmdlet. The resources are released and the state transfers to 'Stopped'.

Examples

Example 1: Stop a managed integration runtime that is in 'Started' state.

PS C:\> Stop-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df' -Name 'test-reserlved-ir'

The managed integration runtime 'test-reserlved-ir' is in 'Started' state. After running Stop-AzureRmDataFactoryV2IntegrationRuntime cmdlet, the resources are released and the state transfers to 'Stopped'.

Required Parameters

-DataFactoryName

The data factory name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

The integration runtime object.

Type:PSIntegrationRuntime
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

The integration runtime name.

Type:String
Aliases:IntegrationRuntimeName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceId

The Azure resource ID.

Type:String
Aliases:Id
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Force

Runs the cmdlet without prompting for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.

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

Inputs

String

Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime

Outputs

Boolean

Notes

Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime