Skip to content

Latest commit

 

History

History
123 lines (92 loc) · 2.97 KB

Get-AzSynapseDataset.md

File metadata and controls

123 lines (92 loc) · 2.97 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml
Az.Synapse
2.0.0

Get-AzSynapseDataset

SYNOPSIS

Gets information about datasets in workspace.

SYNTAX

GetByName (Default)

Get-AzSynapseDataset -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByObject

Get-AzSynapseDataset -WorkspaceObject <PSSynapseWorkspace> [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

The Get-AzSynapseDataset cmdlet gets information about datasets in workspace. 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 workspace.

EXAMPLES

Example 1

Get-AzSynapseDataset -WorkspaceName ContosoWorkspace

This command gets information about all datasets in the workspace named ContosoWorkspace.

Example 2

Get-AzSynapseDataset -WorkspaceName ContosoWorkspace -Name ContosoDataset

This command gets information about the dataset named ContosoDataset in the workspace named ContosoWorkspace.

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The dataset name.

Type: System.String
Parameter Sets: (All)
Aliases: DatasetName

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WorkspaceName

Name of Synapse workspace.

Type: System.String
Parameter Sets: GetByName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
Parameter Sets: GetByObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace

OUTPUTS

Microsoft.Azure.Commands.Synapse.Models.PSDatasetResource

NOTES

RELATED LINKS