Skip to content

Commit aeabd5d

Browse files
committed
Update Help .md for New-AzVM, New-AzVmss, Set-AzVMProxyAgentSetting, and Set-AzVmssProxyAgentSetting
1 parent 27b4fc4 commit aeabd5d

File tree

4 files changed

+66
-6
lines changed

4 files changed

+66
-6
lines changed

src/Compute/Compute/help/New-AzVM.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ New-AzVM [[-ResourceGroupName] <String>] [[-Location] <String>] [-EdgeZone <Stri
3030
[-SharedGalleryImageId <String>] [-SecurityType <String>] [-EnableVtpm <Boolean>]
3131
[-EnableSecureBoot <Boolean>] [-IfMatch <String>] [-IfNoneMatch <String>] [-SshKeyType <String>]
3232
[-ZonePlacementPolicy <String>] [-IncludeZone <String[]>] [-ExcludeZone <String[]>]
33-
[-AlignRegionalDisksToVMZone] [-EnableProxyAgent] [-DefaultProfile <IAzureContextContainer>]
33+
[-AlignRegionalDisksToVMZone] [-EnableProxyAgent] [-AddProxyAgentExtension] [-DefaultProfile <IAzureContextContainer>]
3434
[-WhatIf] [-Confirm] [<CommonParameters>]
3535
```
3636

@@ -633,6 +633,21 @@ Accept pipeline input: True (ByPropertyName)
633633
Accept wildcard characters: False
634634
```
635635

636+
### -AddProxyAgentExtension
637+
Specifies whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux OS.
638+
639+
```yaml
640+
Type: System.Management.Automation.SwitchParameter
641+
Parameter Sets: SimpleParameterSet
642+
Aliases:
643+
644+
Required: False
645+
Position: Named
646+
Default value: None
647+
Accept pipeline input: True (ByPropertyName)
648+
Accept wildcard characters: False
649+
```
650+
636651
### -EnableSecureBoot
637652
Specifies whether secure boot should be enabled on the virtual machine.
638653

src/Compute/Compute/help/New-AzVmss.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ New-AzVmss [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-AsJob] [
3939
[-DiskControllerType <String>] [-SharedGalleryImageId <String>] [-SecurityType <String>]
4040
[-EnableVtpm <Boolean>] [-EnableSecureBoot <Boolean>] [-SecurityPostureId <String>]
4141
[-SecurityPostureExcludeExtension <String[]>] [-SkuProfileVmSize <String[]>]
42-
[-SkuProfileAllocationStrategy <String>] [-EnableProxyAgent] [-DefaultProfile <IAzureContextContainer>]
42+
[-SkuProfileAllocationStrategy <String>] [-EnableProxyAgent] [-AddProxyAgentExtension] [-DefaultProfile <IAzureContextContainer>]
4343
[-SinglePlacementGroup] [-WhatIf] [-Confirm] [<CommonParameters>]
4444
```
4545

@@ -496,6 +496,21 @@ Accept pipeline input: True (ByPropertyName)
496496
Accept wildcard characters: False
497497
```
498498

499+
### -AddProxyAgentExtension
500+
Specifies whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux OS.
501+
502+
```yaml
503+
Type: System.Management.Automation.SwitchParameter
504+
Parameter Sets: SimpleParameterSet
505+
Aliases:
506+
507+
Required: False
508+
Position: Named
509+
Default value: None
510+
Accept pipeline input: True (ByPropertyName)
511+
Accept wildcard characters: False
512+
```
513+
499514
### -EnableSecureBoot
500515
Specifies whether secure boot should be enabled on the virtual machine.
501516

src/Compute/Compute/help/Set-AzVMProxyAgentSetting.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Sets the Proxy Agent settings properties for a PSVirtualMachine object.
1313
## SYNTAX
1414

1515
```
16-
Set-AzVMProxyAgentSetting -VM <PSVirtualMachine> [-EnableProxyAgent <Boolean>] [-WireServerMode <String>]
16+
Set-AzVMProxyAgentSetting -VM <PSVirtualMachine> [-EnableProxyAgent <Boolean>] [-AddProxyAgentExtension <Boolean>] [-WireServerMode <String>]
1717
[-WireServerProfile <String>] [-ImdsMode <String>] [-ImdsProfile <String>] [-KeyIncarnationId <Int32>]
1818
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
@@ -26,7 +26,7 @@ Sets the Proxy Agent settings properties for a PSVirtualMachine object.
2626
### Example 1
2727
```powershell
2828
$vmconfig = New-AzVMConfig -VMName $vmName -VMSize "Standard_D2s_v3"
29-
Set-AzVMProxyAgentSetting -VM $vmconfig -EnableProxyAgent $true -WireServerMode "Enforce" -ImdsProfile "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}"
29+
Set-AzVMProxyAgentSetting -VM $vmconfig -EnableProxyAgent $true -AddProxyAgentExtension false -WireServerMode "Enforce" -ImdsProfile "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}"
3030
```
3131

3232
This command sets the Proxy Agent settings for a virtual machine configuration object `$vmconfig`.
@@ -64,6 +64,21 @@ Accept pipeline input: True (ByPropertyName)
6464
Accept wildcard characters: False
6565
```
6666
67+
### -AddProxyAgentExtension
68+
Specifies whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux OS.
69+
70+
```yaml
71+
Type: System.Nullable`1[System.Boolean]
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
6782
### -ImdsMode
6883
Specifies the IMDS endpoint execution mode.
6984
In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints.

src/Compute/Compute/help/Set-AzVmssProxyAgentSetting.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Sets the Proxy Agent settings properties for a PSVirtualMachineScaleSet object.
1313
## SYNTAX
1414

1515
```
16-
Set-AzVmssProxyAgentSetting -VirtualMachineScaleSet <PSVirtualMachineScaleSet> [-EnableProxyAgent <Boolean>]
16+
Set-AzVmssProxyAgentSetting -VirtualMachineScaleSet <PSVirtualMachineScaleSet> [-EnableProxyAgent <Boolean>] [-AddProxyAgentExtension <Boolean>]
1717
[-WireServerMode <String>] [-WireServerProfile <String>] [-ImdsMode <String>] [-ImdsProfile <String>]
1818
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
@@ -26,7 +26,7 @@ Sets the Proxy Agent settings properties for a PSVirtualMachineScaleSet object.
2626
### Example 1
2727
```powershell
2828
$vmssConfig = New-AzVmssConfig -Location 'EastUS2' -SkuName 'Standard_D4s_v3'
29-
Set-AzVmssProxyAgentSetting -VirtualMachineScaleSet $vmssConfig -EnableProxyAgent $true -WireServerProfile '/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}' -ImdsProfile '/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}'
29+
Set-AzVmssProxyAgentSetting -VirtualMachineScaleSet $vmssConfig -EnableProxyAgent $true -AddProxyAgentExtension false -WireServerProfile '/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}' -ImdsProfile '/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}'
3030
```
3131

3232
This command sets the Proxy Agent settings for a virtual machine scale set configuration object `$vmssConfig`.
@@ -64,6 +64,21 @@ Accept pipeline input: True (ByPropertyName)
6464
Accept wildcard characters: False
6565
```
6666
67+
### -AddProxyAgentExtension
68+
Specifies whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux OS.
69+
70+
```yaml
71+
Type: System.Nullable`1[System.Boolean]
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
6782
### -ImdsMode
6883
Specifies the IMDS endpoint execution mode.
6984
In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints.

0 commit comments

Comments
 (0)