Stop-AzureRmDataFactoryV2IntegrationRuntime

NAME Stop-AzureRmDataFactoryV2IntegrationRuntime



SYNOPSIS

Stops a managed dedicated integration runtime.





SYNTAX

Stop-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]



Stop-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm]

[-WhatIf] [<CommonParameters>]



Stop-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]

[<CommonParameters>]





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'.





PARAMETERS

-DataFactoryName <String>

The data factory name.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Runs the cmdlet without prompting for confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <PSIntegrationRuntime>

The integration runtime object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

The integration runtime name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The resource group name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

The Azure resource ID.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime





OUTPUTS

System.Boolean







NOTES





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



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'.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime

Start-AzureRmDataFactoryV2IntegrationRuntime