Skip to content

Adding missing examples for Network cmlets #3447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 30, 2017
Merged

Adding missing examples for Network cmlets #3447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
142caec
Adding missing examples
Jan 30, 2017
5424066
Update to MD files
Jan 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 134 additions & 3 deletions src/ResourceManager/Network/Commands.Network/Microsoft.Azure.Commands.Network.dll-Help.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15281,6 +15281,28 @@ PS C:\> Get-AzureRmLoadBalancerRuleConfig -Name "MyLBrulename" -Loa
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 Get an IP configuration of a network interface --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code>PS C:\&gt; $nic1 = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName $myrg

PS C:\&gt; Get-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -NetworkInterface $nic1</dev:code>
<dev:remarks>
<maml:para>The first command gets an existing network interface called mynic and stores it in the variable $nic1. The second command gets the IP configuration called ipconfig1 of this network interface.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText>
<maml:para />
</command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
</maml:relatedLinks>
Expand Down Expand Up @@ -27738,6 +27760,61 @@ New-AzureRmNetworkInterface -Name NetworkInterface1 -ResourceGroupName ResourceG
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 Create an IP configuration with a public IP address for a network interface --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code>PS C:\&gt; $vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
PS C:\&gt; $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet
PS C:\&gt; $PIP1 = Get-AzureRmPublicIPAddress -Name &quot;PIP1&quot; -ResourceGroupName &quot;RG1&quot;

PS C:\&gt; $IPConfig1 = New-AzureRmNetworkInterfaceIpConfig -Name &quot;IPConfig-1&quot; -Subnet $Subnet -PublicIpAddress $PIP1 -Primary

PS C:\&gt; $nic = New-AzureRmNetworkInterface -Name $NicName -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig1
</dev:code>
<dev:remarks>
<maml:para>The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously created public IP address called PIP1. The forth command creates a new IP configuration called &quot;IPConfig-1&quot; as the primary IP configuration with a public IP address associated with it.
The last command then creates a network interface called mynic1 using this IP configuration.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText>
<maml:para />
</command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>-------------------------- Example 2 Create an IP configuration with a private IP address --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code>PS C:\&gt; $vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
PS C:\&gt; $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet


PS C:\&gt; $IPConfig2 = New-AzureRmNetworkInterfaceIpConfig -Name &quot;IP-Config2&quot; -Subnet $Subnet -PrivateIpAddress 10.0.0.5

PS C:\&gt; $nic = New-AzureRmNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig2</dev:code>
<dev:remarks>
<maml:para>The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP configuration called &quot;IPConfig-2&quot; with a private IP address 10.0.0.5 associated with it.
The last command then creates a network interface called mynic1 using this IP configuration.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText>
<maml:para />
</command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
</maml:relatedLinks>
Expand Down Expand Up @@ -35729,13 +35806,15 @@ InboundNatPools : []</maml:para>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- 1: --------------------------</maml:title>
<maml:title>-------------------------- 1: Delete an inbound NAT rule from an Azure load balancer --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code></dev:code>
<dev:code>PS C:\&gt; $loadbalancer = Get-AzureRmLoadBalancer -Name mylb -ResourceGroupName myrg

PS C:\&gt; Remove-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;myinboundnatrule&quot; -LoadBalancer $loadbalancer</dev:code>
<dev:remarks>
<maml:para />
<maml:para>The first command loads an already existing load balancer called &quot;mylb&quot; and stores it in the variable $load balancer. The second command removes the inbound NAT rule associated with this load balancer.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
Expand Down Expand Up @@ -36807,6 +36886,28 @@ PS C:&gt; Remove-AzureRmLoadBalancerRuleConfig -Name &quot;MyLBruleName&quot; -
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 Delete an IP configuration from a network interface --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code>PS C:\&gt; $nic = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName myrg

PS C:\&gt; Remove-AzureRmNetworkInterfaceIpConfig -Name IPConfig-1 -NetworkInterface $nic</dev:code>
<dev:remarks>
<maml:para>The first command gets a network interface called mynic and stores it in the variable $nic. The second command removes the IP configuration called IPConfig-1 associated with this network interface.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText>
<maml:para />
</command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
</maml:relatedLinks>
Expand Down Expand Up @@ -47807,6 +47908,36 @@ Set-AzureRmNetworkInterface -NetworkInterface $nic</dev:code>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 Changing the IP address of an IP configuration --------------------------</maml:title>
<maml:introduction>
<maml:paragraph>PS C:\&gt;</maml:paragraph>
</maml:introduction>
<dev:code>PS C:\&gt; $vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
PS C:\&gt; $subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet

