Skip to content

Commit 6938f1a

Browse files
authored
Remove HostNamePrefix (#21526)
* Remove `HostNamePrefix` * Add change log * update markdown * Add breakingChangeIssues.csv
1 parent 98b92e9 commit 6938f1a

36 files changed

+1855
-96
lines changed

src/SignalR/SignalR/ChangeLog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Breaking change:
22+
- Removed `HostNamePrefix` property of output type `PSSignalRResource` of following cmdlets:
23+
- `Get-AzSignalR`
24+
- `New-AzSignalR`
25+
- `Update-AzSignalR`
2126

2227
## Version 1.5.0
2328
* Updated to API version 2022-08-01-preview

src/SignalR/SignalR/Cmdlets/GetAzureRmSignalR.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,11 @@
1818
using Microsoft.Azure.Commands.SignalR.Models;
1919
using Microsoft.Azure.Commands.SignalR.Properties;
2020
using Microsoft.Azure.Management.SignalR;
21-
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2221

2322
namespace Microsoft.Azure.Commands.SignalR.Cmdlets
2423
{
2524
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SignalR", DefaultParameterSetName = ListSignalRServiceParameterSet)]
2625
[OutputType(typeof(PSSignalRResource))]
27-
[CmdletOutputBreakingChange(typeof(PSSignalRResource), DeprecatedOutputProperties = new String[] { nameof(PSSignalRResource.HostNamePrefix) })]
2826
public class GetAzureRmSignalR : SignalRCmdletBase, IWithResourceId
2927
{
3028
[Parameter(

src/SignalR/SignalR/Cmdlets/NewAzureRmSignalR.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
// limitations under the License.
1313
// ----------------------------------------------------------------------------------
1414

15-
using System;
1615
using System.Collections.Generic;
1716
using System.Management.Automation;
1817
using Microsoft.Azure.Commands.Common.Strategies;
@@ -21,14 +20,12 @@
2120
using Microsoft.Azure.Management.Internal.Resources;
2221
using Microsoft.Azure.Management.SignalR;
2322
using Microsoft.Azure.Management.SignalR.Models;
24-
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2523
using Newtonsoft.Json;
2624

2725
namespace Microsoft.Azure.Commands.SignalR.Cmdlets
2826
{
2927
[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SignalR", SupportsShouldProcess = true)]
3028
[OutputType(typeof(PSSignalRResource))]
31-
[CmdletOutputBreakingChange(typeof(PSSignalRResource), DeprecatedOutputProperties = new String[] { nameof(PSSignalRResource.HostNamePrefix) })]
3229
public sealed class NewAzureRmSignalR : SignalRCmdletBase
3330
{
3431
private const string DefaultSku = "Standard_S1";

src/SignalR/SignalR/Cmdlets/UpdateAzureRmSignalR.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,11 @@
2121
using Microsoft.Azure.Commands.SignalR.Properties;
2222
using Microsoft.Azure.Management.SignalR;
2323
using Microsoft.Azure.Management.SignalR.Models;
24-
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2524

2625
namespace Microsoft.Azure.Commands.SignalR.Cmdlets
2726
{
2827
[Cmdlet("Update", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SignalR", SupportsShouldProcess = true, DefaultParameterSetName = ResourceGroupParameterSet)]
2928
[OutputType(typeof(PSSignalRResource))]
30-
[CmdletOutputBreakingChange(typeof(PSSignalRResource), DeprecatedOutputProperties = new String[] { nameof(PSSignalRResource.HostNamePrefix) })]
3129
public class UpdateAzureRmSignalR : SignalRCmdletBase, IWithInputObject, IWithResourceId
3230
{
3331
private const int DefaultUnitCount = 1;

src/SignalR/SignalR/Models/PSSignalRResource.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ public sealed class PSSignalRResource : PSTrackedResource
2323

2424
public string HostName { get; }
2525

26-
public string HostNamePrefix { get; }
27-
2826
public string ProvisioningState { get; }
2927

3028
public int? PublicPort { get; }

src/SignalR/SignalR/SignalR.csproj

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@
2121
</Compile>
2222
</ItemGroup>
2323

24-
25-
26-
27-
2824
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
2925

3026
</Project>

src/SignalR/SignalR/help/Get-AzSignalR.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
150150
## INPUTS
151151
152152
### System.String
153+
153154
## OUTPUTS
154155
155156
### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource
157+
156158
## NOTES
157159
158160
## RELATED LINKS

src/SignalR/SignalR/help/Get-AzSignalRKey.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
148148
## INPUTS
149149
150150
### System.String
151+
151152
### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource
153+
152154
## OUTPUTS
153155
154156
### Microsoft.Azure.Commands.SignalR.Models.PSSignalRKeys
157+
155158
## NOTES
156159
157160
## RELATED LINKS

src/SignalR/SignalR/help/Get-AzWebPubSub.md

Lines changed: 102 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,31 @@ Get the resource and its properties.
1414

1515
### List (Default)
1616
```
17-
Get-AzWebPubSub [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
17+
Get-AzWebPubSub [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break]
18+
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
19+
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
1820
```
1921

2022
### Get
2123
```
2224
Get-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
23-
[-DefaultProfile <PSObject>] [<CommonParameters>]
25+
[-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>]
26+
[-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>]
27+
[-ProxyUseDefaultCredentials] [<CommonParameters>]
2428
```
2529

2630
### List1
2731
```
28-
Get-AzWebPubSub -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
29-
[<CommonParameters>]
32+
Get-AzWebPubSub -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break]
33+
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
34+
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
3035
```
3136

3237
### GetViaIdentity
3338
```
34-
Get-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
39+
Get-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-Break]
40+
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
41+
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
3542
```
3643

3744
## DESCRIPTION
@@ -90,6 +97,21 @@ psdemo-wps eastus Standard_S1
9097

9198
## PARAMETERS
9299

100+
### -Break
101+
Wait for .NET debugger to attach
102+
103+
```yaml
104+
Type: System.Management.Automation.SwitchParameter
105+
Parameter Sets: (All)
106+
Aliases:
107+
108+
Required: False
109+
Position: Named
110+
Default value: False
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
93115
### -DefaultProfile
94116
The credentials, account, tenant, and subscription used for communication with Azure.
95117
@@ -105,6 +127,36 @@ Accept pipeline input: False
105127
Accept wildcard characters: False
106128
```
107129
130+
### -HttpPipelineAppend
131+
SendAsync Pipeline Steps to be appended to the front of the pipeline
132+
133+
```yaml
134+
Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.SendAsyncStep[]
135+
Parameter Sets: (All)
136+
Aliases:
137+
138+
Required: False
139+
Position: Named
140+
Default value: None
141+
Accept pipeline input: False
142+
Accept wildcard characters: False
143+
```
144+
145+
### -HttpPipelinePrepend
146+
SendAsync Pipeline Steps to be prepended to the front of the pipeline
147+
148+
```yaml
149+
Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.SendAsyncStep[]
150+
Parameter Sets: (All)
151+
Aliases:
152+
153+
Required: False
154+
Position: Named
155+
Default value: None
156+
Accept pipeline input: False
157+
Accept wildcard characters: False
158+
```
159+
108160
### -InputObject
109161
Identity Parameter
110162
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
@@ -136,6 +188,51 @@ Accept pipeline input: False
136188
Accept wildcard characters: False
137189
```
138190
191+
### -Proxy
192+
The URI for the proxy server to use
193+
194+
```yaml
195+
Type: System.Uri
196+
Parameter Sets: (All)
197+
Aliases:
198+
199+
Required: False
200+
Position: Named
201+
Default value: None
202+
Accept pipeline input: False
203+
Accept wildcard characters: False
204+
```
205+
206+
### -ProxyCredential
207+
Credentials for a proxy server to use for the remote call
208+
209+
```yaml
210+
Type: System.Management.Automation.PSCredential
211+
Parameter Sets: (All)
212+
Aliases:
213+
214+
Required: False
215+
Position: Named
216+
Default value: None
217+
Accept pipeline input: False
218+
Accept wildcard characters: False
219+
```
220+
221+
### -ProxyUseDefaultCredentials
222+
Use the default credentials for the proxy
223+
224+
```yaml
225+
Type: System.Management.Automation.SwitchParameter
226+
Parameter Sets: (All)
227+
Aliases:
228+
229+
Required: False
230+
Position: Named
231+
Default value: False
232+
Accept pipeline input: False
233+
Accept wildcard characters: False
234+
```
235+
139236
### -ResourceGroupName
140237
The name of the resource group that contains the resource.
141238
You can obtain this value from the Azure Resource Manager API or the portal.
@@ -174,11 +271,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
174271
## INPUTS
175272
176273
### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity
177-
178274
## OUTPUTS
179275
180276
### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubResource
181-
182277
## NOTES
183278
184279
ALIASES

0 commit comments

Comments
 (0)