Skip to content

Commit 67362d3

Browse files
author
Maddie Clayton
authored
Merge branch 'preview' into praries880-patch-1
2 parents 3014f82 + 9ae9fef commit 67362d3

File tree

3,139 files changed

+270638
-67725
lines changed

Some content is hidden

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

3,139 files changed

+270638
-67725
lines changed

ModuleMappings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,9 @@
155155
"src/ResourceManager/Scheduler/": [
156156
"AzureRM.Scheduler"
157157
],
158+
"src/ResourceManager/Search/": [
159+
"AzureRM.Search"
160+
],
158161
"src/ResourceManager/ServiceBus/": [
159162
"AzureRM.ServiceBus"
160163
],
@@ -191,6 +194,9 @@
191194
"src/Storage/Commands.Storage/": [
192195
"Azure.Storage"
193196
],
197+
"src/ResourceManager/StorageSync/": [
198+
"AzureRM.StorageSync"
199+
],
194200
"tools/": [
195201
]
196202
}

TestMappings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,9 @@
164164
"src/ResourceManager/Scheduler/": [
165165
".\\src\\ResourceManager\\Scheduler\\Commands.Scheduler.Test\\bin\\Debug\\Microsoft.Azure.Commands.Scheduler.Test.dll"
166166
],
167+
"src/ResourceManager/Search/": [
168+
".\\src\\ResourceManager\\Search\\Commands.Management.Search.Test\\bin\\Debug\\Microsoft.Azure.Commands.Management.Search.Test.dll"
169+
],
167170
"src/ResourceManager/ServiceBus/": [
168171
".\\src\\ResourceManager\\ServiceBus\\Commands.ServiceBus.Test\\bin\\Debug\\Microsoft.Azure.Commands.ServiceBus.Test.dll"
169172
],
@@ -176,6 +179,9 @@
176179
"src/ResourceManager/Storage/Commands.Management.Storage.Test/": [
177180
".\\src\\ResourceManager\\Storage\\Commands.Management.Storage.Test\\bin\\Debug\\Microsoft.Azure.Commands.Management.Storage.Test.dll"
178181
],
182+
"src/ResourceManager/StorageSync": [
183+
".\\src\\ResourceManager\\StorageSync\\Commands.StorageSync.Test\\bin\\Debug\\Microsoft.Azure.Commands.StorageSync.Test.dll"
184+
],
179185
"src/ResourceManager/StreamAnalytics/": [
180186
".\\src\\ResourceManager\\StreamAnalytics\\Commands.StreamAnalytics.Test\\bin\\Debug\\Microsoft.Azure.Commands.StreamAnalytics.Test.dll"
181187
],

build.proj

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,8 @@
260260
<Target Name="Build" DependsOnTargets="RestoreNugetPackages;BuildMsBuildTask;FilterBuild">
261261

262262
<Message Importance="high" Text="Building Cmdlets for scope $(Scope)..." />
263-
<CallTarget targets="ChangeLogCheck" ContinueOnError="false" />
263+
<!-- Investigate why the ChangeLogCheck target removes the 8080th character -->
264+
<!-- <CallTarget targets="ChangeLogCheck" ContinueOnError="false" /> -->
264265

265266
<MakeDir Directories="$(PackageDirectory)"
266267
Condition="'$(Scope)' != 'Stack'" />
@@ -666,7 +667,8 @@
666667
<MSBuild Projects="build.proj"
667668
Targets="InvokeXUnit"
668669
Properties="XUnitTests=%(XUnitTests.Identity);TestOutputDirectory=$(TestOutputDirectory)"
669-
ContinueOnError="false" />
670+
Condition="'@(XunitTests->Count())' != '0'"
671+
ContinueOnError="false" />
670672

671673
<CallTarget Targets="TestFailureCheck" />
672674
</Target>

