Skip to content

Commit 5794114

Browse files
yanjungao718yanjungao718
authored
change [Update-AzSynapseWorkspaceKey] to [Enable-AzSynapseWorkspace] (#15637)
* synapse-activite workspace * modify help doc, remove commented useless code * modify help doc * modify change log * update test file, delete useless help doc * refine description in change log
1 parent 4024ada commit 5794114

File tree

6 files changed

+52
-69
lines changed

6 files changed

+52
-69
lines changed

‎src/Synapse/Synapse.Test/ScenarioTests/WorkspaceTests.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ function Test-SynapseWorkspaceKey
388388
Set-AzKeyVaultAccessPolicy -VaultName $params.vaultName -ObjectId $workspaceId -PermissionsToKeys get,wrapkey,unwrapkey
389389

390390
# Activate workspace
391-
Update-AzSynapseWorkspaceKey -ResourceGroupName $params.rgname -WorkspaceName $params.workspaceName -Activate
391+
Enable-AzSynapseWorkspace -ResourceGroupName $params.rgname -WorkspaceName $params.workspaceName
392392
Wait-Seconds 15
393393

394394
# Retrieve workspace keys

‎src/Synapse/Synapse/Az.Synapse.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ CmdletsToExport = 'Get-AzSynapseSparkJob', 'Stop-AzSynapseSparkJob',
170170
'Get-AzSynapseManagedIdentitySqlControlSetting',
171171
'Set-AzSynapseManagedIdentitySqlControlSetting',
172172
'New-AzSynapseWorkspaceKey', 'Get-AzSynapseWorkspaceKey',
173-
'Remove-AzSynapseWorkspaceKey', 'Update-AzSynapseWorkspaceKey',
173+
'Remove-AzSynapseWorkspaceKey', 'Enable-AzSynapseWorkspace',
174174
'New-AzSynapseManagedVirtualNetworkConfig',
175175
'Update-AzSynapseManagedVirtualNetworkConfig',
176176
'Get-AzSynapseSparkJobDefinition',

‎src/Synapse/Synapse/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
- Added `Remove-AzSynapseManagedPrivateEndpoint` cmdlet
2525
* Fixed the blank page issue of pause setting and scale setting for Apache Spark pool through management API
2626
* Updated `Set-AzSynapseSqlActiveDirectoryAdministrator` to support for setting SQL Admin by `DisplayName` or by `ObjectId`
27+
* Renamed `Update-AzSynapseWorkspaceKey` to `Enable-AzSynapseWorkspace` to activate a new synapse workspace without `-Activate` parameter
2728

2829
## Version 0.14.0
2930
* Added parameter `-ManagedResourceGroupName` for the `New-AzSynapseWorkspace` cmdlet

‎src/Synapse/Synapse/Commands/ManagementCommands/WorkspaceKey/UpdateAzureSynapseWorkspaceKey.cs renamed to ‎src/Synapse/Synapse/Commands/ManagementCommands/WorkspaceKey/EnableAzSynapseWorkspace.cs

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,53 +12,50 @@
1212

1313
namespace Microsoft.Azure.Commands.Synapse
1414
{
15-
[Cmdlet(VerbsData.Update, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.WorkspaceKey,
16-
DefaultParameterSetName = UpdateByNameParameterSet, SupportsShouldProcess = true)]
15+
[Cmdlet("Enable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.Workspace,
16+
DefaultParameterSetName = EnableByNameParameterSet, SupportsShouldProcess = true)]
1717
[OutputType(typeof(PSWorkspaceKey))]
18-
public class UpdateAzureSynapseWorkspaceKey : SynapseManagementCmdletBase
18+
public class EnableAzSynapseWorkspace : SynapseManagementCmdletBase
1919
{
20-
private const string UpdateByNameParameterSet = "UpdateByNameParameterSet";
21-
private const string UpdateByParentObjectParameterSet = "UpdateByParentObjectParameterSet";
22-
private const string UpdateByInputObjectParameterSet = "UpdateByInputObjectParameterSet";
23-
private const string UpdateByResourceIdParameterSet = "UpdateByResourceIdParameterSet";
20+
private const string EnableByNameParameterSet = "EnableByNameParameterSet";
21+
private const string EnableByParentObjectParameterSet = "EnableByParentObjectParameterSet";
22+
private const string EnableByInputObjectParameterSet = "EnableByInputObjectParameterSet";
23+
private const string EnableByResourceIdParameterSet = "EnableByResourceIdParameterSet";
2424

25-
[Parameter(Mandatory = false, ParameterSetName = UpdateByNameParameterSet, HelpMessage = HelpMessages.ResourceGroupName)]
25+
[Parameter(Mandatory = false, ParameterSetName = EnableByNameParameterSet, HelpMessage = HelpMessages.ResourceGroupName)]
2626
[ResourceGroupCompleter]
2727
[ValidateNotNullOrEmpty]
2828
public string ResourceGroupName { get; set; }
2929

30-
[Parameter(Mandatory = true, ParameterSetName = UpdateByNameParameterSet, HelpMessage = HelpMessages.WorkspaceName)]
30+
[Parameter(Mandatory = true, ParameterSetName = EnableByNameParameterSet, HelpMessage = HelpMessages.WorkspaceName)]
3131
[ResourceNameCompleter(ResourceTypes.Workspace, nameof(ResourceGroupName))]
3232
[ValidateNotNullOrEmpty]
3333
public string WorkspaceName { get; set; }
3434

35-
[Parameter(Mandatory = false, ParameterSetName = UpdateByNameParameterSet, HelpMessage = HelpMessages.EncryptionKeyName)]
36-
[Parameter(Mandatory = false, ParameterSetName = UpdateByParentObjectParameterSet, HelpMessage = HelpMessages.EncryptionKeyName)]
35+
[Parameter(Mandatory = false, ParameterSetName = EnableByNameParameterSet, HelpMessage = HelpMessages.EncryptionKeyName)]
36+
[Parameter(Mandatory = false, ParameterSetName = EnableByParentObjectParameterSet, HelpMessage = HelpMessages.EncryptionKeyName)]
3737
[Alias(nameof(SynapseConstants.KeyName))]
3838
[ValidateNotNullOrEmpty]
3939
public string Name { get; set; } = SynapseConstants.DefaultName;
4040

41-
[Parameter(ValueFromPipeline = true, ParameterSetName = UpdateByParentObjectParameterSet,
41+
[Parameter(ValueFromPipeline = true, ParameterSetName = EnableByParentObjectParameterSet,
4242
Mandatory = true, HelpMessage = HelpMessages.WorkspaceObject)]
4343
[ValidateNotNull]
4444
public PSSynapseWorkspace WorkspaceObject { get; set; }
4545

46-
[Parameter(ValueFromPipeline = true, ParameterSetName = UpdateByInputObjectParameterSet, Mandatory = true,
46+
[Parameter(ValueFromPipeline = true, ParameterSetName = EnableByInputObjectParameterSet, Mandatory = true,
4747
HelpMessage = HelpMessages.KeyObject)]
4848
[ValidateNotNull]
4949
public PSWorkspaceKey InputObject { get; set; }
5050

51-
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = UpdateByResourceIdParameterSet,
51+
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = EnableByResourceIdParameterSet,
5252
Mandatory = true, HelpMessage = HelpMessages.KeyResourceId)]
5353
[ValidateNotNullOrEmpty]
5454
public string ResourceId { get; set; }
5555

5656
[Parameter(Mandatory = false, HelpMessage = HelpMessages.EncryptionKeyIdentifier)]
5757
public string EncryptionKeyIdentifier { get; set; }
5858

59-
[Parameter(Mandatory = false, HelpMessage = HelpMessages.IsActiveCustomerManagedKey)]
60-
public SwitchParameter Activate { get; set; }
61-
6259
[Parameter(Mandatory = false, HelpMessage = HelpMessages.AsJob)]
6360
public SwitchParameter AsJob { get; set; }
6461

@@ -108,15 +105,15 @@ public override void ExecuteCmdlet()
108105
throw new AzPSInvalidOperationException(string.Format(Resources.FailedToDiscoverKey, this.Name, this.ResourceGroupName, this.WorkspaceName));
109106
}
110107

111-
var updateParams = new Key
108+
var enableParams = new Key
112109
{
113-
IsActiveCMK = this.IsParameterBound(c => c.Activate) ? this.Activate.IsPresent : existingKey.IsActiveCMK,
110+
IsActiveCMK = true,
114111
KeyVaultUrl = this.IsParameterBound(c => c.EncryptionKeyIdentifier) ? this.EncryptionKeyIdentifier : existingKey.KeyVaultUrl
115112
};
116113

117114
if (this.ShouldProcess(this.Name, string.Format(Resources.UpdatingWorkspaceKey, this.Name, this.ResourceGroupName, this.WorkspaceName)))
118115
{
119-
WriteObject(new PSWorkspaceKey(this.SynapseAnalyticsClient.CreateOrUpdateKey(this.ResourceGroupName, this.WorkspaceName, this.Name, updateParams)));
116+
WriteObject(new PSWorkspaceKey(this.SynapseAnalyticsClient.CreateOrUpdateKey(this.ResourceGroupName, this.WorkspaceName, this.Name, enableParams)));
120117
}
121118
}
122119
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Enables Advanced Data Security on a workspace.
3232
### [Enable-AzSynapseSqlPoolSensitivityRecommendation](Enable-AzSynapseSqlPoolSensitivityRecommendation.md)
3333
Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the SQL pool.
3434

35+
### [Enable-AzSynapseWorkspace](Enable-AzSynapseWorkspace.md)
36+
Activate a new Azure Synapse Analytics workspace.
37+
3538
### [Export-AzSynapseNotebook](Export-AzSynapseNotebook.md)
3639
Exports notbooks.
3740

@@ -428,9 +431,6 @@ Updates the vulnerability assessment settings of a workspace.
428431
### [Update-AzSynapseWorkspace](Update-AzSynapseWorkspace.md)
429432
Updates a Synapse Analytics workspace.
430433

431-
### [Update-AzSynapseWorkspaceKey](Update-AzSynapseWorkspaceKey.md)
432-
Updates a workspace key.
433-
434434
### [Wait-AzSynapseSparkJob](Wait-AzSynapseSparkJob.md)
435435
Waits for a Synapse Analytics Spark job to complete.
436436

‎src/Synapse/Synapse/help/Update-AzSynapseWorkspaceKey.md renamed to ‎src/Synapse/Synapse/help/Enable-AzSynapseWorkspace.md

Lines changed: 29 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,72 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml
33
Module Name: Az.Synapse
4-
online version: https://docs.microsoft.com/powershell/module/az.synapse/update-azsynapseworkspacekey
4+
online version: https://docs.microsoft.com/powershell/module/az.synapse/enable-azsynapseworkspace
55
schema: 2.0.0
66
---
77

8-
# Update-AzSynapseWorkspaceKey
8+
# Enable-AzSynapseWorkspace
99

1010
## SYNOPSIS
11-
Updates a workspace key.
11+
Activate a new Azure Synapse Analytics workspace.
1212

1313
## SYNTAX
1414

15-
### UpdateByNameParameterSet (Default)
15+
### EnableByNameParameterSet (Default)
1616
```
17-
Update-AzSynapseWorkspaceKey [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>]
18-
[-EncryptionKeyIdentifier <String>] [-Activate] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19-
[-Confirm] [<CommonParameters>]
17+
Enable-AzSynapseWorkspace [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>]
18+
[-EncryptionKeyIdentifier <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
2020
```
2121

22-
### UpdateByParentObjectParameterSet
22+
### EnableByParentObjectParameterSet
2323
```
24-
Update-AzSynapseWorkspaceKey [-Name <String>] -WorkspaceObject <PSSynapseWorkspace>
25-
[-EncryptionKeyIdentifier <String>] [-Activate] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
26-
[-Confirm] [<CommonParameters>]
24+
Enable-AzSynapseWorkspace [-Name <String>] -WorkspaceObject <PSSynapseWorkspace>
25+
[-EncryptionKeyIdentifier <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2727
```
2828

29-
### UpdateByInputObjectParameterSet
29+
### EnableByInputObjectParameterSet
3030
```
31-
Update-AzSynapseWorkspaceKey -InputObject <PSWorkspaceKey> [-EncryptionKeyIdentifier <String>] [-Activate]
32-
[-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
31+
Enable-AzSynapseWorkspace -InputObject <PSWorkspaceKey> [-EncryptionKeyIdentifier <String>] [-AsJob]
32+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3333
```
3434

35-
### UpdateByResourceIdParameterSet
35+
### EnableByResourceIdParameterSet
3636
```
37-
Update-AzSynapseWorkspaceKey -ResourceId <String> [-EncryptionKeyIdentifier <String>] [-Activate] [-AsJob]
37+
Enable-AzSynapseWorkspace -ResourceId <String> [-EncryptionKeyIdentifier <String>] [-AsJob]
3838
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3939
```
4040

4141
## DESCRIPTION
42-
This **Update-AzSynapseWorkspaceKey** updates a workspace key.
42+
The Enable-AzSynapseWorkspace cmdlet activites a new Azure Synapse Analytics workspace.
4343

4444
## EXAMPLES
4545

4646
### Example 1
4747
```powershell
48-
PS C:\> Update-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoKeyName -Activate
48+
PS C:\> Enable-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
4949
```
5050

51-
This command activates a workspace key under an Azure Synapse Analytics workspace.
51+
This command activites a new Azure Synapse Analytics workspace named ContosoWorkspace.
5252

5353
### Example 2
5454
```powershell
5555
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
56-
PS C:\> $ws | Update-AzSynapseWorkspaceKey -Name ContosoKeyName -Activate
56+
$ws | Enable-AzSynapseWorkspace
5757
```
5858

59-
This command activates a workspace key under an Azure Synapse Analytics workspace through pipeline.
59+
This command activites a new Azure Synapse Analytics workspace named ContosoWorkspace through pipeline.
6060

6161
### Example 3
6262
```powershell
63-
PS C:\> Update-AzSynapseWorkspaceKey -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoKeyName
63+
PS C:\> Enable-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/default
6464
```
6565

66-
This command activates an Azure Synapse Analytics workspace key through pipeline with the specified resource ID.
66+
This command activates a new Azure Synapse Analytics workspace through pipeline with the specified resource ID.
6767

6868
## PARAMETERS
6969

70-
### -Activate
71-
Indicates whether to activate the workspace after a customer managed key is provided.
72-
73-
```yaml
74-
Type: System.Management.Automation.SwitchParameter
75-
Parameter Sets: (All)
76-
Aliases:
77-
78-
Required: False
79-
Position: Named
80-
Default value: None
81-
Accept pipeline input: False
82-
Accept wildcard characters: False
83-
```
84-
8570
### -AsJob
8671
Run cmdlet in the background
8772

@@ -132,7 +117,7 @@ Workspace key input object, usually passed through the pipeline.
132117
133118
```yaml
134119
Type: Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey
135-
Parameter Sets: UpdateByInputObjectParameterSet
120+
Parameter Sets: EnableByInputObjectParameterSet
136121
Aliases:
137122

138123
Required: True
@@ -147,7 +132,7 @@ The workspace encryption key name.
147132
148133
```yaml
149134
Type: System.String
150-
Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet
135+
Parameter Sets: EnableByNameParameterSet, EnableByParentObjectParameterSet
151136
Aliases: KeyName
152137

153138
Required: False
@@ -162,7 +147,7 @@ Resource group name.
162147
163148
```yaml
164149
Type: System.String
165-
Parameter Sets: UpdateByNameParameterSet
150+
Parameter Sets: EnableByNameParameterSet
166151
Aliases:
167152

168153
Required: False
@@ -177,7 +162,7 @@ The resource identifier of Synapse SQL Pool.
177162
178163
```yaml
179164
Type: System.String
180-
Parameter Sets: UpdateByResourceIdParameterSet
165+
Parameter Sets: EnableByResourceIdParameterSet
181166
Aliases:
182167

183168
Required: True
@@ -192,7 +177,7 @@ Name of Synapse workspace.
192177
193178
```yaml
194179
Type: System.String
195-
Parameter Sets: UpdateByNameParameterSet
180+
Parameter Sets: EnableByNameParameterSet
196181
Aliases:
197182

198183
Required: True
@@ -207,7 +192,7 @@ workspace input object, usually passed through the pipeline.
207192
208193
```yaml
209194
Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
210-
Parameter Sets: UpdateByParentObjectParameterSet
195+
Parameter Sets: EnableByParentObjectParameterSet
211196
Aliases:
212197

213198
Required: True

0 commit comments

Comments
 (0)