From 6053bdeada1446954cf575f8968da98a4f453ed0 Mon Sep 17 00:00:00 2001 From: "v-yuzhichen@microsoft.com" Date: Thu, 7 Apr 2022 21:39:39 +0800 Subject: [PATCH 1/3] Fix Az.Peering Syntax Errors --- src/Peering/Peering/help/New-AzPeering.md | 6 +++--- src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md | 4 ++-- src/Peering/Peering/help/New-AzPeeringService.md | 2 +- src/Peering/Peering/help/Remove-AzPeerAsn.md | 2 +- src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md | 2 +- src/Peering/Peering/help/Set-AzPeerAsn.md | 2 +- .../Peering/help/Set-AzPeeringDirectConnectionObject.md | 6 +++--- .../Peering/help/Set-AzPeeringExchangeConnectionObject.md | 4 ++-- src/Peering/Peering/help/Update-AzPeering.md | 6 +++--- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/Peering/Peering/help/New-AzPeering.md b/src/Peering/Peering/help/New-AzPeering.md index ef57d37d7bab..1a302f4abffa 100644 --- a/src/Peering/Peering/help/New-AzPeering.md +++ b/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 ``` diff --git a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md b/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md index 9681e59eabd9..d3381e9cd3e4 100644 --- a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md +++ b/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 ``` 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 ```powershell -New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Asn $asn +New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnNames ``` ## PARAMETERS diff --git a/src/Peering/Peering/help/New-AzPeeringService.md b/src/Peering/Peering/help/New-AzPeeringService.md index 69c1c92517e4..00dc7365b7cf 100644 --- a/src/Peering/Peering/help/New-AzPeeringService.md +++ b/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 diff --git a/src/Peering/Peering/help/Remove-AzPeerAsn.md b/src/Peering/Peering/help/Remove-AzPeerAsn.md index f84296dc1af8..8a774d5a24a7 100644 --- a/src/Peering/Peering/help/Remove-AzPeerAsn.md +++ b/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 diff --git a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md index 5d0e2f4fe5a1..1ed0a00ab331 100644 --- a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md +++ b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md @@ -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 ``` ```output diff --git a/src/Peering/Peering/help/Set-AzPeerAsn.md b/src/Peering/Peering/help/Set-AzPeerAsn.md index 6567ddd6ea98..d6fa15e50a6f 100644 --- a/src/Peering/Peering/help/Set-AzPeerAsn.md +++ b/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 noc1@contoso.com +Get-AzPeerAsn -Name Contoso | Set-AzPeerAsn ``` ```output diff --git a/src/Peering/Peering/help/Set-AzPeeringDirectConnectionObject.md b/src/Peering/Peering/help/Set-AzPeeringDirectConnectionObject.md index 85a38ec0aa70..0f1e2a9fdc87 100644 --- a/src/Peering/Peering/help/Set-AzPeeringDirectConnectionObject.md +++ b/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 diff --git a/src/Peering/Peering/help/Set-AzPeeringExchangeConnectionObject.md b/src/Peering/Peering/help/Set-AzPeeringExchangeConnectionObject.md index 2ee22df34eab..2c35b28226e4 100644 --- a/src/Peering/Peering/help/Set-AzPeeringExchangeConnectionObject.md +++ b/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. diff --git a/src/Peering/Peering/help/Update-AzPeering.md b/src/Peering/Peering/help/Update-AzPeering.md index 34a8c97465bb..75d262b48218 100644 --- a/src/Peering/Peering/help/Update-AzPeering.md +++ b/src/Peering/Peering/help/Update-AzPeering.md @@ -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 ``` @@ -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 ``` ```output @@ -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 ``` From 823620fbc036e4d00563d7bbb946550f87ee0f9b Mon Sep 17 00:00:00 2001 From: "v-yuzhichen@microsoft.com" Date: Fri, 15 Apr 2022 15:45:09 +0800 Subject: [PATCH 2/3] Fix Az.Peering Syntax Errors --- src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md | 4 ++-- src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md b/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md index d3381e9cd3e4..3444c2661477 100644 --- a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md +++ b/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 +$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 ```powershell -New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnNames +New-AzPeeringRegisteredPrefix -ResourceId $resourceId -Name $asnName -Prefix $prefix ``` ## PARAMETERS diff --git a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md index 1ed0a00ab331..30f91e582620 100644 --- a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md +++ b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md @@ -37,14 +37,14 @@ 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 ### Example 2 ```powershell -Remove-AzPeeringServicePrefix -ResourceId $peeringServiceResourceId -Name $prefixName -PassThru +Remove-AzPeeringServicePrefix -ResourceId $peeringServicePrefixResourceId -PassThru ``` ```output @@ -55,7 +55,7 @@ Remove a prefix from a peering service resource id. ### Example 3 ```powershell -Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -Name $prefixName -PassThru +Remove-AzPeeringServicePrefix -ResourceGroupName $peeringServiceGroup -Name $peeringServiceName -PrefixName $prefixName -PassThru ``` ```output From 58661ade16271b9110c86ea3d2cc7ce833cb6b04 Mon Sep 17 00:00:00 2001 From: Ziyue Zheng Date: Wed, 27 Apr 2022 19:56:49 +0800 Subject: [PATCH 3/3] Fix Az.Peering Syntax Errors --- .../help/New-AzPeeringRegisteredPrefix.md | 2 +- .../help/Remove-AzPeeringServicePrefix.md | 4 +-- src/Peering/Peering/help/Update-AzPeering.md | 26 ++----------------- 3 files changed, 5 insertions(+), 27 deletions(-) diff --git a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md b/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md index 3444c2661477..6473bcf0b9cf 100644 --- a/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md +++ b/src/Peering/Peering/help/New-AzPeeringRegisteredPrefix.md @@ -43,7 +43,7 @@ $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 -Prefix $prefix ``` diff --git a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md index 30f91e582620..3f79da524f26 100644 --- a/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md +++ b/src/Peering/Peering/help/Remove-AzPeeringServicePrefix.md @@ -40,7 +40,7 @@ Removes a peering service prefix from a peering service. 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 @@ -51,7 +51,7 @@ Remove-AzPeeringServicePrefix -ResourceId $peeringServicePrefixResourceId -PassT True ``` -Remove a prefix from a peering service resource id. +Remove a prefix from a peering service prefix resource id. ### Example 3 ```powershell diff --git a/src/Peering/Peering/help/Update-AzPeering.md b/src/Peering/Peering/help/Update-AzPeering.md index 75d262b48218..78c3591cc66e 100644 --- a/src/Peering/Peering/help/Update-AzPeering.md +++ b/src/Peering/Peering/help/Update-AzPeering.md @@ -62,31 +62,9 @@ $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 -``` - -```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 -Name "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 ```