documentation/development-docs/azure-powershell-design-guidelines.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@
4141
- [InputObject](#inputobject)
4242
- [AsJob Parameter](#asjob-parameter)
4343

44+
## Expected Patterns for Standard Cmdlets
45+
46+
For information and examples on standard cmdlet implementation (`Get-*`, `New-*`, `Remove-*` and `Set/Update-*`) for resources and child resources, please see our [Expected Patterns for Standard Cmdlets](./patterns-for-standard-cmdlets.md) document.
47+
4448
## Cmdlet Guidelines
4549

4650
### Cmdlet Naming Conventions
@@ -154,7 +158,7 @@ Parameters of type `bool` are _strongly_ discouraged in PowerShell. The `SwitchP
154158
If there is a closed set of values applicable for a given parameter, use either a `ValidateSet`, enumeration type, or an `ArgumentCompleter`. This functionality allows users to tab through the different values they can provide. From the [Strongly Encouraged Development Guidelines](https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx):
155159

156160
> _There are two ways to create a parameter whose value can be selected from a set of options._
157-
>
161+
>
158162
> - _Define an enumeration type (or use an existing type) that specifies the valid values. Then, use the enumeration type to create a parameter of that type._
159163
> - _Add the **ValidateSet** attribute to the parameter declaration._
160164
@@ -192,7 +196,7 @@ For PowerShell to determine which parameter set a user is intending to use with
192196

193197
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://msdn.microsoft.com/en-us/library/ms714348(v=vs.85).aspx):
194198

195-
> _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._
199+
> _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._
196200
197201
In addition, there should be no two parameters with the same position in the same parameter set. From the remarks section of [Parameter Attribute Declaration](https://msdn.microsoft.com/en-us/library/ms714348(v=vs.85).aspx):
198202

@@ -218,7 +222,7 @@ The interactive parameter set **will always be the default parameter set** for a
218222

219223
This parameter set should be implemented by _every_ cmdlet - the user is able to provide a `ResourceId` string or GUID from the Azure Portal, or from one of the generic resources cmdlets (more information about that below in the piping section), and act upon the given resource associated with the id. The typical `Name` and `ResourceGroupName` parameters are replaced by a single `ResourceId` parameter of type string.
220224

221-
#### InputObject Parameter Set
225+
#### InputObject Parameter Set
222226

223227
This parameter should be implemented by _most_ cmdlets - the user is able to take the object returned from the `Get`, `New`, or `Set` cmdlets (or other cmdlets that return the common resource) and provide it to the `InputObject` parameter for a cmdlet that acts upon the same resource. The typical `Name` and `ResourceGroupName` parameters are retrieved from the `InputObject` that the user is passing through.
224228

@@ -236,7 +240,7 @@ In this scenario, the user is able to pipe the result of a generic resources cmd
236240
Find-AzureRmResource -ResourceType Microsoft.Foo/foo | Remove-AzureRmFoo
237241
```
238242

239-
For more information on enabling the `ResourceId` piping scenario and more examples, please see the ["Using the `ResourceId` parameter"](./piping-in-powershell.md#using-the-resourceid-parameter) section of the _Piping in PowerShell_ document.
243+
For more information on enabling the `ResourceId` piping scenario and more examples, please see the ["Using the `ResourceId` parameter"](./piping-in-powershell.md#using-the-resourceid-parameter) section of the _Piping in PowerShell_ document.
240244

241245
### InputObject
242246

documentation/development-docs/help-generation.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ $PathToHelpFolder = "../../help" # Full path to help folder containing markdown
6565
Update-MarkdownHelpModule -Path $PathToHelpFolder -RefreshModulePage -AlphabeticParamsOrder
6666
```
6767

68+
Because the -UseFullTypeName parameter is not yet available in Update-MarkdownHelpModule (it will be enabled in the upcoming release of PlatyPS), you will need to run this command to modify the help files to use full type names:
69+
```
70+
Get-ChildItem -Path $PathToHelpFolder | Update-MarkdownHelp -AlphabeticParamsOrder -UseFullTypeName
71+
```
72+
6873
This will update all of the markdown files with public interface changes made to corresponding cmdlets, add markdown files for any new cmdlets, remove markdown files for any deleted cmdlets, and update the module page (_e.g.,_ `AzureRM.Profile.md`) with any added or removed cmdlets.
6974

7075
#### Updating a single markdown file
@@ -76,7 +81,7 @@ $PathToModuleManifest = "../../<module>.psd1" # Full path to the module manifest
7681
Import-Module -Name $PathToModuleManifest
7782
7883
$PathToMarkdownFile = "../../<cmdlet>.md" # Full path to the markdown file to be updated
79-
Update-MarkdownHelp -Path $PathToMarkdownFile -AlphabeticParamsOrder
84+
Update-MarkdownHelp -Path $PathToMarkdownFile -AlphabeticParamsOrder -UseFullTypeName
8085
```
8186

8287
#### Generating and viewing the MAML help
@@ -101,4 +106,4 @@ $help = Get-HelpPreview -Path $PathToMAML
101106
102107
# Get the help for a specific cmdlet
103108
$help | where { $_.Name -eq "<cmdlet>" }
104-
```
109+
```

0 commit comments

Comments
 (0)