Skip to content

Commit

Permalink
New help.
Browse files Browse the repository at this point in the history
  • Loading branch information
sergey-shandar committed Sep 19, 2017
1 parent b0958e9 commit 040ac7c
Show file tree
Hide file tree
Showing 2 changed files with 192 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -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.

181 changes: 176 additions & 5 deletions experiments/Compute.Experiments/help/New-AzVm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ Creates a virtual machine and all required resources.
## SYNTAX

```
New-AzVm [-Name] <String> [[-Credential] <PSCredential>] [[-ImageName] <String>]
[[-ResourceGroupName] <String>] [[-Location] <String>] [[-VirtualNetworkName] <String>]
[[-PublicIpAddressName] <String>] [[-SecurityGroupName] <String>]
New-AzVm [-Name] <String> [-Credential] <PSCredential> [[-ResourceGroupName] <String>] [[-Location] <String>]
[[-VirtualNetworkName] <String>] [-AddressPrefix <String>] [-SubnetName <String>]
[-SubnetAddressPrefix <String>] [[-PublicIpAddressName] <String>] [-DomainNameLabel <String>]
[-AllocationMethod <String>] [[-SecurityGroupName] <String>] [-OpenPorts <Int32[]>] [[-ImageName] <String>]
[-Size <String>] [-AzureRmContext <Object>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -32,21 +34,98 @@ 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
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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 040ac7c

Please sign in to comment.