Skip to content

Commit f5ae2a2

Browse files
committed
Merge branch 'feature/updateApiVersion' of https://github.com/rileymckenna/azure-powershell into feature/updateApiVersion
2 parents c72dc95 + 3b75c26 commit f5ae2a2

File tree

742 files changed

+13962
-52225
lines changed

Some content is hidden

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

742 files changed

+13962
-52225
lines changed

build.proj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@
263263
</Target>
264264

265265
<Target Name="TestFailureErrorMessage">
266-
<Error Text="Test failures occured, check the files in artifacts/TestResults" />
266+
<Error Text="Test failures occurred, check the files in artifacts/TestResults" />
267267
</Target>
268268

269269
<Target Name="CodeSignBinaries" AfterTargets="Build" Condition="'$(CodeSign)' == 'true'">

documentation/announcing-az-module.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ Az is a new module, and reorganizing and simplifying cmdlet names involves break
2525
| Date | Feature |
2626
-------|----------
2727
| **August 2018** | Initial Release |
28-
| **November 2018** | Functional arity with AzureRM |
28+
| **November 2018** | Functional parity with AzureRM |
2929
| **December 2018** | Az 1.0 Release |
3030
| **January 2019** | New Authentication mechanisms for Windows PowerShell
3131
| | - Username + password authentication
32-
| | - Web broswer control authentication |
32+
| | - Web browser control authentication |
3333

3434

3535

@@ -139,7 +139,7 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
139139
| AzureRM.Media | Az.Media |
140140
| AzureRM.Network | Az.Network |
141141
| AzureRM.NotificationHubs | Az.NotificationHubs |
142-
| AzureRM.OperationalInsights | Az.OperationalIsights |
142+
| AzureRM.OperationalInsights | Az.OperationalInsights |
143143
| AzureRM.PolicyInsights | Az.PolicyInsights |
144144
| AzureRM.PowerBIEmbedded | Az.PowerBIEmbedded* |
145145
| **AzureRM.Profile** | **Az.Accounts** |
@@ -187,7 +187,7 @@ If you need to have both modules installed:
187187
```
188188

189189
##### Interactive Usage
190-
You cannot load Az and AzureRM modules in the same PowerShell session, but they can be used in seperate sessions as follows
190+
You cannot load Az and AzureRM modules in the same PowerShell session, but they can be used in separate sessions as follows
191191
- In AzureRM session: ```Import-Module AzureRM```
192192
- In Az session: Begin the session with ```Enable-AzureRmAlias```, which will prevent inadvertently loading AzureRM modules. Alternately, you can use cmdlets with Az noun prefix, and avoid using cmdlets with Azure or AzureRm noun
193193

documentation/breaking-changes/breaking-changes-attribute-help.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Breaking Changes Attribute Help
22

3-
Below is description of the various types of Breaking Change Attributes (custom attributes) that can be used to decorate the cmdlet or its paramters to call out various [types of breaking changes](https://github.com/praries880/azure-powershell/blob/breakingchangeattribute/documentation/breaking-changes/breaking-changes-definition.md).
3+
Below is description of the various types of Breaking Change Attributes (custom attributes) that can be used to decorate the cmdlet or its parameters to call out various [types of breaking changes](https://github.com/praries880/azure-powershell/blob/breakingchangeattribute/documentation/breaking-changes/breaking-changes-definition.md).
44

55
## The different types of attributes
66

@@ -11,7 +11,7 @@ Below is description of the various types of Breaking Change Attributes (custom
1111

1212
## Common aspects and properties
1313
### GenericBreakingChangeAttribute
14-
The base attibute which provides the core functionality is called "GenericBreakingChange" All the remaining attrbutes derive from it and provide functionality that makes sense for the scenarios they handle.
14+
The base attribute which provides the core functionality is called "GenericBreakingChange" All the remaining attributes derive from it and provide functionality that makes sense for the scenarios they handle.
1515

1616
The generic attribute is the most free form of them all and can be used to call out breaking changes that do not fall into the more specialized categories.
1717

@@ -23,20 +23,20 @@ All of the attributes have the following common traits:
2323

2424
### Common Properties
2525
#### Constructor arguments
26-
- Each attribute has two additional constructors thet take the following params in addition to the ones the attribute mentions:
26+
- Each attribute has two additional constructors that take the following params in addition to the ones the attribute mentions:
2727
- The "deprecatedByVersion" is the version number the breaking change is going to be done in.
28-
- The "changeInEfectByDate" is the date the breaking change is goind to go in effet on. The string formati is "mm/dd/yyyy", as an example : "02/25/2018"
28+
- The "changeInEffectByDate" is the date the breaking change is going to go in effect on. The string format is "mm/dd/yyyy", as an example : "02/25/2018"
2929
#### Properties by name
3030
- Each attribute accepts the following properties by name (all of them are optional) :
3131
- "ChangeDescription" : This is a free form text field that can be used to describe the breaking change.
32-
- Usage changes (you cant have one or the other, you need to speciffy both for the usage message to be generated) :
32+
- Usage changes (you cant have one or the other, you need to specify both for the usage message to be generated) :
3333
- "OldWay" : The way to call the cmdlet before the breaking change takes effect
3434
- "NewWay" : If there is a workaround to the breaking change, or if the same functionality can be achieved in another manner
3535

36-
The properties "deprecatedByVersion" and "changeInEfectByDate" are infotmation only (for the end user) as of now.
36+
The properties "deprecatedByVersion" and "changeInEffectByDate" are information only (for the end user) as of now.
3737

38-
#### Supress the breaking change messages at runtime
39-
- If the user desires to not see the warning messages generated by the attirbutes at runtime, they can set the env variable "SuppressAzurePowerShellBreakingChangeWarnings" to "true".
38+
#### Suppress the breaking change messages at runtime
39+
- If the user desires to not see the warning messages generated by the attributes at runtime, they can set the env variable "SuppressAzurePowerShellBreakingChangeWarnings" to "true".
4040

4141
NOTE :
4242
- The only time you will see the output (at runtime) of an attribute applied to a parameter (property or field) is if the parameter is actually invoked on the cmdline. The breaking change attributes to all parameters that are not invoked are ignored.
@@ -79,7 +79,7 @@ Breaking changes in the cmdlet : Get-SomeObjectA
7979
The change is expected to take effect from the version : 5.0.0.0
8080
```
8181

