< Back

Remove-AzureRmDataFactoryV2Dataset

Tue Jan 29, 2019 9:42 pm

NAME Remove-AzureRmDataFactoryV2Dataset



SYNOPSIS

Removes a dataset from Data Factory.





SYNTAX

Remove-AzureRmDataFactoryV2Dataset [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-AzureRmDataFactoryV2Dataset [-InputObject] <PSDataset> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]

[<CommonParameters>]



Remove-AzureRmDataFactoryV2Dataset [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmDataFactoryV2Dataset cmdlet removes a dataset from Azure Data Factory.





PARAMETERS

-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet removes a dataset from the data factory that this parameter specifies.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Runs the cmdlet without prompting for confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <PSDataset>

Specifies a Dataset object to remove.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

Specifies the name of the dataset to remove.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet removes a dataset from the group that this parameter specifies.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

The Azure resource ID.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset

System.String





OUTPUTS

System.Object







NOTES





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



Example 1: Remove a dataset



PS C:\\> Remove-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData"

Confirm

Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'?

[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y

True



This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. The command returns a value of $True.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... yv2dataset

Get-AzureRmDataFactoryV2Dataset

Set-AzureRmDataFactoryV2Dataset