PS C:\&gt; $nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg

PS C:\&gt; $nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -Primary

PS C:\&gt; $nic | Set-AzureRmNetworkInterface


</dev:code>
<dev:remarks>
<maml:para>The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP configuration that needs to be updated. The third command sets the private IP address of the primary IP configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes have been made successfully.</maml:para>
<maml:para />
<maml:para />
<maml:para></maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText>
<maml:para />
</command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
</maml:relatedLinks>
Expand Down
9 changes: 6 additions & 3 deletions ...rceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterfaceIpConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@ The **Get-AzureRmNetworkInterfaceIPConfig** cmdlet gets a network interface IP c

## EXAMPLES

### 1:
### 1: Get an IP configuration of a network interface
```

$nic1 = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName $myrg
Get-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -NetworkInterface $nic1
```

The first command gets an existing network interface called mynic and stores it in the variable $nic1. The second
command gets the IP configuration called ipconfig1 of this network interface.

## PARAMETERS

### -Name
Expand Down
32 changes: 31 additions & 1 deletion ...rceManager/Network/Commands.Network/help/New-AzureRmNetworkInterfaceIpConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,40 @@ The **New-AzureRmNetworkInterfaceIpConfig** cmdlet creates an Azure network inte

## EXAMPLES

### 1:
### 1: Create an IP configuration with a public IP address for a network interface
```
$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet
$PIP1 = Get-AzureRmPublicIPAddress -Name "PIP1" -ResourceGroupName "RG1"

$IPConfig1 = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig-1" -Subnet $Subnet -PublicIpAddress $PIP1
-Primary

$nic = New-AzureRmNetworkInterface -Name $NicName -ResourceGroupName myrg -Location westus
-IpConfiguration $IpConfig1
```

The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were
previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously
created public IP address called PIP1. The forth command creates a new IP configuration called "IPConfig-1" as the
primary IP configuration with a public IP address associated with it.
The last command then creates a network interface called mynic1 using this IP configuration.

### 2: Create an IP configuration with a private IP address
```
$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet

$IPConfig2 = New-AzureRmNetworkInterfaceIpConfig -Name "IP-Config2" -Subnet $Subnet -PrivateIpAddress
10.0.0.5

$nic = New-AzureRmNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration
$IpConfig2
```
The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were
previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP
configuration called "IPConfig-2" with a private IP address 10.0.0.5 associated with it.
The last command then creates a network interface called mynic1 using this IP configuration.

## PARAMETERS

Expand Down
8 changes: 7 additions & 1 deletion ...Network/Commands.Network/help/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@ The **Remove-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet removes an inbound

## EXAMPLES

### 1:
### 1: Delete an inbound NAT rule from an Azure load balancer
```

$loadbalancer = Get-AzureRmLoadBalancer -Name mylb -ResourceGroupName myrg

Remove-AzureRmLoadBalancerInboundNatRuleConfig -Name "myinboundnatrule" -LoadBalancer $loadbalancer

```
The first command loads an already existing load balancer called "mylb" and stores it in the variable $load
balancer. The second command removes the inbound NAT rule associated with this load balancer.

## PARAMETERS

Expand Down
10 changes: 9 additions & 1 deletion ...Manager/Network/Commands.Network/help/Remove-AzureRmNetworkInterfaceIpConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,19 @@ The **Remove-AzureRmNetworkInterfaceIpConfig** cmdlet removes a network interfac

## EXAMPLES

### 1:
### 1: Delete an IP configuration from a network interface

```

$nic = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName myrg

Remove-AzureRmNetworkInterfaceIpConfig -Name IPConfig-1 -NetworkInterface $nic
```

The first command gets a network interface called mynic and stores it in the variable $nic. The second command
removes the IP configuration called IPConfig-1 associated with this network interface.


## PARAMETERS

### -Name
Expand Down
18 changes: 16 additions & 2 deletions ...rceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterfaceIpConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,25 @@ The **Set-AzureRmNetworkInterfaceIpConfig** cmdlet sets the goal state for an Az

## EXAMPLES

### 1:
### 1: Changing the IP address of an IP configuration
```
$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg
$subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet

```
$nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg

$nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet
-Primary

$nic | Set-AzureRmNetworkInterface

```
The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the
variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP
configuration that needs to be updated. The third command sets the private IP address of the primary IP
configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes
have been made successfully.

## PARAMETERS

### -Name
Expand Down