Skip to content

Commit ada8257

Browse files
author
Dongwei Wang
committed
Add example files
1 parent e99b45c commit ada8257

File tree

8 files changed

+579
-7
lines changed

8 files changed

+579
-7
lines changed

src/Synapse/Synapse/Az.Synapse.psd1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,8 @@ AliasesToExport = 'New-AzSynapsePipeline', 'New-AzSynapseLinkedService',
190190
'Clear-AzSynapseSqlPoolAdvancedThreatProtectionSetting',
191191
'Clear-AzSynapseSqlPoolVulnerabilityAssessmentSetting',
192192
'Enable-AzSynapseSqlAdvancedThreatProtection',
193-
'Disable-AzSynapseSqlAdvancedThreatProtection'
193+
'Disable-AzSynapseSqlAdvancedThreatProtection',
194+
'New-AzSynapseSparkJobDefinition'
194195

195196
# DSC resources to export from this module
196197
# DscResourcesToExport = @()

src/Synapse/Synapse/Commands/DataPlaneCommands/Artifact/SparkJobDefinitions/SetAzureSynapseSparkJobDefinition.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ public class SetAzureSynapseSparkJobDefinition : SynapseArtifactsCmdletBase
4747
[ValidateNotNullOrEmpty]
4848
public string NewName { get; set; }
4949

50-
[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = true, HelpMessage = HelpMessages.JsonFilePath)]
50+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = SetByObject, Mandatory = true, HelpMessage = HelpMessages.JsonFilePath)]
51+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = SetByName, Mandatory = true, HelpMessage = HelpMessages.JsonFilePath)]
5152
[ValidateNotNullOrEmpty]
5253
[Alias("File")]
5354
public string DefinitionFile { get; set; }
@@ -75,7 +76,7 @@ public override void ExecuteCmdlet()
7576
case RenameByName:
7677
case RenameByObject:
7778
SynapseAnalyticsClient.RenameSparkJobDefinition(this.Name, this.NewName);
78-
WriteObject(new PSSparkJobDefinitionResource(SynapseAnalyticsClient.GetSparkJobDefinition(this.Name)));
79+
WriteObject(new PSSparkJobDefinitionResource(SynapseAnalyticsClient.GetSparkJobDefinition(this.NewName)));
7980
break;
8081

8182
default: throw new AzPSInvalidOperationException(string.Format(Resources.InvalidParameterSet, this.ParameterSetName));

src/Synapse/Synapse/Models/SynapseAnalyticsArtifactsClient.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ public class SynapseAnalyticsArtifactsClient
2222
private readonly DatasetClient _datasetClient;
2323
private readonly DataFlowClient _dataFlowClient;
2424
private readonly BigDataPoolsClient _bigDataPoolsClient;
25-
private readonly SqlScriptClient _sqlScriptClient;
2625
private readonly SparkJobDefinitionClient _sparkJobDefinitionClient;
2726

2827
public SynapseAnalyticsArtifactsClient(string workspaceName, IAzureContext context)
@@ -43,7 +42,6 @@ public SynapseAnalyticsArtifactsClient(string workspaceName, IAzureContext conte
4342
_datasetClient = new DatasetClient(uri, new AzureSessionCredential(context));
4443
_dataFlowClient = new DataFlowClient(uri, new AzureSessionCredential(context));
4544
_bigDataPoolsClient = new BigDataPoolsClient(uri, new AzureSessionCredential(context));
46-
_sqlScriptClient = new SqlScriptClient(uri, new AzureSessionCredential(context));
4745
_sparkJobDefinitionClient = new SparkJobDefinitionClient(uri, new AzureSessionCredential(context));
4846
}
4947

src/Synapse/Synapse/help/Az.Synapse.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ Gets a Synapse Analytics role scope.
8989
### [Get-AzSynapseSparkJob](Get-AzSynapseSparkJob.md)
9090
Gets a Synapse Analytics Spark job.
9191

92+
### [Get-AzSynapseSparkJobDefinition](Get-AzSynapseSparkJobDefinition.md)
93+
Gets a Spark job definition in workspace.
94+
9295
### [Get-AzSynapseSparkPool](Get-AzSynapseSparkPool.md)
9396
Gets a Synapse Analytics Spark pool.
9497

