Skip to content

Commit ead7af0

Browse files
committed
update per comments
1 parent 4a814e4 commit ead7af0

File tree

50 files changed

+388
-387
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+388
-387
lines changed

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/NewAzureApiManagmentProperty.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ public class NewAzureApiManagementProperty : AzureApiManagementCmdletBase
6464
ValueFromPipelineByPropertyName = true,
6565
Mandatory = false,
6666
HelpMessage = "Tags to be associated with Property. This parameter is optional.")]
67-
[Obsolete("This property will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
68-
[Alias("Tag")]
69-
public string[] Tags { get; set; }
67+
[Obsolete("New-AzureRmApiManagementProperty: -Tags will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
68+
[Alias("Tags")]
69+
public string[] Tag { get; set; }
7070

7171
public override void ExecuteApiManagementCmdlet()
7272
{
@@ -79,7 +79,7 @@ public override void ExecuteApiManagementCmdlet()
7979
Name,
8080
Value,
8181
Secret,
82-
Tags);
82+
Tag);
8383
#pragma warning restore CS0618
8484

8585
WriteObject(logger);

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementProperty.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ public class SetAzureApiManagementProperty : AzureApiManagementCmdletBase
6262
ValueFromPipelineByPropertyName = true,
6363
Mandatory = false,
6464
HelpMessage = "Tags associated with a property. This parameter is optional.")]
65-
[Obsolete("This property will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
66-
[Alias("Tag")]
67-
public string[] Tags { get; set; }
65+
[Obsolete("Set-AzureRmApiManagementProperty: -Tags will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
66+
[Alias("Tags")]
67+
public string[] Tag { get; set; }
6868

6969
[Parameter(
7070
ValueFromPipelineByPropertyName = true,
@@ -83,7 +83,7 @@ public override void ExecuteApiManagementCmdlet()
8383
Name,
8484
Value,
8585
Secret,
86-
Tags);
86+
Tag);
8787
#pragma warning restore CS0618
8888

8989
if (PassThru)

src/ResourceManager/ApiManagement/Commands.ApiManagement/Commands/NewAzureApiManagement.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
9393
ValueFromPipelineByPropertyName = true,
9494
Mandatory = false,
9595
HelpMessage = "Tags dictionary.")]
96-
[Obsolete("This property will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
97-
[Alias("Tag")]
98-
public Dictionary<string, string> Tags { get; set; }
96+
[Obsolete("New-AzureRmApiManagement: -Tags will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
97+
[Alias("Tags")]
98+
public Dictionary<string, string> Tag { get; set; }
9999

100100
[Parameter(
101101
ValueFromPipelineByPropertyName = true,
@@ -116,7 +116,7 @@ public override void ExecuteCmdlet()
116116
Sku ?? PsApiManagementSku.Developer,
117117
Capacity ?? 1,
118118
VpnType,
119-
Tags,
119+
Tag,
120120
VirtualNetwork,
121121
AdditionalRegions),
122122
passThru: true);

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagement.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml
3-
Module Name: azurerm.ApiManagement
3+
Module Name: AzureRM.ApiManagement
44
ms.assetid: 164C5205-01BA-47BB-B780-D0B9AE614A4B
55
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagement
66
schema: 2.0.0
@@ -17,7 +17,7 @@ Creates an API Management deployment.
1717
New-AzureRmApiManagement -ResourceGroupName <String> -Name <String> -Location <String> -Organization <String>
1818
-AdminEmail <String> [-Sku <PsApiManagementSku>] [-Capacity <Int32>] [-VpnType <PsApiManagementVpnType>]
1919
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
20-
[-Tags <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
20+
[-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
2121
[-AdditionalRegions <PsApiManagementRegion[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2222
```
2323

@@ -209,13 +209,13 @@ Accept pipeline input: True (ByPropertyName)
209209
Accept wildcard characters: False
210210
```
211211
212-
### -Tags
213-
Specifies a dictionary of tags.
212+
### -Tag
213+
Tags dictionary.
214214
215215
```yaml
216216
Type: System.Collections.Generic.Dictionary`2[System.String,System.String]
217217
Parameter Sets: (All)
218-
Aliases: Tag
218+
Aliases: Tags
219219

220220
Required: False
221221
Position: Named

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProperty.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
3+
Module Name: AzureRM.ApiManagement
34
ms.assetid: A91F93D3-B8C7-4328-A049-AB9877C1166C
45
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementproperty
56
schema: 2.0.0
@@ -14,7 +15,7 @@ Creates a new Property.
1415

1516
```
1617
New-AzureRmApiManagementProperty -Context <PsApiManagementContext> [-PropertyId <String>] -Name <String>
17-
-Value <String> [-Secret] [-Tags <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
-Value <String> [-Secret] [-Tag <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -49,7 +50,7 @@ Specifies a **PsApiManagementContext** object.
4950
```yaml
5051
Type: PsApiManagementContext
5152
Parameter Sets: (All)
52-
Aliases:
53+
Aliases:
5354

5455
Required: True
5556
Position: Named
@@ -81,7 +82,7 @@ Names contain only letters, digits, period, dash, and underscore characters.
8182
```yaml
8283
Type: String
8384
Parameter Sets: (All)
84-
Aliases:
85+
Aliases:
8586

8687
Required: True
8788
Position: Named
@@ -98,7 +99,7 @@ If you do not specify an ID, this cmdlet generates one.
9899
```yaml
99100
Type: String
100101
Parameter Sets: (All)
101-
Aliases:
102+
Aliases:
102103

103104
Required: False
104105
Position: Named
@@ -113,7 +114,7 @@ Indicates that the property value is a secret and should be encrypted.
113114
```yaml
114115
Type: SwitchParameter
115116
Parameter Sets: (All)
116-
Aliases:
117+
Aliases:
117118

118119
Required: False
119120
Position: Named
@@ -122,14 +123,13 @@ Accept pipeline input: True (ByPropertyName)
122123
Accept wildcard characters: False
123124
```
124125
125-
### -Tags
126-
Specifies an array of tags that this cmdlet associates to the property.
127-
You can use tags to filter the property list.
126+
### -Tag
127+
Tags to be associated with Property. This parameter is optional.
128128
129129
```yaml
130130
Type: String[]
131131
Parameter Sets: (All)
132-
Aliases: Tag
132+
Aliases: Tags
133133

134134
Required: False
135135
Position: Named
@@ -147,7 +147,7 @@ The value may not be empty or consist only of whitespace.
147147
```yaml
148148
Type: String
149149
Parameter Sets: (All)
150-
Aliases:
150+
Aliases:
151151

152152
Required: True
153153
Position: Named

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProperty.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
3+
Module Name: AzureRM.ApiManagement
34
ms.assetid: 5C0C437D-7237-4B40-A254-1B55916F1C71
45
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementproperty
56
schema: 2.0.0
@@ -14,8 +15,8 @@ Modifies an API Management Property.
1415

1516
```
1617
Set-AzureRmApiManagementProperty -Context <PsApiManagementContext> -PropertyId <String> [-Name <String>]
17-
[-Value <String>] [-Secret <Boolean>] [-Tags <String[]>] [-PassThru]
18-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
[-Value <String>] [-Secret <Boolean>] [-Tag <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>]
19+
[<CommonParameters>]
1920
```
2021

2122
## DESCRIPTION
@@ -51,7 +52,7 @@ Specifies a **PsApiManagementContext** object.
5152
```yaml
5253
Type: PsApiManagementContext
5354
Parameter Sets: (All)
54-
Aliases:
55+
Aliases:
5556

5657
Required: True
5758
Position: Named
@@ -83,7 +84,7 @@ Names contain only letters, digits, period, dash, and underscore characters.
8384
```yaml
8485
Type: String
8586
Parameter Sets: (All)
86-
Aliases:
87+
Aliases:
8788

8889
Required: False
8990
Position: Named
@@ -98,7 +99,7 @@ Indicates that this cmdlet returns the **PsApiManagementProperty** that this cmd
9899
```yaml
99100
Type: SwitchParameter
100101
Parameter Sets: (All)
101-
Aliases:
102+
Aliases:
102103

103104
Required: False
104105
Position: Named
@@ -113,7 +114,7 @@ Specifies an ID of the property that this cmdlet modifies.
113114
```yaml
114115
Type: String
115116
Parameter Sets: (All)
116-
Aliases:
117+
Aliases:
117118

118119
Required: True
119120
Position: Named
@@ -128,7 +129,7 @@ Indicates that the property value is a secret and should be encrypted.
128129
```yaml
129130
Type: Boolean
130131
Parameter Sets: (All)
131-
Aliases:
132+
Aliases:
132133

133134
Required: False
134135
Position: Named
@@ -137,14 +138,13 @@ Accept pipeline input: True (ByPropertyName)
137138
Accept wildcard characters: False
138139
```
139140
140-
### -Tags
141-
Specifies an array of tags that this cmdlet associates to the property.
142-
You can use tags to filter the property list.
141+
### -Tag
142+
Tags associated with a property. This parameter is optional.
143143
144144
```yaml
145145
Type: String[]
146146
Parameter Sets: (All)
147-
Aliases: Tag
147+
Aliases: Tags
148148

149149
Required: False
150150
Position: Named
@@ -162,7 +162,7 @@ The value may not be empty or consist only of whitespace.
162162
```yaml
163163
Type: String
164164
Parameter Sets: (All)
165-
Aliases:
165+
Aliases:
166166

167167
Required: False
168168
Position: Named

src/ResourceManager/Automation/Commands.Automation.Test/UnitTests/SetAzureAutomationRunbookTest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public void SetAzureAutomationRunbookByNameWithParametersSuccessfull()
8080
this.cmdlet.ResourceGroupName = resourceGroupName;
8181
this.cmdlet.AutomationAccountName = accountName;
8282
this.cmdlet.Name = runbookName;
83-
this.cmdlet.Tags = tags;
83+
this.cmdlet.Tag = tags;
8484
this.cmdlet.LogProgress = logProgress;
8585
this.cmdlet.ExecuteCmdlet();
8686

src/ResourceManager/Automation/Commands.Automation/Cmdlet/SetAzureAutomationRunbook.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ public class SetAzureAutomationRunbook : AzureAutomationBaseCmdlet
4646
/// Gets or sets the runbook tags.
4747
/// </summary>
4848
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The runbook tags.")]
49-
[Obsolete("This property will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
50-
[Alias("Tag")]
51-
public IDictionary Tags { get; set; }
49+
[Obsolete("Set-AzureRmAutomationRunbook: -Tags will be removed in favor of -Tag in an upcoming breaking change release. Please start using the -Tag parameter to avoid breaking scripts.")]
50+
[Alias("Tags")]
51+
public IDictionary Tag { get; set; }
5252

5353
/// <summary>
5454
/// Gets or sets a value indicating whether progress logging should be turned on or off.
@@ -75,7 +75,7 @@ protected override void AutomationProcessRecord()
7575
this.AutomationAccountName,
7676
this.Name,
7777
this.Description,
78-
this.Tags,
78+
this.Tag,
7979
this.LogProgress,
8080
this.LogVerbose);
8181
#pragma warning restore CS0618

src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationRunbook.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml
33
Module Name: AzureRM.Automation
44
ms.assetid: 920C028B-0471-43EB-9123-C444289FD845
@@ -14,7 +14,7 @@ Modifies a runbook.
1414
## SYNTAX
1515

1616
```
17-
Set-AzureRmAutomationRunbook [-Name] <String> [-Description <String>] [-Tags <IDictionary>]
17+
Set-AzureRmAutomationRunbook [-Name] <String> [-Description <String>] [-Tag <IDictionary>]
1818
[-LogProgress <Boolean>] [-LogVerbose <Boolean>] [-ResourceGroupName] <String>
1919
[-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2020
```
@@ -39,7 +39,7 @@ Specifies the name of the Automation account in which this cmdlet modifies a run
3939
```yaml
4040
Type: String
4141
Parameter Sets: (All)
42-
Aliases:
42+
Aliases:
4343

4444
Required: True
4545
Position: 1
@@ -69,7 +69,7 @@ Specifies a description for the runbook.
6969
```yaml
7070
Type: String
7171
Parameter Sets: (All)
72-
Aliases:
72+
Aliases:
7373

7474
Required: False
7575
Position: Named
@@ -84,7 +84,7 @@ Specifies whether the runbook logs progress.
8484
```yaml
8585
Type: Boolean
8686
Parameter Sets: (All)
87-
Aliases:
87+
Aliases:
8888

8989
Required: False
9090
Position: Named
@@ -99,7 +99,7 @@ Specifies whether logging includes detailed information.
9999
```yaml
100100
Type: Boolean
101101
Parameter Sets: (All)
102-
Aliases:
102+
Aliases:
103103

104104
Required: False
105105
Position: Named
@@ -129,7 +129,7 @@ Specifies the name of the resource group for which this cmdlet modifies a runboo
129129
```yaml
130130
Type: String
131131
Parameter Sets: (All)
132-
Aliases:
132+
Aliases:
133133

134134
Required: True
135135
Position: 0
@@ -138,13 +138,13 @@ Accept pipeline input: True (ByPropertyName)
138138
Accept wildcard characters: False
139139
```
140140
141-
### -Tags
142-
Specifies a dictionary of tags to replace the current tags of the modified runbook.
141+
### -Tag
142+
The runbook tags.
143143
144144
```yaml
145145
Type: IDictionary
146146
Parameter Sets: (All)
147-
Aliases: Tag
147+
Aliases: Tags
148148

149149
Required: False
150150
Position: Named

0 commit comments

Comments
 (0)