< Back

Remove-AzureRmDataFactoryHub

Tue Jan 29, 2019 9:41 pm

NAME Remove-AzureRmDataFactoryHub



SYNOPSIS

Removes a hub from Azure Data Factory.





SYNTAX

Remove-AzureRmDataFactoryHub [-DataFactory] <PSDataFactory> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm]

[-WhatIf] [<CommonParameters>]



Remove-AzureRmDataFactoryHub [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]

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





DESCRIPTION

The Remove-AzureRmDataFactoryHub cmdlet removes a hub from Azure Data Factory in the specified Azure resource group and in the specified data

factory. If you remove a hub, all linked services and pipelines in the hub are also removed.





PARAMETERS

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet removes a hub from the data factory that this parameter specifies.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet removes a hub from the data factory that this parameter specifies.



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

Indicates that this cmdlet removes a hub 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 hub to remove.



Required? true

Position? 2

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



PS C:\\>Remove-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub"



This command removes the hub named ContosoDataHub from the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.







RELATED LINKS

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

Get-AzureRmDataFactoryHub

New-AzureRmDataFactoryHub