Get-AzureRmDataFactory
Gets information about Data Factories.
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-AzureRmDataFactory
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmDataFactory cmdlet gets information about data factories in an Azure resource group. If you specify the name of a data factory, this cmdlet gets information about that data factory. If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group.
Examples
Example 1: Get all data factories
PS C:\>Get-AzureRmDataFactory -ResourceGroupName "ADF"
DataFactoryName : WikiADF
ResourceGroupName : ADF
Location : WestUS
Tags : {}
Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration
DataFactoryName : WikiADF2
ResourceGroupName : ADF
Location : westus
Tags : {}
Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration
This command displays information about all data factories in the Azure subscription.
Example 2: Get a specific data factory
PS C:\>$DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "WikiADF"
DataFactoryName : WikiADF
ResourceGroupName : ADF
Location : westus
Tags : {}
Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration
This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. Specify the DataFactory parameter in subsequent cmdlets to use the data factory stored in $DataFactory.
Parameters
-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 data factory about which to get information.
Type: | String |
Position: | 1 |
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 data factories 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
Outputs
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories