Skip to content

Commit 248fc7e

Browse files
Karmah24Karmah24
authored
cmk encryption examples update (Azure#24692)
added quotes
1 parent 597c005 commit 248fc7e

File tree

6 files changed

+40
-22
lines changed

6 files changed

+40
-22
lines changed

‎src/DataProtection/DataProtection.Autorest/docs/Get-AzDataProtectionBackupVault.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ First command gets a specific vault by given vault name, then we fetch the secur
9898

9999
### Example 4: Get encryption settings of backup vault.
100100
```powershell
101-
$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName <resourceGroupName> -VaultName <vaultName>
101+
$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName"
102102
$vault.EncryptionSetting |fl
103103
$vault.EncryptionSetting.CmkIdentity |fl
104104
$vault.EncryptionSetting.CmkKeyVaultProperty |fl

‎src/DataProtection/DataProtection.Autorest/docs/New-AzDataProtectionBackupVault.md‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,23 @@ This command creates a new backup vault while setting Immutability state, cross
6363

6464
### Example 3: Create a Backup Vault with CMK
6565
```powershell
66-
$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType "<DataStoreType>" -Type "<Type>"
66+
$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant
6767
$userAssignedIdentity = @{
68-
"<userAssignedId1>" = @{
69-
clientId = "<clientId1>"
70-
principalId = "<principalId1>"
68+
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami" = @{
69+
clientId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
70+
principalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
7171
}
72-
"<userAssignedId2>" = @{
73-
clientId = "<clientId2>"
74-
principalId = "<principalId2>"
72+
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami2" = @{
73+
clientId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
74+
principalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
7575
}
7676
}
77-
New-AzDataProtectionBackupVault -SubscriptionId <subscriptionId> -ResourceGroupName <resourceGroupName> -VaultName <vaultName> -Location <location> -StorageSetting $storagesetting -IdentityType UserAssigned -UserAssignedIdentity $userAssignedIdentity -CmkEncryptionState Enabled -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId <cmkUserAssignedIdentityId> -CmkEncryptionKeyUri <cmkEncryptionKeyUri> -CmkInfrastructureEncryption Enabled
77+
78+
$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"
79+
80+
$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"
81+
82+
New-AzDataProtectionBackupVault -SubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Location "location" -StorageSetting $storagesetting -IdentityType UserAssigned -UserAssignedIdentity $userAssignedIdentity -CmkEncryptionState Enabled -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId -CmkEncryptionKeyUri $cmkKeyUri -CmkInfrastructureEncryption Enabled
7883
```
7984

8085
```output

‎src/DataProtection/DataProtection.Autorest/docs/Update-AzDataProtectionBackupVault.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ These parameters are optional and can be used independently.
8989

9090
### Example 4: Update vault CmkIdentityType from UserAssignedManagedIdentity to SystemAssignedManagedIdentity and CmkEncryptionKeyUri
9191
```powershell
92-
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri "cmkKeyUri"
92+
$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"
93+
94+
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri $cmkKeyUri
9395
```
9496

9597
```output
@@ -103,7 +105,9 @@ These parameters are optional and can be used independently.
103105

104106
### Example 5: Update vault CmkIdentityType from SystemAssignedManagedIdentity to UserAssignedManagedIdentity
105107
```powershell
106-
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId "cmkIdentityId" -CmkEncryptionKeyUri "cmkEncryptionKeyUri"
108+
$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"
109+
110+
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId
107111
```
108112

109113
```output

‎src/DataProtection/DataProtection.Autorest/examples/Get-AzDataProtectionBackupVault.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ First command gets a specific vault by given vault name, then we fetch the secur
5555

5656
### Example 4: Get encryption settings of backup vault.
5757
```powershell
58-
$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName <resourceGroupName> -VaultName <vaultName>
58+
$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName"
5959
$vault.EncryptionSetting |fl
6060
$vault.EncryptionSetting.CmkIdentity |fl
6161
$vault.EncryptionSetting.CmkKeyVaultProperty |fl

‎src/DataProtection/DataProtection.Autorest/examples/New-AzDataProtectionBackupVault.md‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,23 @@ This command creates a new backup vault while setting Immutability state, cross
3030

3131
### Example 3: Create a Backup Vault with CMK
3232
```powershell
33-
$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType "<DataStoreType>" -Type "<Type>"
33+
$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant
3434
$userAssignedIdentity = @{
35-
"<userAssignedId1>" = @{
36-
clientId = "<clientId1>"
37-
principalId = "<principalId1>"
35+
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami" = @{
36+
clientId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
37+
principalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
3838
}
39-
"<userAssignedId2>" = @{
40-
clientId = "<clientId2>"
41-
principalId = "<principalId2>"
39+
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami2" = @{
40+
clientId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
41+
principalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
4242
}
4343
}
44-
New-AzDataProtectionBackupVault -SubscriptionId <subscriptionId> -ResourceGroupName <resourceGroupName> -VaultName <vaultName> -Location <location> -StorageSetting $storagesetting -IdentityType UserAssigned -UserAssignedIdentity $userAssignedIdentity -CmkEncryptionState Enabled -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId <cmkUserAssignedIdentityId> -CmkEncryptionKeyUri <cmkEncryptionKeyUri> -CmkInfrastructureEncryption Enabled
44+
45+
$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"
46+
47+
$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"
48+
49+
New-AzDataProtectionBackupVault -SubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Location "location" -StorageSetting $storagesetting -IdentityType UserAssigned -UserAssignedIdentity $userAssignedIdentity -CmkEncryptionState Enabled -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId -CmkEncryptionKeyUri $cmkKeyUri -CmkInfrastructureEncryption Enabled
4550
```
4651

4752
```output

‎src/DataProtection/DataProtection.Autorest/examples/Update-AzDataProtectionBackupVault.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ This command is used to modify Immutability state, cross subscription restore st
4040

4141
### Example 4: Update vault CmkIdentityType from UserAssignedManagedIdentity to SystemAssignedManagedIdentity and CmkEncryptionKeyUri
4242
```powershell
43-
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri "cmkKeyUri"
43+
$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"
44+
45+
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri $cmkKeyUri
4446
```
4547

4648
```output
@@ -53,7 +55,9 @@ This command is used to modify CmkIdentityType and CmkEncryptionKeyUri. These pa
5355

5456
### Example 5: Update vault CmkIdentityType from SystemAssignedManagedIdentity to UserAssignedManagedIdentity
5557
```powershell
56-
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId "cmkIdentityId" -CmkEncryptionKeyUri "cmkEncryptionKeyUri"
58+
$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"
59+
60+
Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId
5761
```
5862

5963
```output

0 commit comments

Comments
 (0)