Skip to content

Commit b856e12

Browse files
committed
update help doc
1 parent 8aedce2 commit b856e12

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

src/Synapse/Synapse/help/New-AzSynapseWorkspace.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,29 @@ This command creates a Synapse Analytics workspace named ContosoWorkspace that u
8484
### Example 6
8585
```powershell
8686
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -EncryptionKeyIdentifier $identifier -UseSystemAssignedIdentityInEncryption $true
87+
$ws = Get-AzSynapseWorkspace -name ContosoWorkspace
88+
$ws.Encryption.CustomerManagedKeyDetails.Key
8789
```
8890

89-
This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup, and enable double encryption with customer-managed key with specified key identifier and set Managed Identity as System Assigned.
91+
```output
92+
Name KeyVaultUrl
93+
---- -----------
94+
default https://contosoKeyValut.vault.azure.net/keys/testkey
95+
```
96+
97+
```powershell
98+
$ws = Get-AzSynapseWorkspace -name ContosoWorkspace
99+
$ws.Encryption.CustomerManagedKeyDetails.KekIdentity
100+
```
101+
102+
```output
103+
UserAssignedIdentity UseSystemAssignedIdentity
104+
-------------------- -------------------------
105+
True
106+
```
107+
108+
This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup, and enable double encryption with customer-managed key with specified key identifier and set Managed Identity as System Assigned. After creation, we can call `Get-AzSynapseWorkspace` to get Encryption properties of workspace.
109+
90110
## PARAMETERS
91111

92112
### -AsJob

src/Synapse/Synapse/help/Update-AzSynapseWorkspace.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,28 @@ $uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
135135
$identityId = $uamis[0].Id
136136
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
137137
$ws | Update-AzSynapseWorkspace -UseSystemAssignedIdentityInEncryption $false -UserAssignedIdentityInEncryption $identityId
138+
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
139+
$ws.Encryption.CustomerManagedKeyDetails.Key
140+
```
141+
142+
```output
143+
Name KeyVaultUrl
144+
---- -----------
145+
default https://contosoKeyValut.vault.azure.net/keys/testkey
146+
```
147+
148+
```powershell
149+
$ws = Get-AzSynapseWorkspace -name ContosoWorkspace
150+
$ws.Encryption.CustomerManagedKeyDetails.KekIdentity
151+
```
152+
153+
```output
154+
UserAssignedIdentity UseSystemAssignedIdentity
155+
-------------------- -------------------------
156+
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/ContosoResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uaminame False
138157
```
139158

140-
This commands updates workspace Encryption Managed Identity as User Assigned and specify an user assigned identity Id to access your customer-managed key stored in key vault.
159+
This commands updates workspace Encryption Managed Identity as User Assigned and specify an user assigned identity Id to access your customer-managed key stored in key vault. After updating, we can call `Get-AzSynapseWorkspace` to get Encryption properties of workspace.
141160

142161
## PARAMETERS
143162

0 commit comments

Comments
 (0)