< Back

Remove-AzureRmDataFactory

Tue Jan 29, 2019 9:41 pm

NAME Remove-AzureRmDataFactory



SYNOPSIS

Removes a data factory.





SYNTAX

Remove-AzureRmDataFactory [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]

[<CommonParameters>]



Remove-AzureRmDataFactory [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmDataFactory cmdlet removes a data factory.





PARAMETERS

-DataFactory <PSDataFactory>

Specifies the PSDataFactory object to remove.



Required? true

Position? 0

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>]

Indicates that this cmdlet removes a data factory without prompting you for confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the data factory to remove.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet removes a data factory from the group that this parameter specifies.



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 would happen if the cmdlet runs. The cmdlet is not run.



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

None

This cmdlet does not accept any input.





OUTPUTS

System.Boolean







NOTES





* Keywords: azure, azurerm, arm, resource, management, manager, data, factories



Example 1: Remove a data factory



PS C:\\>Remove-AzureRmDataFactory -Name "WikiADF" -ResourceGroupName "ADF"

Confirm

Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'?

[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

True



This command removes the data factory named WikiADF from the resource group named ADF. This command returns a value of $True.







RELATED LINKS

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

Get-AzureRmDataFactory

New-AzureRmDataFactory