[PS Relay] Add breaking change announcement (Azure#27975)

Co-authored-by: Vincent Dai <23257217+vidai-msft@users.noreply.github.com>

Author: JoyerJin

src/Relay/Relay.Autorest/Properties/AssemblyInfo.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the Apache License, Version 2.0 (the ""License"");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an ""AS IS"" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
+// is regenerated.
+
+using System;
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
+[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
+[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
+[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Relay")]
+[assembly: System.Reflection.AssemblyFileVersionAttribute("2.1.0")]
+[assembly: System.Reflection.AssemblyVersionAttribute("2.1.0")]
+[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
+[assembly: System.CLSCompliantAttribute(false)]
+

src/Relay/Relay.Autorest/README.md

@@ -44,6 +44,25 @@ use-extension:
   "@autorest/powershell": "3.x"
 
 directive:
+  - where:
+      verb: Get
+      subject: NameSpace
+    set:
+      breaking-change:
+        change-description: "The type of property 'PrivateEndpointConnection' will be changed to 'List'."
+        deprecated-by-version: 9.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11/03
+
+  - where:
+      subject: NamespaceNetworkRuleSet
+    set:
+      breaking-change:
+        change-description: "The type of property 'IPRule' will be changed to 'List'."
+        deprecated-by-version: 9.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11/03
+
   # Namespace Authorization Rule
   - from: swagger-document
     where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}"].put.operationId

src/Relay/Relay.Autorest/docs/Az.Relay.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.Relay
-Module Guid: 4bf8fb16-5644-49f6-85ac-c4c6573a2ecd
+Module Guid: 8255faf9-3ba7-48f7-a2f5-bce38ad11823
 Download Help Link: https://learn.microsoft.com/powershell/module/az.relay
 Help Version: 1.0.0.0
 Locale: en-US

src/Relay/Relay.Autorest/docs/New-AzRelayHybridConnection.md

@@ -92,7 +92,7 @@ This cmdlet creates a new Hybrid Connection using an existing Hybrid Connection
 ### Example 3: Update an existing Hybrid Connection
 ```powershell
 $connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02
-$connection.UserMetadata = "TestHybirdConnection2"
+$connection.UserMetadata = "TestHybridConnection2"
 New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List
 ```
 
@@ -113,7 +113,7 @@ SystemDataLastModifiedBy     :
 SystemDataLastModifiedByType : 
 Type                         : Microsoft.Relay/namespaces/hybridconnections
 UpdatedAt                    : 1/1/0001 12:00:00 AM
-UserMetadata                 : TestHybirdConnection2
+UserMetadata                 : TestHybridConnection2
 ```
 
 This cmdlet updates an existing Hybrid Connection.

src/Relay/Relay.Autorest/docs/Set-AzRelayAuthorizationRule.md

@@ -82,7 +82,7 @@ Type                         : Microsoft.Relay/Namespaces/AuthorizationRules
 
 This cmdlet adds Listen from the access rights of the authorization rule for the Relay namespace.
 
-### Example 2: Adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter
+### Example 2: Adds Send from the access rights of the authorization rule for the Relay namespace with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -105,7 +105,7 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/Namespaces/AuthorizationRules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Relay namespace with InputObject parameter.
 
 ### Example 3: Set or update Listen from the access rights of the authorization rule for the Hybrid Connection
 ```powershell
@@ -130,7 +130,7 @@ Type                         : Microsoft.Relay/namespaces/hybridconnections/auth
 
 This cmdlet set or update Listen from the access rights of the authorization rule for the Hybrid Connection.
 
-### Example 4: Adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter
+### Example 4: Adds Send from the access rights of the authorization rule for the Hybrid Connection with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -153,7 +153,7 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/namespaces/hybridconnections/authorizationrules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Hybrid Connection with InputObject parameter.
 
 ### Example 5: Adds Send from the access rights of the authorization rule for the Wcf Relay
 ```powershell
@@ -178,7 +178,7 @@ Type                         : Microsoft.Relay/namespaces/wcfrelays/authorizatio
 
 This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay.
 
-### Example 6: Adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter
+### Example 6: Adds Send from the access rights of the authorization rule for the Wcf Relay with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -201,7 +201,7 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/namespaces/wcfrelays/authorizationrules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay with InputObject parameter.
 
 ## PARAMETERS
 

src/Relay/Relay.Autorest/docs/Set-AzRelayHybridConnection.md

@@ -64,7 +64,7 @@ This example updates the UserMetadata property with new value.
 ### Example 2: Updates a HybridConnection in the specified Relay namespace
 ```powershell
 $connection = Get-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01
-$connection.UserMetadata = "testHybirdConnection"
+$connection.UserMetadata = "testHybridConnection"
 Set-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01 -InputObject $connection | Format-List
 ```
 
@@ -85,7 +85,7 @@ SystemDataLastModifiedBy     :
 SystemDataLastModifiedByType : 
 Type                         : Microsoft.Relay/namespaces/hybridconnections
 UpdatedAt                    : 3/30/2023 6:28:37 AM
-UserMetadata                 : testHybirdConnection
+UserMetadata                 : testHybridConnection
 ```
 
 This command updates a HybridConnection in the specified Relay namespace.

src/Relay/Relay.Autorest/examples/New-AzRelayHybridConnection.md

@@ -57,7 +57,7 @@ This cmdlet creates a new Hybrid Connection using an existing Hybrid Connection
 ### Example 3: Update an existing Hybrid Connection
 ```powershell
 $connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02
-$connection.UserMetadata = "TestHybirdConnection2"
+$connection.UserMetadata = "TestHybridConnection2"
 New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List
 ```
 
@@ -78,7 +78,7 @@ SystemDataLastModifiedBy     :
 SystemDataLastModifiedByType : 
 Type                         : Microsoft.Relay/namespaces/hybridconnections
 UpdatedAt                    : 1/1/0001 12:00:00 AM
-UserMetadata                 : TestHybirdConnection2
+UserMetadata                 : TestHybridConnection2
 ```
 
 This cmdlet updates an existing Hybrid Connection.

src/Relay/Relay.Autorest/examples/Set-AzRelayAuthorizationRule.md

@@ -21,7 +21,7 @@ Type                         : Microsoft.Relay/Namespaces/AuthorizationRules
 
 This cmdlet adds Listen from the access rights of the authorization rule for the Relay namespace.
 
-### Example 2: Adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter
+### Example 2: Adds Send from the access rights of the authorization rule for the Relay namespace with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -44,7 +44,7 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/Namespaces/AuthorizationRules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Relay namespace with InputObject parameter.
 
 ### Example 3: Set or update Listen from the access rights of the authorization rule for the Hybrid Connection
 ```powershell
@@ -69,7 +69,7 @@ Type                         : Microsoft.Relay/namespaces/hybridconnections/auth
 
 This cmdlet set or update Listen from the access rights of the authorization rule for the Hybrid Connection.
 
-### Example 4: Adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter
+### Example 4: Adds Send from the access rights of the authorization rule for the Hybrid Connection with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -92,7 +92,7 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/namespaces/hybridconnections/authorizationrules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Hybrid Connection with InputObject parameter.
 
 ### Example 5: Adds Send from the access rights of the authorization rule for the Wcf Relay
 ```powershell
@@ -117,7 +117,7 @@ Type                         : Microsoft.Relay/namespaces/wcfrelays/authorizatio
 
 This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay.
 
-### Example 6: Adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter
+### Example 6: Adds Send from the access rights of the authorization rule for the Wcf Relay with InputObject parameter
 ```powershell
 $authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01
 $authRule.Rights += 'Send'
@@ -140,4 +140,4 @@ SystemDataLastModifiedByType :
 Type                         : Microsoft.Relay/namespaces/wcfrelays/authorizationrules
 ```
 
-This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter.
+This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay with InputObject parameter.

src/Relay/Relay.Autorest/examples/Set-AzRelayHybridConnection.md

@@ -29,7 +29,7 @@ This example updates the UserMetadata property with new value.
 ### Example 2: Updates a HybridConnection in the specified Relay namespace
 ```powershell
 $connection = Get-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01
-$connection.UserMetadata = "testHybirdConnection"
+$connection.UserMetadata = "testHybridConnection"
 Set-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01 -InputObject $connection | Format-List
 ```
 
@@ -50,7 +50,7 @@ SystemDataLastModifiedBy     :
 SystemDataLastModifiedByType : 
 Type                         : Microsoft.Relay/namespaces/hybridconnections
 UpdatedAt                    : 3/30/2023 6:28:37 AM
-UserMetadata                 : testHybirdConnection
+UserMetadata                 : testHybridConnection
 ```
 
 This command updates a HybridConnection in the specified Relay namespace.

src/Relay/Relay.Autorest/generate-info.json

@@ -1,3 +1,3 @@
 {
-  "generate_Id": "5852a5c9-5477-4633-9018-0e4cfe80bd0e"
+  "generate_Id": "b611364a-a616-431f-a83e-8d9485996016"
 }