@@ -230,6 +233,9 @@ Removes a pipeline from workspace.
230233
### [Remove-AzSynapseRoleAssignment](Remove-AzSynapseRoleAssignment.md)
231234
Deletes a Synapse Analytics role assignment.
232235

236+
### [Remove-AzSynapseSparkJobDefinition](Remove-AzSynapseSparkJobDefinition.md)
237+
Removes a Spark job definition from workspace.
238+
233239
### [Remove-AzSynapseSparkPool](Remove-AzSynapseSparkPool.md)
234240
Deletes a Synapse Analytics Spark pool.
235241

@@ -308,6 +314,9 @@ Creates or updates a notebook in a workspace.
308314
### [Set-AzSynapsePipeline](Set-AzSynapsePipeline.md)
309315
Creates a pipeline in workspace.
310316

317+
### [Set-AzSynapseSparkJobDefinition](Set-AzSynapseSparkJobDefinition.md)
318+
Creates a Spark job definition in workspace.
319+
311320
### [Set-AzSynapseSqlActiveDirectoryAdministrator](Set-AzSynapseSqlActiveDirectoryAdministrator.md)
312321
Provisions an Azure AD administrator for Synapse Analytics SQL pool.
313322

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml
3+
Module Name: Az.Synapse
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzSynapseSparkJobDefinition
9+
10+
## SYNOPSIS
11+
Gets a Spark job definition in workspace.
12+
13+
## SYNTAX
14+
15+
### GetByName (Default)
16+
```
17+
Get-AzSynapseSparkJobDefinition -WorkspaceName <String> [-Name <String>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
21+
### GetByObject
22+
```
23+
Get-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> [-Name <String>]
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
The **Get-AzSynapseSparkJobDefinition** cmdlet gets information about Spark job definitions in workspace. If you specify the name of a Spark job definition, this cmdlet gets information about that Spark job definition. If you do not specify a name, this cmdlet gets information about all the Spark job definitions in the workspace.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace
35+
```
36+
37+
This command gets information about all Spark job definitions in the workspace named ContosoWorkspace.
38+
39+
### Example 2
40+
```powershell
41+
PS C:\> Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoJobDefinition
42+
```
43+
44+
This command gets information about the Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace.
45+
46+
### Example 3
47+
```powershell
48+
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
49+
PS C:\> $ws | Get-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition
50+
```
51+
52+
This command gets information about the Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace through pipeline.
53+
54+
## PARAMETERS
55+
56+
### -DefaultProfile
57+
The credentials, account, tenant, and subscription used for communication with Azure.
58+
59+
```yaml
60+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
61+
Parameter Sets: (All)
62+
Aliases: AzContext, AzureRmContext, AzureCredential
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Name
72+
The Spark job definition name.
73+
74+
```yaml
75+
Type: System.String
76+
Parameter Sets: (All)
77+
Aliases: SparkJobDefinitionName
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -WorkspaceName
87+
Name of Synapse workspace.
88+
89+
```yaml
90+
Type: System.String
91+
Parameter Sets: GetByName
92+
Aliases:
93+
94+
Required: True
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -WorkspaceObject
102+
workspace input object, usually passed through the pipeline.
103+
104+
```yaml
105+
Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
106+
Parameter Sets: GetByObject
107+
Aliases:
108+
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: True (ByValue)
113+
Accept wildcard characters: False
114+
```
115+
116+
### CommonParameters
117+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
118+
119+
## INPUTS
120+
121+
### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
122+
123+
## OUTPUTS
124+
125+
### Microsoft.Azure.Commands.Synapse.Models.PSSparkJobDefinitionResource
126+
127+
## NOTES
128+
129+
## RELATED LINKS

src/Synapse/Synapse/help/Remove-AzSynapsePipeline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Remove-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-
2424
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2525
```
2626

27-
### NewByInputObject
27+
### RemoveByInputObject
2828
```
2929
Remove-AzSynapsePipeline -Name <String> -InputObject <PSPipelineResource> [-PassThru] [-AsJob] [-Force]
3030
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -110,7 +110,7 @@ The pipeline object.
110110
111111
```yaml
112112
Type: Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource
113-
Parameter Sets: NewByInputObject
113+
Parameter Sets: RemoveByInputObject
114114
Aliases:
115115

116116
Required: True

0 commit comments

Comments
 (0)