Aladdin generated examples for Compute, Monitor, Network, Resources, Sql, Websites #15567

aladdindoc · 2021-07-28T00:26:44Z

Add Aladdin crafted examples.

- Add new examples to the following modules: Compute Monitor Network Resources Sql Websites

ghost · 2021-07-28T00:26:48Z

Thank you for your contribution aladdindoc! We will review the pull request and get back to you soon.

isra-fel · 2021-07-28T02:11:31Z

Hi Mike would you be able to review this? Thanks

mikefrobbins · 2021-08-03T14:53:23Z

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

@@ -56,6 +56,15 @@ Modifies the state of a VMSS instance. (autogenerated)

 ```powershell <!-- Aladdin Generated Example --> 
 Set-AzVmssVM -InstanceId <String> -Reimage -ResourceGroupName myresourcegroup -VMScaleSetName 'VMSS001'
+```powershell


Line 59 appears to be the ending code fence. Closing code blocks should not include a language type.

I'll take a look why the language type was added.

mikefrobbins · 2021-08-03T14:58:31Z

src/Monitor/Monitor/help/Add-AzAutoscaleSetting.md

@@ -37,7 +37,7 @@ This cmdlet implements the ShouldProcess pattern, i.e. it might request confirma
 ## EXAMPLES

 ### Example 1: Create an Autoscale setting
-```
+```powershell


I don't see a closing code fence for example 1.

That's at the line 50.

mikefrobbins · 2021-08-03T15:01:16Z

src/Network/Network/help/Add-AzApplicationGatewayTrustedClientCertificate.md

@@ -32,6 +32,15 @@ PS C:\> $gw = Set-AzApplicationGateway -ApplicationGateway $gw

 The first command gets the application gateway and stores it in $gw variable. The second command creates a new trusted client CA certificate chain taking path of the client CA certificate as input. The third command creates a SSL profile using trusted client certificate. The fourth command updates the Application Gateway.

+### Example 2
+
+The first command gets the application gateway and stores it in $gw variable. The second command creates a new trusted client CA certificate chain taking path of the client CA certificate as input. The third command creates a SSL profile using trusted client certificate. The fourth command updates the Application Gateway. (autogenerated)


This text appears to be duplicated from the previous paragraph and doesn't match up with what's occurring in the example.

mikefrobbins · 2021-08-03T15:16:11Z

src/Network/Network/help/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -ResourceGroupName resourceGroup -VirtualNetworkGatewayName 'ContosoVirtualNetwork' -ResourceName 'ContosoVirtualNetwork' -InputObject <PSVirtualNetworkGateway> -ResourceId <String>


The parameters VirtualNetworkGatewayName, InputObject, and ResourceId are in mutually exclusive parameter sets and can't be used together.

Is there a way to check that they are mutually exclusive? In the documentation, there is only one parameter set and all those three parameters are optional.

The parameter set documentation appears to be inaccurate for the Get-AzVirtualNetworkGatewayVpnClientConnectionHealth cmdlet. Get-Command -Name Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -Syntax is the command I used to determine the parameter sets.

mikefrobbins · 2021-08-03T15:19:15Z

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

@@ -25,7 +25,7 @@ Creates a disk encryption set.
 ### Example 1
 ```powershell
 PS C:\> $config = New-AzDiskEncryptionSetConfig -Location 'westcentralus' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1 -IdentityType 'SystemAssigned'
-PS C:\> New-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' -DiskEncryptionSet $config;
+PS C:\> New-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' -DiskEncryptionSet $config


There isn't a DiskEncryptionSet parameter. DiskEncryptionSet is a parameter alias for the InputObject parameter.

This is an existing example. Aladdin doesn't add it.
I can convert it to $config | New-AzDiskEncryptionSet ...

mikefrobbins · 2021-08-03T17:52:37Z

src/Monitor/Monitor/help/Add-AzAutoscaleSetting.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+Add-AzAutoscaleSetting -AutoscaleProfile <List`1> -DisableSetting -Location 'East US' -Name 'MySetting' -ResourceGroupName 'Default-Web-EastUS' -TargetResourceId '/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm'


