Edit

Get-AzureRmDataFactoryHub

  • Reference
Module:
AzureRM.DataFactories

Gets information about hubs in Azure Data Factory.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmDataFactoryHub
   [[-Name] <String>]
   [-DataFactoryName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDataFactoryHub
   [[-Name] <String>]
   [-DataFactory] <PSDataFactory>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmDataFactoryHub cmdlet gets information about hubs in Azure Data Factory. If you specify the name of a hub, this cmdlet gets information about that hub. If you do not specify a name, this cmdlet gets information about all of the hubs in a data factory.

Examples

Example 1: Get all data hubs

PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory"

This command gets all data hubs in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.

Example 2: Get a specific data hub

PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub"

This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.

Parameters

-DataFactory

Specifies a PSDataFactory object. This cmdlet gets information about hubs in the data factory that this parameter specifies.

Type:PSDataFactory
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DataFactoryName

Specifies the name of a data factory. This cmdlet gets information about hubs in the data factory that this parameter specifies.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the hub about which to get information.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of an Azure resource group. This cmdlet gets information about hubs that belong to the group that this parameter specifies.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

PSDataFactory

Outputs

PSHub

Notes

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