82-
#### With "deprecatedByVersion" and "changeInEfectByDate"
82+
#### With "deprecatedByVersion" and "changeInEffectByDate"
8383
```cs
8484
[GenericBreakingChange("Message2", "5.0.0.0", "02/13/2018")]
8585
[Cmdlet(VerbsCommon.Get, "SomeObjectB"), OutputType(typeof(Foo))]
@@ -202,10 +202,10 @@ The cmdlet is being deprecated. There will be no replacement for it.
202202
```
203203

204204
## CmdletOutputBreakingChangeAttribute
205-
This attribute is used to call out the breakigng changes with the output of a cmdlet. A few examples are :
205+
This attribute is used to call out the breaking changes with the output of a cmdlet. A few examples are :
206206
- The type of the output is changing
207207
- The Output type is being deprecated
208-
- Some internal properties in the putput type are being deprecated
208+
- Some internal properties in the output type are being deprecated
209209
- New properties are being introduced to the output type
210210

211211
Note :
@@ -279,7 +279,7 @@ Breaking changes in the cmdlet : Get-SomeObjectB
279279
'Prop1' 'Prop2'
280280
```
281281

282-
#### A few new properties are bing added to the output type
282+
#### A few new properties are being added to the output type
283283
```cs
284284
[CmdletOutputBreakingChange(typeof(Foo), NewOutputProperties = new String[] {"Prop1", "Prop2"})]
285285
[Cmdlet(VerbsCommon.Get, "SomeObjectC"), OutputType(typeof(Foo))]
@@ -330,7 +330,7 @@ Breaking changes in the cmdlet : Get-SomeObjectD
330330
```
331331

332332
## CmdletParameterBreakingChangeAttribute
333-
This attribute is used to call out the breakigng changes relating to a parameter of a cmdlet. A few examples are :
333+
This attribute is used to call out the breaking changes relating to a parameter of a cmdlet. A few examples are :
334334
- A parameter is being deprecated
335335
- A parameter is being replaced
336336
- A parameter is becoming mandatory
@@ -470,7 +470,7 @@ Breaking changes in the cmdlet : Get-SomeObjectB
470470
[Cmdlet(VerbsCommon.Get, "SomeObjectA"), OutputType(typeof(Foo))]
471471
public class GetSomeObjectA : AzureRMCmdlet
472472
{
473-
[CmdletParameterBreakingChange("Param1", IsBecomingMandatory=truec)]
473+
[CmdletParameterBreakingChange("Param1", IsBecomingMandatory=true)]
474474
[Parameter(Mandatory = false)]
475475
public String Param1;
476476
protected override void BeginProcessing()

documentation/breaking-changes/breaking-changes-definition.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Breaking changes in cmdlets are defined as follows:
66

77
# Cmdlets
88
- Removing a cmdlet
9-
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specificallly the ["cmdlet deprecation without replacement"](./breaking-changes-attribute-help.md#when-there-is-no-replacement-cmdlet) option
9+
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specifically the ["cmdlet deprecation without replacement"](./breaking-changes-attribute-help.md#when-there-is-no-replacement-cmdlet) option
1010
- Changing a cmdlet name without an alias to the original name
11-
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specificallly the ["cmdlet deprecation with replacement"](./breaking-changes-attribute-help.md#when-there-is-a-replacement-cmdlet) option
11+
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specifically the ["cmdlet deprecation with replacement"](./breaking-changes-attribute-help.md#when-there-is-a-replacement-cmdlet) option
1212
- Removing or changing a cmdlet alias
1313
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [simple message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the alias that is being deprecated
1414
- Removing a cmdlet attribute option (`SupportShouldProcess`, `SupportsPaging`)
@@ -25,11 +25,11 @@ Breaking changes in cmdlets are defined as follows:
2525
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-being-replaced) to call out a parameter name change.
2626
- Breaking change in parameter type
2727
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-changing-its-type) to call out a parameter name change.
28-
- Adding a required parameter to an existing parametrer set (adding new parameter sets or adding additional optional parameters is not a breaking change)
29-
- An existing parameter becomes mandatry :
28+
- Adding a required parameter to an existing parameter set (adding new parameter sets or adding additional optional parameters is not a breaking change)
29+
- An existing parameter becomes mandatory :
3030
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-becoming-mandatory) to call out a parameter becoming mandatory.
3131
- Adding a new mandatory parameter to a parameter set:
32-
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new mandatiry parameter that is going to be added to the parameter set.
32+
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new mandatory parameter that is going to be added to the parameter set.
3333
- Changing parameter order for parameter sets with ordered parameters
3434
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new order in the parameter set.
3535
- Removing or changing a parameter alias
@@ -47,12 +47,12 @@ Breaking changes in cmdlets are defined as follows:
4747
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
4848
- Removing properties
4949
- In the output type
50-
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-properties-in-the-output-type-are-being-deprecated) to call out derecated properties.
50+
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-properties-in-the-output-type-are-being-deprecated) to call out deprecated properties.
5151
- In a parameter
5252
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
5353
- Adding additional required properties
5454
- In the output type
55-
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-new-properties-are-bing-added-to-the-output-type) to call out derecated properties.
55+
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-new-properties-are-being-added-to-the-output-type) to call out deprecated properties.
5656
- In a parameter
5757
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
5858
- Adding required parameters, changing parameter names, or parameter types for methods or constructors

documentation/breaking-changes/breaking-changes-messages-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To suppress these warning messages, set the environment variable 'SuppressAzureP
1212
Set-Item Env:\SuppressAzurePowerShellBreakingChangeWarnings "true"
1313
```
1414

