Get-AzureRmDataFactoryV2Dataset
Gets information about datasets in 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-AzureRmDataFactoryV2Dataset
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2Dataset
[[-Name] <String>]
[-DataFactory] <PSDataFactory>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2Dataset
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmDataFactoryV2Dataset 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
PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
DatasetName : DACuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Structure :
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
DatasetName : DAWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Structure :
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
DatasetName : DAWikiAggregatedData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Structure :
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
This command gets information about all datasets in the data factory named WikiADF.
Example 2: Get information about a specific dataset
PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents"
DatasetName : DAWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Structure :
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF.
Parameters
-DataFactory
Specifies a PSDataFactory object. This cmdlet gets datasets that belong to 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 datasets that belong to 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 dataset about which to get information.
Type: | String |
Aliases: | DatasetName |
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 datasets 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 |
-ResourceId
The Azure resource ID.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: DataFactory (ByValue)
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories