Skip to content

Commit c16c2ad

Browse files
Split Az.DedicatedHsm Examples in generation (#17082)
1 parent a52f5ba commit c16c2ad

8 files changed

+52
-28
lines changed

src/DedicatedHsm/docs/Get-AzDedicatedHsm.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ Gets the specified Azure dedicated HSM.
4242

4343
### Example 1: Get all Dedicated HSM under a subscription
4444
```powershell
45-
PS C:\> Get-AzDedicatedHsm
45+
Get-AzDedicatedHsm
46+
```
4647

48+
```output
4749
Name Provisioning State SKU Location
4850
---- ------------------ --- --------
4951
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -54,8 +56,10 @@ This command gets all Dedicated HSM under a subscription
5456

5557
### Example 2: Get all Dedicated HSM under a resource group.
5658
```powershell
57-
PS C:\> Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz
59+
Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz
60+
```
5861

62+
```output
5963
Name Provisioning State SKU Location
6064
---- ------------------ --- --------
6165
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -65,8 +69,10 @@ This command gets all Dedicated HSM under a resource group.
6569

6670
### Example 3: Get a Dedicated HSM by name
6771
```powershell
68-
PS C:\> Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
72+
Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
73+
```
6974

75+
```output
7076
Name Provisioning State SKU Location
7177
---- ------------------ --- --------
7278
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -76,9 +82,11 @@ This command gets a Dedicated HSM by name.
7682

7783
### Example 4: Get a Dedicated HSM by object
7884
```powershell
79-
PS C:\> $hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
80-
PS C:\> Get-AzDedicatedHsm -InputObject $hsm
85+
$hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
86+
Get-AzDedicatedHsm -InputObject $hsm
87+
```
8188

89+
```output
8290
Name Provisioning State SKU Location
8391
---- ------------------ --- --------
8492
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

src/DedicatedHsm/docs/New-AzDedicatedHsm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Create or Update a dedicated HSM in the specified subscription.
2626

2727
### Example 1: Create a Dedicated HSM into an existing virtual network
2828
```powershell
29-
PS C:\> New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
29+
New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
30+
```
3031

32+
```output
3133
Name Provisioning State SKU Location
3234
---- ------------------ --- --------
3335
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

src/DedicatedHsm/docs/Remove-AzDedicatedHsm.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,15 @@ Deletes the specified Azure Dedicated HSM.
3131

3232
### Example 1: Remove a Dedicated HSM by name
3333
```powershell
34-
PS C:\> Remove-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName lucas-manual-test
35-
34+
Remove-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName lucas-manual-test
3635
```
3736

3837
This commnad removes a hardware security module(HSM) by name.
3938

4039
### Example 2: Remove a Dedicated HSM by object
4140
```powershell
42-
PS C:\> $hsm = Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
43-
PS C:\> Remove-AzDedicatedHsm -InputObject $hsm
44-
41+
$hsm = Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
42+
Remove-AzDedicatedHsm -InputObject $hsm
4543
```
4644

4745
This commnad removes a Dedicated HSM by object.

src/DedicatedHsm/docs/Update-AzDedicatedHsm.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Update a dedicated HSM in the specified subscription.
3131

3232
### Example 1: Update the parameter tag of the Dedicated HSM by name
3333
```powershell
34-
PS C:\> Update-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
34+
Update-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
35+
```
3536

37+
```output
3638
Name Provisioning State SKU Location
3739
---- ------------------ --- --------
3840
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus
@@ -42,9 +44,11 @@ This command updates the parameter tag of the Dedicated HSM by name
4244

4345
### Example 2: Update the parameter tag of the Dedicated HSM by object
4446
```powershell
45-
PS C:\> $hsm = Get-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz
46-
PS C:\> Update-AzDedicatedHsm -InputObject -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
47+
$hsm = Get-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz
48+
Update-AzDedicatedHsm -InputObject -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
49+
```
4750

51+
```output
4852
Name Provisioning State SKU Location
4953
---- ------------------ --- --------
5054
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

src/DedicatedHsm/examples/Get-AzDedicatedHsm.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Get all Dedicated HSM under a subscription
22
```powershell
3-
PS C:\> Get-AzDedicatedHsm
3+
Get-AzDedicatedHsm
4+
```
45

6+
```output
57
Name Provisioning State SKU Location
68
---- ------------------ --- --------
79
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -12,8 +14,10 @@ This command gets all Dedicated HSM under a subscription
1214

1315
### Example 2: Get all Dedicated HSM under a resource group.
1416
```powershell
15-
PS C:\> Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz
17+
Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz
18+
```
1619

20+
```output
1721
Name Provisioning State SKU Location
1822
---- ------------------ --- --------
1923
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -23,8 +27,10 @@ This command gets all Dedicated HSM under a resource group.
2327

2428
### Example 3: Get a Dedicated HSM by name
2529
```powershell
26-
PS C:\> Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
30+
Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
31+
```
2732

33+
```output
2834
Name Provisioning State SKU Location
2935
---- ------------------ --- --------
3036
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
@@ -34,9 +40,11 @@ This command gets a Dedicated HSM by name.
3440

3541
### Example 4: Get a Dedicated HSM by object
3642
```powershell
37-
PS C:\> $hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
38-
PS C:\> Get-AzDedicatedHsm -InputObject $hsm
43+
$hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
44+
Get-AzDedicatedHsm -InputObject $hsm
45+
```
3946

47+
```output
4048
Name Provisioning State SKU Location
4149
---- ------------------ --- --------
4250
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

src/DedicatedHsm/examples/New-AzDedicatedHsm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Create a Dedicated HSM into an existing virtual network
22
```powershell
3-
PS C:\> New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
3+
New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
4+
```
45

6+
```output
57
Name Provisioning State SKU Location
68
---- ------------------ --- --------
79
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

src/DedicatedHsm/examples/Remove-AzDedicatedHsm.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
### Example 1: Remove a Dedicated HSM by name
22
```powershell
3-
PS C:\> Remove-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName lucas-manual-test
4-
3+
Remove-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName lucas-manual-test
54
```
65

76
This commnad removes a hardware security module(HSM) by name.
87

98
### Example 2: Remove a Dedicated HSM by object
109
```powershell
11-
PS C:\> $hsm = Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
12-
PS C:\> Remove-AzDedicatedHsm -InputObject $hsm
13-
10+
$hsm = Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
11+
Remove-AzDedicatedHsm -InputObject $hsm
1412
```
1513

1614
This commnad removes a Dedicated HSM by object.

src/DedicatedHsm/examples/Update-AzDedicatedHsm.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Update the parameter tag of the Dedicated HSM by name
22
```powershell
3-
PS C:\> Update-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
3+
Update-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
4+
```
45

6+
```output
57
Name Provisioning State SKU Location
68
---- ------------------ --- --------
79
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus
@@ -11,9 +13,11 @@ This command updates the parameter tag of the Dedicated HSM by name
1113

1214
### Example 2: Update the parameter tag of the Dedicated HSM by object
1315
```powershell
14-
PS C:\> $hsm = Get-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz
15-
PS C:\> Update-AzDedicatedHsm -InputObject -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
16+
$hsm = Get-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz
17+
Update-AzDedicatedHsm -InputObject -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3}
18+
```
1619

20+
```output
1721
Name Provisioning State SKU Location
1822
---- ------------------ --- --------
1923
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus

0 commit comments

Comments
 (0)