Get-AzDataFactoryDataset
Gets information about datasets in Azure Data Factory.
Syntax
ByFactoryName (Default)
Get-AzDataFactoryDataset
[-DataFactoryName] <String>
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByFactoryObject
Get-AzDataFactoryDataset
[-DataFactory] <PSDataFactory>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataFactoryDataset cmdlet gets information about datasets in Azure Data Factory. If you specify the name of a dataset, this cmdlet gets information about that dataset. If you do not specify a name, this cmdlet gets information about all the datasets in the data factory.
Examples
Example 1: Get information about all datasets
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
DatasetName : DACuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Availability : Microsoft.DataFactories.Availability
Location :
Policy :
Structure : {}
DatasetName : DAWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Availability : Microsoft.DataFactories.Availability
Location :
Policy :
Structure : {}
DatasetName : DAWikiAggregatedData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Availability : Microsoft.DataFactories.Availability
Location :
Policy :
Structure : {}
This command gets information about all datasets in the data factory named WikiADF.
Example 2: Get information about a specific dataset
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents"
DatasetName : DAWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Availability : Microsoft.DataFactories.Availability
Location : Microsoft.DataFactories.AzureBlobLocation
Policy : Microsoft.DataFactories.Policy
Structure : {}
This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF.
Example 3: Get the location for a specific dataset
(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location
BlobPath : wikidatagateway/wikisampledatain/
FilenamePrefix :
Format :
LinkedServiceName : LinkedServiceWikipediaClickEvents
PartitionBy : {}
This command gets information for the dataset named DAWikipediaClickEvents in the data factory named WikiADF, and then uses standard dot notation to view the Location associated with that dataset. Alternatively, assign the output of the Get-AzDataFactoryDataset cmdlet to a variable, and then use dot notation to view the Location property associated with the dataset object stored in that variable.
Parameters
-DataFactory
Specifies a PSDataFactory object. This cmdlet gets datasets that belong to the data factory that this parameter specifies.
Parameter properties
| Type: | PSDataFactory |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DataFactoryName
Specifies the name of a data factory. This cmdlet gets datasets that belong to the data factory that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-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 dataset about which this cmdlet gets information.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| 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 datasets that belong to the group that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryName
| 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
PSDataFactory
String
Outputs
PSDataset
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories
