Get-AzDataFactory
Gets information about Data Factories.
Syntax
Default (Default)
Get-AzDataFactory
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataFactory 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
Get-AzDataFactory -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
$DataFactory = Get-AzDataFactory -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
Parameter properties
Type: | IAzureContextContainer |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Name
Specifies the name of the data factory about which to get information.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 1 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | 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.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
PSDataFactory
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories