< Back

Remove-AzureRmDataFactoryV2IntegrationRuntime

Tue Jan 29, 2019 9:42 pm

NAME Remove-AzureRmDataFactoryV2IntegrationRuntime



SYNOPSIS

Removes an integration runtime.





SYNTAX

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

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



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

[-WhatIf] [<CommonParameters>]



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

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmDataFactoryV2IntegrationRuntime cmdlet removes a integration runtime.





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







NOTES





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



Example 1: Remove a integration runtime



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

-Confirm



This command removes the integration runtime named 'test-reserved-ir' from the data factory named 'test-df'. This command returns a value of $True.







RELATED LINKS

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

Set-AzureRmDataFactoryV2IntegrationRuntime

Get-AzureRmDataFactoryV2IntegrationRuntime