The value for the AutoscaleProfile parameter should be <List[AutoscaleProfile]>.

mikefrobbins · 2021-08-03T17:56:59Z

src/Monitor/Monitor/help/New-AzDataCollectionRule.md

+PS C:\>New-AzDataCollectionRule -Location 'East US 2 EUAP' -ResourceGroupName 'testdcr' `
+                                -RuleName 'newDcrEx2' -RuleFile 'C:\samples\dcrEx2.json' `
+                                -Description 'Dcr description' `


How does this example differ from example 1?

No. And this is not added by Aladdin. I can remove it manually.
The change here is to append '`' at the end to make the commands in both example properly multiline commands.

mikefrobbins · 2021-08-03T18:08:30Z

src/Network/Network/help/Disconnect-AzVirtualNetworkGatewayVpnConnection.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+Disconnect-AzVirtualNetworkGatewayVpnConnection -ResourceGroupName vnetgwrg -VirtualNetworkGatewayName 'ContosoVirtualNetwork' -VpnConnectionId @('IKEv2_00000000-0000-0000-0000-00000000000000000') -InputObject <PSVirtualNetworkGateway>


The parameters ResourceGroupName and VirtualNetworkGatewayName are in a different parameter set than VpnConnectionId and InputObject and can't be used together because they're mutually exclusive.

mikefrobbins · 2021-08-03T18:17:44Z

src/Network/Network/help/New-AzExpressRouteGateway.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+New-AzExpressRouteGateway -MaxScaleUnits <UInt32> -MinScaleUnits 2 -Name 'testExpressRoutegw' -ResourceGroupName 'testRG' -Tag '/Sql' -VirtualHubName <String>


The Tag parameter requires a hashtable for its value. The specified value is not a valid hashtable.

mikefrobbins · 2021-08-03T18:23:36Z

src/Network/Network/help/Set-AzApplicationGatewayAutoscaleConfiguration.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> -MaxCapacity 4 -MinCapacity 5


This doesn't seem valid. How can the minimum capacity be more than the maximum capacity?

kceiw · 2021-08-11T22:02:03Z

src/Network/Network/help/Add-AzLoadBalancerInboundNatRuleConfig.md

+
+<!-- Aladdin Generated Example -->
+```powershell
+Add-AzLoadBalancerInboundNatRuleConfig -BackendPort 3350 -FrontendIpConfiguration <PSFrontendIPConfiguration> -FrontendPort 3350 -Name 'NewNatRule' -Protocol 'TCP' -LoadBalancer <PSLoadBalancer>


Will remove this example

mikefrobbins

LGTM

Add new examples to Compute, Monitor, Network, Resources, Sql, Websites

6442a79

- Add new examples to the following modules: Compute Monitor Network Resources Sql Websites

aladdindoc requested review from dkulkarni-ms, grizzlytheodore, haagha, madewithsmiles, MikhailTryakhov, MS-syh2qs and Sandido as code owners July 28, 2021 00:26

ghost added the customer-reported label Jul 28, 2021

isra-fel assigned mikefrobbins Jul 28, 2021

isra-fel added Doc - Reference needs-review labels Jul 28, 2021

kceiw requested a review from dcaro July 28, 2021 16:02

Update examples

a742f8d

mikefrobbins requested changes Aug 3, 2021

View reviewed changes

Update examples according to the feedback.

e65e637

kceiw reviewed Aug 11, 2021

View reviewed changes

Remove the duplicate example.

3d69451

mikefrobbins approved these changes Aug 31, 2021

View reviewed changes

dcaro merged commit 20e4a17 into Azure:main Sep 27, 2021

Aladdin generated examples for Compute, Monitor, Network, Resources, Sql, Websites #15567

Aladdin generated examples for Compute, Monitor, Network, Resources, Sql, Websites #15567

Uh oh!

Conversation

aladdindoc commented Jul 28, 2021

Uh oh!

ghost commented Jul 28, 2021

Uh oh!

isra-fel commented Jul 28, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikefrobbins left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!