Skip to content

Commit

Permalink
Merge pull request #1 from Azure/master
Browse files Browse the repository at this point in the history
Syncing from original
  • Loading branch information
SanjaMalesevic authored Sep 19, 2019
2 parents 7f036ca + 378abab commit 8de5d3f
Show file tree
Hide file tree
Showing 1,390 changed files with 1,375,363 additions and 402,043 deletions.
12 changes: 7 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@

## Checklist

- [ ] 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)
- [ ] I have read the [_Submitting Changes_](../CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../CONTRIBUTING.md)
- [ ] The title of the PR is clear and informative
- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#updating-the-change-log)
- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/master/documentation/breaking-changes/breaking-changes-definition.md)
- [ ] The appropriate `ChangeLog.md` file(s) has been updated:
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
- 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
- [ ] The PR does not introduce [breaking changes](../documentation/breaking-changes/breaking-changes-definition.md)
- [ ] If applicable, the changes made in the PR have proper test coverage
- [ ] For public API changes to cmdlets:
- [ ] the changes have gone through a [cmdlet design review](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (Microsoft internal partners only)
- [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md)
- [ ] a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (_Microsoft internal only_)
- [ ] 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)
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,14 @@ The following is a list of guidelines that pull requests opened in the Azure Pow
The following guidelines must be followed in **EVERY** pull request that is opened.

- Title of the pull request is clear and informative
- The appropriate `ChangeLog.md` file has been updated with a snippet describing the changes being made
- The appropriate `ChangeLog.md` file(s) has been updated:
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
- 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
- There are a [small number of commits](documentation/development-docs/cleaning-up-commits.md) that each have an informative message
- All files shipped with a module should contain a proper Microsoft license header
- For public API changes to cmdlets:
- a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr)
- 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)
- a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (_Microsoft internal only_)
- 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)

#### Testing guidelines

Expand Down
112 changes: 110 additions & 2 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,120 @@
## 2.6.0 - August 2019
#### General
* Fixed miscellaneous typos across numerous modules

