From 040ac7c53a38bcdd63bb696b76cf4c87b50af7bc Mon Sep 17 00:00:00 2001 From: Sergey Shandar Date: Tue, 19 Sep 2017 16:31:19 -0700 Subject: [PATCH] New help. --- .../help/AzureRM.Compute.Experiments.md | 16 ++ .../Compute.Experiments/help/New-AzVm.md | 181 +++++++++++++++++- 2 files changed, 192 insertions(+), 5 deletions(-) create mode 100644 experiments/Compute.Experiments/help/AzureRM.Compute.Experiments.md diff --git a/experiments/Compute.Experiments/help/AzureRM.Compute.Experiments.md b/experiments/Compute.Experiments/help/AzureRM.Compute.Experiments.md new file mode 100644 index 000000000000..7cf6d49ac3ef --- /dev/null +++ b/experiments/Compute.Experiments/help/AzureRM.Compute.Experiments.md @@ -0,0 +1,16 @@ +--- +Module Name: AzureRM.Compute.Experiments +Module Guid: {{ Update Module Guid }} +Download Help Link: {{ Update Download Link }} +Help Version: {{ Update Help Version }} +Locale: {{ Update Locale }} +--- + +# AzureRM.Compute.Experiments Module +## Description +{{Manually Enter Description Here}} + +## AzureRM.Compute.Experiments Cmdlets +### [New-AzVm](New-AzVm.md) +Creates a virtual machine and all required resources. + diff --git a/experiments/Compute.Experiments/help/New-AzVm.md b/experiments/Compute.Experiments/help/New-AzVm.md index 8f75bd817378..fb3dca5e579b 100644 --- a/experiments/Compute.Experiments/help/New-AzVm.md +++ b/experiments/Compute.Experiments/help/New-AzVm.md @@ -13,9 +13,11 @@ Creates a virtual machine and all required resources. ## SYNTAX ``` -New-AzVm [-Name] [[-Credential] ] [[-ImageName] ] - [[-ResourceGroupName] ] [[-Location] ] [[-VirtualNetworkName] ] - [[-PublicIpAddressName] ] [[-SecurityGroupName] ] +New-AzVm [-Name] [-Credential] [[-ResourceGroupName] ] [[-Location] ] + [[-VirtualNetworkName] ] [-AddressPrefix ] [-SubnetName ] + [-SubnetAddressPrefix ] [[-PublicIpAddressName] ] [-DomainNameLabel ] + [-AllocationMethod ] [[-SecurityGroupName] ] [-OpenPorts ] [[-ImageName] ] + [-Size ] [-AzureRmContext ] [-AsJob] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,7 +34,68 @@ Creates a virtual machine with name `MyCoolVM`. ## PARAMETERS +### -AddressPrefix +Specifies a range of IP addresses for a virtual network. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllocationMethod +Specifies the method with which to allocate the public IP address. The acceptable values for this parameter are: Static or Dynamic. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Specifies the cmdlet executes as a job. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureRmContext +Azure context. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Credential + Specifies the user name and password for the virtual machine as a PSCredential object. ```yaml @@ -40,13 +103,29 @@ Type: PSCredential Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -DomainNameLabel + +Specifies the relative DNS name for a public IP address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImageName A name of virtual machine image. @@ -92,6 +171,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OpenPorts +Ports. + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PublicIpAddressName Specifies a name of PublicIPAddress object to assign to a network interface. @@ -137,6 +231,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Size +Specifies the size for the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetAddressPrefix +Specifies a range of IP addresses for a subnet configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Specifies the name of the subnet configuration to create. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VirtualNetworkName Specifies a Virtual Network name. @@ -152,11 +291,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### None - ## OUTPUTS ### System.Object