Skip to content

[PS Relay] Add breaking change announcement #27975

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.

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 4 commits into from
Jun 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions src/Relay/Relay.Autorest/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
@@ -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)]

19 changes: 19 additions & 0 deletions src/Relay/Relay.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Relay/Relay.Autorest/docs/Az.Relay.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/Relay/Relay.Autorest/docs/New-AzRelayHybridConnection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions src/Relay/Relay.Autorest/docs/Set-AzRelayAuthorizationRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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
Expand All @@ -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'
Expand All @@ -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
Expand All @@ -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'
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/Relay/Relay.Autorest/docs/Set-AzRelayHybridConnection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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
Expand All @@ -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'
Expand All @@ -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
Expand All @@ -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'
Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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.
2 changes: 1 addition & 1 deletion src/Relay/Relay.Autorest/generate-info.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"generate_Id": "5852a5c9-5477-4633-9018-0e4cfe80bd0e"
"generate_Id": "b611364a-a616-431f-a83e-8d9485996016"
}
11 changes: 11 additions & 0 deletions src/Relay/Relay.Autorest/resources/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Resources
This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder.

## Info
- Modifiable: yes
- Generated: no
- Committed: yes
- Packaged: no

## Purpose
Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact.
Loading