Skip to content

Commit 6dd1b4e

Browse files
author
Dongwei Wang
committed
Update examples
1 parent ada8257 commit 6dd1b4e

File tree

6 files changed

+30
-20
lines changed

6 files changed

+30
-20
lines changed

src/Synapse/Synapse/Commands/DataPlaneCommands/Artifact/Pipelines/RemoveAzureSynapsePipeline.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ public class RemoveAzureSynapsePipeline : SynapseArtifactsCmdletBase
2828
[ValidateNotNull]
2929
public PSSynapseWorkspace WorkspaceObject { get; set; }
3030

31-
[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = true, HelpMessage = HelpMessages.PipelineName)]
31+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByName, Mandatory = true, HelpMessage = HelpMessages.PipelineName)]
32+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByObject, Mandatory = true, HelpMessage = HelpMessages.PipelineName)]
3233
[ValidateNotNullOrEmpty]
3334
[Alias("PipelineName")]
3435
public string Name { get; set; }

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ public class RemoveAzureSynapseSparkJobDefinition : SynapseArtifactsCmdletBase
2828
[ValidateNotNull]
2929
public PSSynapseWorkspace WorkspaceObject { get; set; }
3030

31-
[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = true, HelpMessage = HelpMessages.SparkJobDefinitionName)]
31+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByName, Mandatory = true, HelpMessage = HelpMessages.SparkJobDefinitionName)]
32+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByObject, Mandatory = true, HelpMessage = HelpMessages.SparkJobDefinitionName)]
3233
[ValidateNotNullOrEmpty]
3334
[Alias("SparkJobDefinitionName")]
3435
public string Name { get; set; }

src/Synapse/Synapse/Models/SynapseAnalyticsArtifactsClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ public BigDataPoolResourceInfo GetBigDataPool(string bigDataPoolName)
274274
public SparkJobDefinitionResource CreateOrUpdateSparkJobDefinition(string SparkJobDefinitionName, string rawJsonContent)
275275
{
276276
SparkJobDefinitionResource SparkJobDefinition = new SparkJobDefinitionResource(JsonConvert.DeserializeObject<SparkJobDefinition>(rawJsonContent));
277-
return _sparkJobDefinitionClient.CreateOrUpdateSparkJobDefinition(SparkJobDefinitionName, SparkJobDefinition);
277+
return _sparkJobDefinitionClient.StartCreateOrUpdateSparkJobDefinition(SparkJobDefinitionName, SparkJobDefinition).Poll().Value;
278278
}
279279

280280
public SparkJobDefinitionResource GetSparkJobDefinition(string SparkJobDefinitionName)
@@ -289,7 +289,7 @@ public Pageable<SparkJobDefinitionResource> GetSparkJobDefinitionsByWorkspace()
289289

290290
public void DeleteSparkJobDefinition(string SparkJobDefinitionName)
291291
{
292-
_sparkJobDefinitionClient.DeleteSparkJobDefinition(SparkJobDefinitionName);
292+
_sparkJobDefinitionClient.StartDeleteSparkJobDefinition(SparkJobDefinitionName).Poll();
293293
}
294294

295295
public void RenameSparkJobDefinition(string SparkJobDefinitionName, string newName)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Remove-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-
2626

2727
### RemoveByInputObject
2828
```
29-
Remove-AzSynapsePipeline -Name <String> -InputObject <PSPipelineResource> [-PassThru] [-AsJob] [-Force]
29+
Remove-AzSynapsePipeline -InputObject <PSPipelineResource> [-PassThru] [-AsJob] [-Force]
3030
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3131
```
3232

@@ -125,7 +125,7 @@ The pipeline name.
125125
126126
```yaml
127127
Type: System.String
128-
Parameter Sets: (All)
128+
Parameter Sets: RemoveByName, RemoveByObject
129129
Aliases: PipelineName
130130

131131
Required: True

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Remove-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <
2626

2727
### RemoveByInputObject
2828
```
29-
Remove-AzSynapseSparkJobDefinition -Name <String> -InputObject <PSSparkJobDefinitionResource> [-PassThru]
30-
[-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
29+
Remove-AzSynapseSparkJobDefinition -InputObject <PSSparkJobDefinitionResource> [-PassThru] [-AsJob] [-Force]
30+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3131
```
3232

3333
## DESCRIPTION
@@ -125,7 +125,7 @@ The Spark job definition name.
125125
126126
```yaml
127127
Type: System.String
128-
Parameter Sets: (All)
128+
Parameter Sets: RemoveByName, RemoveByObject
129129
Aliases: SparkJobDefinitionName
130130

131131
Required: True

src/Synapse/Synapse/help/Set-AzSynapseSparkJobDefinition.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Set-AzSynapseSparkJobDefinition
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates a Spark job definition in workspace.
1212

1313
## SYNTAX
1414

@@ -20,9 +20,8 @@ Set-AzSynapseSparkJobDefinition -WorkspaceName <String> -Name <String> -Definiti
2020

2121
### RenameByName
2222
```
23-
Set-AzSynapseSparkJobDefinition -WorkspaceName <String> -Name <String> -NewName <String>
24-
-DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
25-
[<CommonParameters>]
23+
Set-AzSynapseSparkJobDefinition -WorkspaceName <String> -Name <String> -NewName <String> [-AsJob]
24+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2625
```
2726

2827
### SetByObject
@@ -33,22 +32,31 @@ Set-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <Str
3332

3433
### RenameByObject
3534
```
36-
Set-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <String> -NewName <String>
37-
-DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
38-
[<CommonParameters>]
35+
Set-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <String> -NewName <String> [-AsJob]
36+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3937
```
4038

4139
## DESCRIPTION
42-
{{ Fill in the Description }}
40+
The **Set-AzSynapseSparkJobDefinition** cmdlet creates a Spark job definition in workspace.
4341

4442
## EXAMPLES
4543

4644
### Example 1
4745
```powershell
48-
PS C:\> {{ Add example code here }}
46+
PS C:\> Set-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json"
4947
```
5048

51-
{{ Add example description here }}
49+
This command creates a Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace.
50+
The command bases the Spark job definition on information in the sparkJobDefinition.json file.
51+
52+
### Example 2
53+
```powershell
54+
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
55+
PS C:\> $ws | Set-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json"
56+
```
57+
58+
This command creates a Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace through pipeline.
59+
The command bases the Spark job definition on information in the sparkJobDefinition.json file.
5260

5361
## PARAMETERS
5462

@@ -87,7 +95,7 @@ The JSON file path.
8795
8896
```yaml
8997
Type: System.String
90-
Parameter Sets: (All)
98+
Parameter Sets: SetByName, SetByObject
9199
Aliases: File
92100

93101
Required: True

0 commit comments

Comments
 (0)