15-
More details on breaking change message suppression can be found [here](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-attribute-help.md#supress-the-breaking-change-messages-at-runtime).
15+
More details on breaking change message suppression can be found [here](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-attribute-help.md#suppress-the-breaking-change-messages-at-runtime).
1616

1717
## Further reading
1818

documentation/development-docs/azure-powershell-developer-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ msbuild build.proj /t:GenerateHelp
105105

106106
## Running Static Analysis
107107

108-
To keep consistency across our modules, we've implemented a static analysis system. This verifies various aspects (depdencies, breaking changes, etc.) for your module. Run this command to execute static analysis validation for the built modules:
108+
To keep consistency across our modules, we've implemented a static analysis system. This verifies various aspects (dependencies, breaking changes, etc.) for your module. Run this command to execute static analysis validation for the built modules:
109109

110110
```
111111
msbuild build.proj /t:StaticAnalysis
@@ -302,7 +302,7 @@ Once all of your cmdlets have been created and the appropriate tests have been a
302302

303303
## Change Log
304304

305-
Whenver you make updates to a project, please make sure to update the corresponding service's `ChangeLog.md` file with a snippet of what you changed under the `Upcoming Release` header. This information is later used for the release notes that goes out with each module the next time they are released, and provides users with more information as to what has changed in the module from the previous release. For more information on updating change logs can be found in [`CONTRIBUTING.md`](../../CONTRIBUTING.md#updating-the-change-log)
305+
Whenever you make updates to a project, please make sure to update the corresponding service's `ChangeLog.md` file with a snippet of what you changed under the `Upcoming Release` header. This information is later used for the release notes that goes out with each module the next time they are released, and provides users with more information as to what has changed in the module from the previous release. For more information on updating change logs can be found in [`CONTRIBUTING.md`](../../CONTRIBUTING.md#updating-the-change-log)
306306

307307
# Misc
308308

documentation/development-docs/design-guidelines/cmdlet-best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ From the [_Strongly Encouraged Development Guidelines_](https://docs.microsoft.c
3030

3131
If your cmdlet is performing a **PATCH** operation (_i.e._, a partial replacement on the server), then the cmdlet should use the verb `Update`.
3232

33-
If your cmdlet is performing a **PUT** operation (_i.e._, a full replacement on the server), the the cmdlet should use the verb `Set`.
33+
If your cmdlet is performing a **PUT** operation (_i.e._, a full replacement on the server), the cmdlet should use the verb `Set`.
3434

3535
#### Cmdlet Alias
3636

@@ -136,7 +136,7 @@ To ensure that `-AsJob` is not broken in future changes, please add a test for t
136136
````powershell
137137
$job = Get-AzSubscription -AsJob
138138
$job | Wait-Job
139-
$subcriptions = $job | Receive-Job
139+
$subscriptions = $job | Receive-Job
140140
````
141141

142142
To set a custom job name, please use [`SetBackgroupJobDescription`](https://github.com/Azure/azure-powershell-common/blob/master/src/Common/AzurePSCmdlet.cs#L810). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'"

documentation/development-docs/design-guidelines/parameter-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ For PowerShell to determine which parameter set a user is intending to use with
142142
143143
#### Positional Parameters Limit
144144

145-
It is possibile to call a PowerShell cmdlet without providing the parameter names, but just the values you would like to pass through. This is done by specifying the position at which the value of each parameter should be provided by using the `Position` property for a parameter. However, when there are too many positional parameters in a single parameter set, it can be difficult for the user to remember the exact ordering in which the parameter values should be provided. From the remarks section of [_Parameter Attribute Declaration_](https://docs.microsoft.com/en-us/powershell/developer/cmdlet/parameter-attribute-declaration#remarks):
145+
It is possible to call a PowerShell cmdlet without providing the parameter names, but just the values you would like to pass through. This is done by specifying the position at which the value of each parameter should be provided by using the `Position` property for a parameter. However, when there are too many positional parameters in a single parameter set, it can be difficult for the user to remember the exact ordering in which the parameter values should be provided. From the remarks section of [_Parameter Attribute Declaration_](https://docs.microsoft.com/en-us/powershell/developer/cmdlet/parameter-attribute-declaration#remarks):
146146

147147
> _When you specify positional parameters, limit the number of positional parameters in a parameter set to less than five. And, positional parameters do not have to be contiguous. Positions 5, 100, and 250 work the same as positions 0, 1, and 2._
148148

0 commit comments

Comments
 (0)