Fix Az.Peering Syntax Errors (#17738)

* Fix Az.Peering Syntax Errors

* Fix Az.Peering Syntax Errors

* Fix Az.Peering Syntax Errors

Co-authored-by: Ziyue Zheng <[email protected]>

Author: v-yuzhichen

src/Peering/Peering/help/New-AzPeering.md

@@ -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
@@ -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
@@ -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
 ```

src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md

@@ -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 -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
+### Example 2: Use peering resourceId to create a registered prefix
 ```powershell
-New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Asn $asn
+New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Prefix $prefix
 ```
 
 ## PARAMETERS

src/Peering/Peering/help/New-AzPeeringService.md

@@ -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

src/Peering/Peering/help/Remove-AzPeerAsn.md

@@ -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

src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md

@@ -37,25 +37,25 @@ Removes a peering service prefix from a peering service.
 
 ### Example 1
 ```powershell
-Get-AzPeeringService -ResourceGroupName $rgName -Name $peeringServiceName | Remove-AzPeeringServicePrefix -Name $prefixName
+Get-AzPeeringServicePrefix -ResourceGroupName $rgName -PeeringServiceName $peeringServiceName -Name $prefixName | Remove-AzPeeringServicePrefix
 ```
 
-Remove a prefix from a peering service object
+Remove a prefix from a peering service prefix object
 
 ### Example 2
 ```powershell
-Remove-AzPeeringServicePrefix -ResourceId $peeringServiceResourceId -Name $prefixName -PassThru
+Remove-AzPeeringServicePrefix -ResourceId $peeringServicePrefixResourceId -PassThru
 ```
 
 ```output
 True
 ```
 
-Remove a prefix from a peering service resource id.
+Remove a prefix from a peering service prefix resource id.
 
 ### Example 3
 ```powershell
-Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -PeeringServiceName $peeringServiceName -Name $prefixName -PassThru
+Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -Name $peeringServiceName -PrefixName $prefixName -PassThru
 ```
 
 ```output

src/Peering/Peering/help/Set-AzPeerAsn.md

@@ -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

src/Peering/Peering/help/Set-AzPeeringDirectConnectionObject.md

@@ -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

src/Peering/Peering/help/Set-AzPeeringExchangeConnectionObject.md

@@ -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. 

src/Peering/Peering/help/Update-AzPeering.md

@@ -55,38 +55,16 @@ 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
 ```
 
 Sets the Md5 Authentication Key
 
-### Example 2: Update UseForPeeringService
+### Example 2: Update IPv4 Address for Exchange Peering
 ```powershell
-Update-AzPeering -ResourceGroupName rg1 -Name ContosoPeering -UseForPeeringService $true
-```
-
-```output
-Name                 : ContosoPeering
-Sku.Name             : Premium_Direct_Free
-Kind                 : Direct
-Connections          : {71}
-PeerAsn.Id           : /subscriptions//providers/Microsoft.Peering/peerAsns/Contoso
-UseForPeeringService : True
-PeeringLocation      : Seattle
-ProvisioningState    : Succeeded
-Location             : West US 2
-Id                   : /subscriptions//resourceGroups/rg1/providers/Microsoft.Peering/peerings/ContosoPeering
-Type                 : Microsoft.Peering/peerings
-Tags                 : {[tag2, value2], [tag1, value1]}
-```
-
-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
 ```