Skip to content

Commit 8de5d3f

Browse files
Merge pull request #1 from Azure/master
Syncing from original
2 parents 7f036ca + 378abab commit 8de5d3f

File tree

1,390 files changed

+1375363
-402043
lines changed

Some content is hidden

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

1,390 files changed

+1375363
-402043
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@
66

77
## Checklist
88

9-
- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md)
9+
- [ ] I have read the [_Submitting Changes_](../CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../CONTRIBUTING.md)
1010
- [ ] The title of the PR is clear and informative
11-
- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#updating-the-change-log)
12-
- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/master/documentation/breaking-changes/breaking-changes-definition.md)
11+
- [ ] The appropriate `ChangeLog.md` file(s) has been updated:
12+
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
13+
- A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header -- no new version header should be added
14+
- [ ] The PR does not introduce [breaking changes](../documentation/breaking-changes/breaking-changes-definition.md)
1315
- [ ] If applicable, the changes made in the PR have proper test coverage
1416
- [ ] For public API changes to cmdlets:
15-
- [ ] the changes have gone through a [cmdlet design review](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (Microsoft internal partners only)
16-
- [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md)
17+
- [ ] a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (_Microsoft internal only_)
18+
- [ ] the markdown help files have been regenerated using the commands listed [here](../documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ The following is a list of guidelines that pull requests opened in the Azure Pow
6565
The following guidelines must be followed in **EVERY** pull request that is opened.
6666

6767
- Title of the pull request is clear and informative
68-
- The appropriate `ChangeLog.md` file has been updated with a snippet describing the changes being made
68+
- The appropriate `ChangeLog.md` file(s) has been updated:
69+
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
70+
- A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header -- no new version header should be added
6971
- There are a [small number of commits](documentation/development-docs/cleaning-up-commits.md) that each have an informative message
7072
- All files shipped with a module should contain a proper Microsoft license header
7173
- For public API changes to cmdlets:
72-
- a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr)
73-
- the markdown help files have been regenerated using the commands listed [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)
74+
- a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (_Microsoft internal only_)
75+
- the markdown help files have been regenerated using the commands listed [here](documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)
7476

7577
#### Testing guidelines
7678

ChangeLog.md

Lines changed: 110 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,120 @@
1+
## 2.6.0 - August 2019
2+
#### General
3+
* Fixed miscellaneous typos across numerous modules
4+
5+
#### Az.Accounts
6+
* Added support for user-assigned MSI in Azure Functions authentication (#9479)
7+
8+
#### Az.Aks
9+
* Fixed issue with output for 'Get-AzAks' ([#9847](https://github.com/Azure/azure-powershell/issues/9847))
10+
11+
#### Az.ApiManagement
12+
* Fixed issue with whitespace in `productId`, `apiId`, `groupId`, `userId` ([#9351](https://github.com/Azure/azure-powershell/issues/9351))
13+
* **Get-AzApiManagementProduct** - Added support for querying products using API ([#9482](https://github.com/Azure/azure-powershell/issues/9482))
14+
* **New-AzApiManagementApiRevision** - Fixed issue where ApiRevisionDescription was not set when creating new API revision ([#9752](https://github.com/Azure/azure-powershell/issues/9752))
15+
* Fixed typo in model `PsApiManagementOAuth2AuthrozationServer` to `PsApiManagementOAuth2AuthorizationServer`
16+
17+
#### Az.Batch
18+
* Fixed typos in help message and documentation
19+
20+
#### Az.Cdn
21+
* Fixed a typo in CDN module conversion helper
22+
23+
#### Az.Compute
24+
* Added VmssId to **New-AzVMConfig** cmdlet
25+
* Added `TerminateScheduledEvents` and `TerminateScheduledEventNotBeforeTimeoutInMinutes` parameters to **New-AzVmssConfig** and **Update-AzVmss**
26+
* Added `HyperVGeneration` property to VM image object
27+
* Added Host and HostGroup features
28+
- New cmdlets:
29+
- **New-AzHostGroup**
30+
- **New-AzHost**
31+
- **Get-AzHostGroup**
32+
- **Get-AzHost**
33+
- **Remove-AzHostGroup**
34+
- **Remove-AzHost**
35+
- Added `HostId` parameter to **New-AzVMConfig** and **New-AzVM**
36+
* Updated example in **Invoke-AzVMRunCommand** documentation to use correct parameter name
37+
* Updated `-VolumeType` description in **Set-AzVMDiskEncryptionExtension** and **Set-AzVmssDiskEncryptionExtension** reference documentation
38+
39+
#### Az.DataFactory
40+
* Fixed typos in **New-AzDataFactoryEncryptValue** documentation
41+
* Updated ADF .Net SDK version to 4.1.2
42+
* Added parameters to **Set-AzureRmDataFactoryV2IntegrationRuntime** to enable Self-Hosted Integration Runtime as a proxy for SSIS Integration Runtime:
43+
- `DataProxyIntegrationRuntimeName`
44+
- `DataProxyStagingLinkedServiceName`
45+
- `DataProxyStagingPath`
46+
* Updated **PSTriggerRun** to show the triggered pipelines, message and properties, and **PSActivityRun** to show the activity type
47+
48+
#### Az.DataLakeStore
49+
* Fixed issue where **Get-DataLakeStoreDeletedItem** would hang on errors and remote exceptions
50+
51+
#### Az.EventHub
52+
* Fixed typo `VirtualNteworkRule` in Set-AzEventHubNetworkRuleSet ([#9658](https://github.com/azure/azure-powershell/issues/9658))
53+
* Fixed issue where Set-AzEventHubNamespace used PATCH instead of PUT ([#9558](https://github.com/azure/azure-powershell/issues/9558))
54+
* Added `EnableKafka` parameter to **Set-AzEventHubNamespace** cmdlet
55+
* Fixed issue with creating rules with `Listen` rights ([#9786](https://github.com/azure/azure-powershell/issues/9786))
56+
57+
#### Az.MarketplaceOrdering
58+
* Fixed documentation typos
59+
60+
#### Az.Monitor
61+
* Fixed incorrect parameter name in help documentation
62+
63+
#### Az.Network
64+
* Updated **New-AzPrivateLinkServiceIpConfig**:
65+
- Deprecated the parameter `PublicIpAddress` since this is never used in the server side.
66+
- Added optional parameter `Primary` that indicates if the current IP configuration is the primary one
67+
* Improved handling of request error exception from SDK
68+
* Fixed validation logic for Ipv6 IP Prefix to check for correct IPv6 prefix length
69+
* Added parameter set to get by subnet resource id to **Get-AzVirtualNetworkSubnetConfig**
70+
* Updated description of **Location** parameter for **AzNetworkServiceTag**
71+
72+
#### Az.OperationalInsights
73+
* Updated documentation for **New-AzOperationalInsightsLinuxSyslogDataSource**:
74+
- Added example
75+
- Updated description for `-Name` parameter
76+
* Added an example for **New-AzOperationalInsightsWindowsEventDataSource**
77+
* Changed the description of the `-Name` parameter for **New-AzOperationalInsightsWindowsEventDataSource**
78+
79+
#### Az.RecoveryServices
80+
* Updated documentation for **Get-AzRecoveryServicesBackupJobDetail**
81+
82+
#### Az.Resources
83+
* Added support for new API version 2019-05-10 for Microsoft.Resource
84+
- Add support for 'copy.count = 0' for variables, resources and properties
85+
- Resources with 'condition = false' or 'copy.count = 0' will be deleted in complete mode
86+
* Added an example of assigning policy at the subscription level
87+
88+
#### Az.ServiceBus
89+
* Fixed typo `VirtualNetworkRule` parameter in **Set-AzServiceBusNetworkRuleSet** Fix for issue #9658 : Typo
90+
* Fixed issue with creating `Listen`-only rules ([#9786](https://github.com/azure/azure-powershell/issues/9786))
91+
* Added new command **Test-AzServiceBusNameAvailability** to check the name availability for queue and topic
92+
93+
#### Az.ServiceFabric
94+
* Fixed NullReferenceException when a resource group has a VMSS not related to the service fabric cluster ([#8681](https://github.com/Azure/azure-powershell/issues/8681))
95+
* Fixed bug where cmdlets failed if virtualNetwork was in a different resource group than the cluster ([#8407](https://github.com/Azure/azure-powershell/issues/8407))
96+
* Deprecated **Add-AzServiceFabricApplicationCertificate** cmdlet
97+
98+
#### Az.Sql
99+
* Updated documentation for old Auditing cmdlets
100+
101+
#### Az.Storage
102+
* Updated help for **Close-AzStorageFileHandle** and **Get-AzStorageFileHandle**, added more scenarios to cmdlet examples and updated parameter descriptions
103+
* Added support for `StandardBlobTier` in blob uploads and copies
104+
* Added support for `Rehydrate` priority in blob copy
105+
106+
#### Az.Websites
107+
* Added clarification around `-AppSettings` parameter for **Set-AzWebApp** and **Set-AzWebAppSlot**
108+
1109
## 2.5.0 - July 2019
2110
#### Az.Accounts
3111
* Update common code to use latest version of ClientRuntime
4112

5113
#### Az.ApplicationInsights
6-
* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation
114+
* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation
7115

8116
#### Az.Automation
9-
* Fix typo in resource string
117+
* Fix typo in resource string
10118

11119
#### Az.CognitiveServices
12120
* Added NetworkRuleSet support.

documentation/development-docs/help-generation.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ To do so, you can follow the below steps (which are outlined in the [**Quick sta
1212

1313
```powershell
1414
Install-Module -Name platyPS -Scope CurrentUser
15-
Import-Module platyPS
1615
```
1716

1817
**Note:** this module will need to be installed from the [PowerShell Gallery](http://www.powershellgallery.com/). If, for some reason, this isn't a registered repository when running the `Get-PSRepository` cmdlet, then you will need to register it by running the following command:
@@ -38,6 +37,17 @@ Import-Module -Name $PathToModuleManifest
3837

3938
**Note**: if you do not see all of the changes you made to the cmdlets in your markdown files (_e.g.,_ a cmdlet you deleted is still appearing), you may need to delete any existing Azure PowerShell modules that you have on your machine (installed either through the PowerShell Gallery or by Web Platform Installer) before you import your module.
4039

40+
### Generating help for a new module
41+
42+
For new modules with no existing `help` folder containing the markdown help files, run the following command to do an initial generation:
43+
44+
```powershell
45+
$PathToHelpFolder = "../../help" # Full path to help folder containing markdown files to be generated (e.g., src/Accounts/Accounts/help)
46+
New-MarkdownHelp -Module {{moduleName}} -OutputFolder $PathToHelpFolder -AlphabeticParamsOrder -UseFullTypeName -WithModulePage
47+
```
48+
49+
Once this folder has been generated, follow the steps provided in the below section to update the files with any changes made to the public interface of the cmdlets.
50+
4151
### Updating help after making cmdlet changes
4252

4353
Whenever the public interface for a cmdlet has changed, the corresponding markdown file for that cmdlet will need to be updated to reflect the changes. Public interface changes include the following:
@@ -70,7 +80,7 @@ If you would like to update the inputs/outputs for a markdown file, please run t
7080
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.,_ `Az.Accounts.md`) with any added or removed cmdlets.
7181

7282
_This seems to work better when run from within the `help` folder itself (For e.g. to generate the help files for the [`Network`](src/Network) module run the cmd from under [`Commands.Network/help`](src/Network/Network/help)). Also, you will have to import the profile module from under <Repo base path>/artifacts/Debug/Az.Accounts/Az.Accounts.psd1_
73-
83+
7484
#### Updating a single markdown file
7585

7686
To update a single markdown file with the changes made to the corresponding cmdlet, use the [`Update-MarkdownHelp`](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelp.md) cmdlet:

0 commit comments

Comments
 (0)