Get-AzSynapseWorkspacePackage
Gets a workspace package.
Syntax
Get-AzSynapseWorkspacePackage
-WorkspaceName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzSynapseWorkspacePackage
-WorkspaceObject <PSSynapseWorkspace>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSynapseWorkspacePackage cmdlet gets a workspace package.
Examples
Example 1
Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace
This command gets information about all workspace packages in the workspace named ContosoWorkspace.
Example 2
Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Name ContosoWorkspacePackage
This command gets information about the workspace package named ContosoWorkspacePackage in the workspace named ContosoWorkspace.
Example 3
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseWorkspacePackage -Name ContosoWorkspacePackage
This command gets information about the workspace package named ContosoWorkspacePackage in the workspace named ContosoWorkspace through pipeline.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The workspace package name.
Type: | String |
Aliases: | PackageName, Package |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WorkspaceName
Name of Synapse workspace.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Type: | PSSynapseWorkspace |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell