Skip to content

Fix Az.Peering Syntax Errors #17738

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
wyunchi-ms merged 3 commits into from
May 7, 2022
Merged

Fix Az.Peering Syntax Errors #17738

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6053bde
Fix Az.Peering Syntax Errors
v-yuzhichen Apr 7, 2022
823620f
Fix Az.Peering Syntax Errors
v-yuzhichen Apr 15, 2022
58661ad
Fix Az.Peering Syntax Errors
Apr 27, 2022
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
6 changes: 3 additions & 3 deletions src/Peering/Peering/help/New-AzPeering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Creates an ARM Peering for the subscription. See [New-AzPeeringDirectConnectionO
### Create New Direct Peering
```powershell
#Gets the ASN
$asn = Get-AzPeerAsn -PeerName Contoso
$asn = Get-AzPeerAsn -Name Contoso
#Gets the Direct Peering Location
$location = Get-AzPeeringLocation Direct -PeeringLocation Seattle
#Creates the ARM Resource
Expand All @@ -70,7 +70,7 @@ Create a new Direct Peering with a single connection at the Seattle facility usi
### Create New Exchange Peering
```powershell
#Gets the ASN
$asn = Get-AzPeerAsn -PeerName Contoso
$asn = Get-AzPeerAsn -Name Contoso
#Gets the Exchange Peering Location
$location = Get-AzPeeringLocation Exchange -PeeringLocation Seattle
#Creates the ARM Resource
Expand All @@ -96,7 +96,7 @@ Create a new exchange peering
### Convert Legacy Peering to ARM Peering
```powershell
#Gets the ASN
$asn = Get-AzPeerAsn -PeerName Contoso
$asn = Get-AzPeerAsn -Name Contoso
#Gets the legacy Peering
$legacy = Get-AzLegacyPeering -PeeringLocation Amsterdam -Kind Direct | New-AzPeering -Name ContosoAmsterdamPeering -ResourceGroupName testCarrier -PeeringLocation $location.PeeringLocation -PeerAsnResourceId $asn.Id
```
Expand Down
4 changes: 2 additions & 2 deletions src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ Create registered prefixes for peering objects.
### Example 1: Get peering and create a registered prefix
```powershell
$peering = Get-AzPeering -ResourceGroupName $resourceGroupName -Name $name
$peering | New-AzPeeringRegisteredPrefix -Name $asnName -Asn $asn
$peering | New-AzPeeringRegisteredPrefix -Name $asnName
Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$peering | New-AzPeeringRegisteredPrefix -Name $asnName -Prefix $prefix

```

Get the peering you want to add a registered prefix. Then pass that to the commandlet.

### Example 2: Use peering resourceId to create a registered asn
Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example 2: Use peering resourceId to create a registered prefix

```powershell
New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Asn $asn
New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnNames
Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Prefix $prefix

```

## PARAMETERS
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/help/New-AzPeeringService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Creates peering service.

### Example 1
```powershell
New-AzPeeringService -ResourceGroupName $resourceGroup -Name $name -Location $loc -PeeringServiceProvider $provider
New-AzPeeringService -ResourceGroupName $resourceGroup -Name $name -PeeringServiceProvider $provider
```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/help/Remove-AzPeerAsn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Remove a PeerAsn from the subscription.

### Example 1
```powershell
Remove-AzPeerAsn -PeerName Contoso -Force
Remove-AzPeerAsn -Name Contoso -Force
```

Removes the Peer Asn
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Remove a prefix from a peering service resource id.

### Example 3
```powershell
Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -PeeringServiceName $peeringServiceName -Name $prefixName -PassThru
Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -Name $prefixName -PassThru
Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

40: Get-AzPeeringServicePrefix -ResourceGroupName $rgName -PeeringServiceName $peeringServiceName -Name $prefixName | Remove-AzPeeringServicePrefix

47: Remove-AzPeeringServicePrefix -ResourceId $peeringServicePrefixResourceId -PassThru

58: Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -Name $peeringServiceName -PrefixName $prefixName -PassThru

```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/help/Set-AzPeerAsn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Allows you to update contact information for a PeerAsn on the subscription.
### Example 1
```powershell
#Get the Peer ASN object
Get-AzPeerAsn -PeerName Contoso | Set-AzPeerAsn -Email [email protected]
Get-AzPeerAsn -Name Contoso | Set-AzPeerAsn
```

```output
Expand Down
6 changes: 3 additions & 3 deletions src/Peering/Peering/help/Set-AzPeeringDirectConnectionObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,21 @@ Used in conjunction with Update-AzPeering, this is an in memory operation and wi

### Example 1: Upgrade Bandwidth
```powershell
$update = Get-AzPeering -PeerName "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -BandwidthInMbps 30000
$update = Get-AzPeering -Name "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -BandwidthInMbps 30000
```

Upgrades the bandwidth for the first connection in the Peering object in memory.

### Example 2: Update Bgp Session Address
```powershell
$update = Get-AzPeering -PeerName "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -SessionPrefixV4 "192.168.0.1" -MaxPrefixesAdvertisedIPv4 20000
$update = Get-AzPeering -Name "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -SessionPrefixV4 "192.168.0.1" -MaxPrefixesAdvertisedIPv4 20000
```

Updates the Peering Address for the first connection in the Peering object in memory.

### Example 3: Update Use for peering service
```powershell
$update = Get-AzPeering -PeerName "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -UseForPeeringService $true
$update = Get-AzPeering -Name "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringDirectConnectionObject -UseForPeeringService $true
```

```output
Expand Down
4 changes: 2 additions & 2 deletions src/Peering/Peering/help/Set-AzPeeringExchangeConnectionObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ Used in conjunction with Update-AzPeering, this is an in memory operation and wi

### Example 1: Update Md5 Hash
```powershell
$update = Get-AzPeering -PeerName "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringExchangeConnectionObject -MD5AuthenticationKey $hash
$update = Get-AzPeering -Name "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringExchangeConnectionObject -MD5AuthenticationKey $hash
```

Updates the Md5 Hash for the first connection in the Peering object in memory.

### Example 2: Update Bgp Session Address
```powershell
$update = Get-AzPeering -PeerName "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringExchangeConnectionObject -PeerSessionIPv4Address "192.168.0.1" -MaxPrefixesAdvertisedIPv4 20000
$update = Get-AzPeering -Name "ContosoPeering" -ResourceGroupName rg1 | Set-AzPeeringExchangeConnectionObject -PeerSessionIPv4Address "192.168.0.1" -MaxPrefixesAdvertisedIPv4 20000
```

Updates the Peering Address for the first connection in the Peering object in memory.
Expand Down
6 changes: 3 additions & 3 deletions src/Peering/Peering/help/Update-AzPeering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Sets the PSPeering Object

### Example 1: Update Md5 Authentication Key
```powershell
$peering = Get-AzPeering -ResourceGroupName rg1 -PeerName "ContosoPeering"
$peering = Get-AzPeering -ResourceGroupName rg1 -Name "ContosoPeering"
$peering.Connections[0] = $peering.Connections[0] | Set-AzPeeringDirectConnectionObject -MD5AuthenticationKey $hash
$peering | Update-AzPeering
```
Expand All @@ -64,7 +64,7 @@ Sets the Md5 Authentication Key

### Example 2: Update UseForPeeringService
```powershell
Update-AzPeering -ResourceGroupName rg1 -Name ContosoPeering -UseForPeeringService $true
Update-AzPeering -ResourceGroupName rg1 -Name ContosoPeering
Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete the entire example

Copy link
Contributor Author

@v-yuzhichen v-yuzhichen Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why delete the entire example?

Copy link
Contributor

@ziyuezh576 ziyuezh576 Apr 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without "UseForPeeringService" parameter, this example is meaningless. It updates nothing.

```

```output
Expand All @@ -86,7 +86,7 @@ Sets the Use for Peering Service Flag

### Example 3: Update IPv4 Address for Exchange Peering
```powershell
$peering = Get-AzPeering -ResourceGroupName rg1 -PeerName "ContosoExchangePeering"
$peering = Get-AzPeering -ResourceGroupName rg1 -Name "ContosoExchangePeering"
$peering.Connections[0] = $peering.Connections[0] | Set-AzPeeringExchangeConnectionObject -PeerSessionIPv4Address $ipv4Address
Update-AzPeering -ResourceId $peering.Id $peering.Connections
```
Expand Down