#### Az.Accounts
* Added support for user-assigned MSI in Azure Functions authentication (#9479)

#### Az.Aks
* Fixed issue with output for 'Get-AzAks' ([#9847](https://github.com/Azure/azure-powershell/issues/9847))

#### Az.ApiManagement
* Fixed issue with whitespace in `productId`, `apiId`, `groupId`, `userId` ([#9351](https://github.com/Azure/azure-powershell/issues/9351))
* **Get-AzApiManagementProduct** - Added support for querying products using API ([#9482](https://github.com/Azure/azure-powershell/issues/9482))
* **New-AzApiManagementApiRevision** - Fixed issue where ApiRevisionDescription was not set when creating new API revision ([#9752](https://github.com/Azure/azure-powershell/issues/9752))
* Fixed typo in model `PsApiManagementOAuth2AuthrozationServer` to `PsApiManagementOAuth2AuthorizationServer`

#### Az.Batch
* Fixed typos in help message and documentation

#### Az.Cdn
* Fixed a typo in CDN module conversion helper

#### Az.Compute
* Added VmssId to **New-AzVMConfig** cmdlet
* Added `TerminateScheduledEvents` and `TerminateScheduledEventNotBeforeTimeoutInMinutes` parameters to **New-AzVmssConfig** and **Update-AzVmss**
* Added `HyperVGeneration` property to VM image object
* Added Host and HostGroup features
- New cmdlets:
- **New-AzHostGroup**
- **New-AzHost**
- **Get-AzHostGroup**
- **Get-AzHost**
- **Remove-AzHostGroup**
- **Remove-AzHost**
- Added `HostId` parameter to **New-AzVMConfig** and **New-AzVM**
* Updated example in **Invoke-AzVMRunCommand** documentation to use correct parameter name
* Updated `-VolumeType` description in **Set-AzVMDiskEncryptionExtension** and **Set-AzVmssDiskEncryptionExtension** reference documentation

#### Az.DataFactory
* Fixed typos in **New-AzDataFactoryEncryptValue** documentation
* Updated ADF .Net SDK version to 4.1.2
* Added parameters to **Set-AzureRmDataFactoryV2IntegrationRuntime** to enable Self-Hosted Integration Runtime as a proxy for SSIS Integration Runtime:
- `DataProxyIntegrationRuntimeName`
- `DataProxyStagingLinkedServiceName`
- `DataProxyStagingPath`
* Updated **PSTriggerRun** to show the triggered pipelines, message and properties, and **PSActivityRun** to show the activity type

#### Az.DataLakeStore
* Fixed issue where **Get-DataLakeStoreDeletedItem** would hang on errors and remote exceptions

#### Az.EventHub
* Fixed typo `VirtualNteworkRule` in Set-AzEventHubNetworkRuleSet ([#9658](https://github.com/azure/azure-powershell/issues/9658))
* Fixed issue where Set-AzEventHubNamespace used PATCH instead of PUT ([#9558](https://github.com/azure/azure-powershell/issues/9558))
* Added `EnableKafka` parameter to **Set-AzEventHubNamespace** cmdlet
* Fixed issue with creating rules with `Listen` rights ([#9786](https://github.com/azure/azure-powershell/issues/9786))

#### Az.MarketplaceOrdering
* Fixed documentation typos

#### Az.Monitor
* Fixed incorrect parameter name in help documentation

#### Az.Network
* Updated **New-AzPrivateLinkServiceIpConfig**:
- Deprecated the parameter `PublicIpAddress` since this is never used in the server side.
- Added optional parameter `Primary` that indicates if the current IP configuration is the primary one
* Improved handling of request error exception from SDK
* Fixed validation logic for Ipv6 IP Prefix to check for correct IPv6 prefix length
* Added parameter set to get by subnet resource id to **Get-AzVirtualNetworkSubnetConfig**
* Updated description of **Location** parameter for **AzNetworkServiceTag**

#### Az.OperationalInsights
* Updated documentation for **New-AzOperationalInsightsLinuxSyslogDataSource**:
- Added example
- Updated description for `-Name` parameter
* Added an example for **New-AzOperationalInsightsWindowsEventDataSource**
* Changed the description of the `-Name` parameter for **New-AzOperationalInsightsWindowsEventDataSource**

#### Az.RecoveryServices
* Updated documentation for **Get-AzRecoveryServicesBackupJobDetail**

#### Az.Resources
* Added support for new API version 2019-05-10 for Microsoft.Resource
- Add support for 'copy.count = 0' for variables, resources and properties
- Resources with 'condition = false' or 'copy.count = 0' will be deleted in complete mode
* Added an example of assigning policy at the subscription level

#### Az.ServiceBus
* Fixed typo `VirtualNetworkRule` parameter in **Set-AzServiceBusNetworkRuleSet** Fix for issue #9658 : Typo
* Fixed issue with creating `Listen`-only rules ([#9786](https://github.com/azure/azure-powershell/issues/9786))
* Added new command **Test-AzServiceBusNameAvailability** to check the name availability for queue and topic

#### Az.ServiceFabric
* 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))
* 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))
* Deprecated **Add-AzServiceFabricApplicationCertificate** cmdlet

#### Az.Sql
* Updated documentation for old Auditing cmdlets

#### Az.Storage
* Updated help for **Close-AzStorageFileHandle** and **Get-AzStorageFileHandle**, added more scenarios to cmdlet examples and updated parameter descriptions
* Added support for `StandardBlobTier` in blob uploads and copies
* Added support for `Rehydrate` priority in blob copy

#### Az.Websites
* Added clarification around `-AppSettings` parameter for **Set-AzWebApp** and **Set-AzWebAppSlot**

## 2.5.0 - July 2019
#### Az.Accounts
* Update common code to use latest version of ClientRuntime

#### Az.ApplicationInsights
* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation
* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation

#### Az.Automation
* Fix typo in resource string
* Fix typo in resource string

#### Az.CognitiveServices
* Added NetworkRuleSet support.
Expand Down
14 changes: 12 additions & 2 deletions documentation/development-docs/help-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ To do so, you can follow the below steps (which are outlined in the [**Quick sta

```powershell
Install-Module -Name platyPS -Scope CurrentUser
Import-Module platyPS
```

**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:
Expand All @@ -38,6 +37,17 @@ Import-Module -Name $PathToModuleManifest

**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.

### Generating help for a new module

For new modules with no existing `help` folder containing the markdown help files, run the following command to do an initial generation:

```powershell
$PathToHelpFolder = "../../help" # Full path to help folder containing markdown files to be generated (e.g., src/Accounts/Accounts/help)
New-MarkdownHelp -Module {{moduleName}} -OutputFolder $PathToHelpFolder -AlphabeticParamsOrder -UseFullTypeName -WithModulePage
```

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.

### Updating help after making cmdlet changes

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:
Expand Down Expand Up @@ -70,7 +80,7 @@ If you would like to update the inputs/outputs for a markdown file, please run t
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.

_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_

#### Updating a single markdown file

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:
Expand Down
Loading

0 comments on commit 8de5d3f

Please sign in to comment.