fixlinks

lilinvictorms · Nov 29, 2018 · 51cefc8 · 51cefc8
1 parent f0f8269
commit 51cefc8
Show file tree

Hide file tree

Showing 18 changed files with 170 additions and 218 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,9 +1,9 @@
 <!--
 
 If this issue is a bug report:
-- Upgrade to the latest version of AzureRM and verify you are able to reproduce the issue
-    - You can install the latest version of AzureRM from the PowerShell Gallery
-        - https://www.powershellgallery.com/packages/AzureRM
+- Upgrade to the latest version of Az and verify you are able to reproduce the issue
+    - You can install the latest version of Az from the PowerShell Gallery
+        - https://www.powershellgallery.com/packages/Az
     - You can also install the latest version from the Releases section
         - https://github.com/Azure/azure-powershell/releases
 - Ensure that you repro the issue with $DebugPreference = "Continue" to receive the debug stream

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,11 +6,11 @@
 
 ## Checklist
 
-- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md)
+- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/dev/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/preview/CONTRIBUTING.md#updating-the-change-log)
-- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-definition.md)
+- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#updating-the-change-log)
+- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/dev/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/preview/documentation/development-docs/help-generation.md)
+    - [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -74,7 +74,7 @@ You can find all of the pull requests that have been opened in the [Pull Request
 To open your own pull request, click [here](https://github.com/Azure/azure-powershell/compare). When creating a pull request, keep the following in mind:
 - Make sure you are pointing to the fork and branch that your changes were made in
 - Choose the correct branch you want your pull request to be merged into
-    - The **preview** branch is for active development; changes in this branch will be in the next Azure PowerShell release
+    - The **dev** branch is for active development; changes in this branch will be in the next Azure PowerShell release
     - The **master** branch contains a snapshot of the source code at the time of the last release
     - The **release-X.X.X** branch is for active development during a release
 - The pull request template that is provided **should be filled out**; this is not something that should just be deleted or ignored when the pull request is created
@@ -113,8 +113,6 @@ For ARM service projects, the change log is located at `src\ResourceManager\{{se
 
 For RDFE service projects, the change log is located at `src\ServiceManagement\ChangeLog.md`.
 
-For the Storage data plane project, this change log is located at `src\Storage\ChangeLog.md`.
-
 #### Breaking Changes
 
 Breaking changes should **not** be introduced into the repository without giving customers at least six months notice. For a description of breaking changes in Azure PowerShell and how to declare them in the code using the [various breaking change attributes](documentation/breaking-changes/breaking-changes-attribute-help.md), see [here](documentation/breaking-changes/breaking-changes-definition.md).
@@ -130,7 +128,7 @@ The following guidelines must be followed in **EVERY** pull request that is open
 - A description of the changes the pull request makes is included, and a reference to the bug/issue the pull request fixes is included, if applicable
 - All files have the Microsoft copyright header
 - Cmdlets refer to the management libraries through NuGet references - no dlls are checked in
-- The pull request does not introduce [breaking changes](https://github.com/markcowl/azure-powershell/blob/doc1/documentation/changes.md#breaking-change-definition) (unless a major version change occurs in the assembly and module)
+- The pull request does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module)
 
 #### Testing guidelines
 
@@ -153,8 +151,8 @@ The following guidelines must be followed in pull requests that add, edit, or re
     - When a verb you would like to use is not in the list of approved verbs, or to get ideas on how to use verbs, consult the [Approved Verbs for Windows PowerShell Commands](https://msdn.microsoft.com/en-us/library/ms714428\(v=vs.85\).aspx) documentation where you will find descriptions of approved verbs as well as related verbs in the comments so that you can find one appropriate for your command
 - Cmdlet noun name uses the AzureRm prefix for management cmdlets, and the Azure prefix for data plane cmdlets
 - Cmdlet specifies the `OutputType` attribute; if the cmdlet produces no output, it should have an `OutputType` of `bool` and implement a `PassThrough` parameter
-- If the cmdlet makes changes or has side effects, it should implement `ShouldProcess` and have `SupportsShouldProcess = true` specified in the cmdlet attribute. See a discussion about correct `ShouldProcess` implementation [here](https://gist.github.com/markcowl/338e16fe5c8bbf195aff9f8af0db585d#what-is-the-change).
-- Cmdlets should derive from [`AzureRmCmdlet`](src/ResourceManager/Common/Commands.ResourceManager.Common/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](src/Common/Commands.Common/AzureDataCmdlet.cs) for data cmdlets
+- If the cmdlet makes changes or has side effects, it should implement `ShouldProcess` and have `SupportsShouldProcess = true` specified in the cmdlet attribute. See a discussion about correct `ShouldProcess` implementation [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/should-process-confirm-impact.md).
+- Cmdlets should derive from [`AzureRmCmdlet`](https://github.com/Azure/azure-powershell-common/blob/dev/src/ResourceManager/Version2016_09_01/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](https://github.com/Azure/azure-powershell-common/blob/dev/src/Common/AzureDataCmdlet.cs) for data cmdlets
 - If multiple parameter sets are implemented, the cmdlet should specify a `DefaultParameterSetName` in its cmdlet attribute
 
 #### Cmdlet parameter guidelines
@@ -182,3 +180,4 @@ The following guidelines must be followed in pull requests that make changes to
 - No parameter is of type `object`
 - Each management cmdlet should have a parameter set that takes `ResourceGroupName` and `Name` from the pipeline by property value
 - For a given resource type, it should be possible to pipe the output of `Get` and `New` cmdlets to the input of `Set`, `Update`, `Remove` and other action cmdlets for that resource
+- More information can be found [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/piping-in-powershell.md)
diff --git a/README.md b/README.md
@@ -15,23 +15,16 @@ Below is a table containing the various Azure PowerShell rollup modules found in
 
 | Description                                                     | Module Name       | PowerShell Gallery Link |
 | --------------------------------------------------------------- | ----------------- | ----------------------- |
-| Rollup Module for ARM Cmdlets                                   | `AzureRM`         | [![AzureRM](https://img.shields.io/powershellgallery/v/AzureRM.svg?style=flat-square&label=AzureRM)](https://www.powershellgallery.com/packages/AzureRM/) |
-| Rollup Module for .NET Standard cmdlets                         | `Az` | [![Az](https://img.shields.io/powershellgallery/v/Az.svg?style=flat-square&label=Az)](https://www.powershellgallery.com/packages/Az/) |
+| Rollup Module for Az cmdlets                                    | `Az` | [![Az](https://img.shields.io/powershellgallery/v/Az.svg?style=flat-square&label=Az)](https://www.powershellgallery.com/packages/Az/) |
 | Rollup Module for Administrative Modules in Azure Stack         | `AzureStack`      | [![AzureStack](https://img.shields.io/powershellgallery/v/AzureStack.svg?style=flat-square&label=AzureStack)](https://www.powershellgallery.com/packages/AzureStack/) |
-| Rollup Module for Service Management Cmdlets                  | `Azure`           | [![Azure](https://img.shields.io/powershellgallery/v/Azure.svg?style=flat-square&label=Azure)](https://www.powershellgallery.com/packages/Azure/) |
+| Rollup Module for Service Management Cmdlets                    | `Azure`           | [![Azure](https://img.shields.io/powershellgallery/v/Azure.svg?style=flat-square&label=Azure)](https://www.powershellgallery.com/packages/Azure/) |
 
 ## Installation
 
 For more detailed instructions on installing Azure PowerShell, please refer to the [installation guide](https://docs.microsoft.com/en-us/powershell/azure/install-azurerm-ps).
 
 ### PowerShell Gallery
 
-Run the following command in an elevated PowerShell session to install the rollup module for Azure Resource Manager cmdlets:
-
-```powershell
-Install-Module -Name AzureRM
-```
-
 Run the following command in an elevated PowerShell session to install the new 'Az' module for ResourceManager cmdlets. This module runs on PowerShell 5.1 (with .Net Framework 4.7.2) ,  or PowerShell Core, and replaces AzureRM.  You should not install this module side-by-side with AzureRM:
 
 ```powershell
@@ -47,9 +40,6 @@ Install-Module -Name Azure
 If you have an earlier version of the Azure PowerShell modules installed from the PowerShell Gallery and would like to update to the latest version, run the following commands in an elevated PowerShell session. Update-Module installs the new version side-by-side with the old version. It does not remove the old version.
 
 ```powershell
-# Update to the latest version of AzureRM
-Update-Module -Name AzureRM
-
 # Update to the latest version of Az
 Update-Module -Name Az
 
@@ -67,7 +57,7 @@ For more detailed instructions on using Azure PowerShell, please refer to the [g
 
 ### Log in to Azure
 
-To connect to Azure, use the [`Connect-AzAccount`](https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/connect-Azaccount) cmdlet.
+To connect to Azure, use the [`Connect-AzAccount`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzAccount.md) cmdlet.
 
 ```powershell
 # Interactive login - you will get a dialog box asking for your Azure credentials
@@ -86,7 +76,7 @@ Connect-AzAccount -Environment AzureChinaCloud
 
 ### Getting and setting your session context
 
-To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`](https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-Azcontext) cmdlet:
+To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Get-AzContext.md) cmdlet:
 
 ```powershell
 # Get the context you are currently using
@@ -96,7 +86,7 @@ Get-AzContext
 Get-AzContext -ListAvailable
 ```
 
-To get the subscriptions in a tenant, use the [`Get-AzSubscription`](https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermsubscription) cmdlet:
+To get the subscriptions in a tenant, use the [`Get-AzSubscription`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Get-AzSubscription.md) cmdlet:
 
 ```powershell
 # Get all of the subscriptions in your current tenant
@@ -106,7 +96,7 @@ Get-AzSubscription
 Get-AzSubscription -TenantId $TenantId
 ```
 
-To change the subscription that you are using for your current context, use the [`Set-AzContext`]() cmdlet:
+To change the subscription that you are using for your current context, use the [`Set-AzContext`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Set-AzContext.md) cmdlet:
 
 ```powershell
 # Set the context to a specific subscription
@@ -122,13 +112,13 @@ Use the `Get-Command` cmdlet to discover cmdlets within a specific module, or cm
 
 ```powershell
 # View all cmdlets in the AzureRM.Profile module
-Get-Command -Module AzureRM.Profile
+Get-Command -Module Az.Profile
 
 # View all cmdlets that contain "VirtualNetwork"
 Get-Command -Name "*VirtualNetwork*"
 
 # View all cmdlets that contain "VM" in the AzureRM.Compute module
-Get-Command -Module AzureRM.Compute -Name "*VM*"
+Get-Command -Module Az.Compute -Name "*VM*"
 ```
 
 ### Cmdlet help and examples
@@ -165,7 +155,7 @@ If there is a feature you would like to see in Azure PowerShell, please use the
 
 If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](https://azure.github.io/guidelines/).
 
-More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/blob/preview/documentation/development-docs/azure-powershell-developer-guide.md) folder.
+More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md) folder.
 
 ## Learn More
 

diff --git a/build.proj b/build.proj
@@ -572,7 +572,7 @@
   </Target>
 
   <Target Name="StaticAnalysisErrorMessage">
-    <Error Text="StaticAnalysis has failed.  Please follow the instructions on this doc: https://github.com/Azure/azure-powershell/blob/preview/documentation/Debugging-StaticAnalysis-Errors.md"/>
+    <Error Text="StaticAnalysis has failed.  Please follow the instructions on this doc: https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md"/>
   </Target>
 
   <Target Name="ChangeLogCheck">

diff --git a/documentation/Debugging-StaticAnalysis-Errors.md b/documentation/Debugging-StaticAnalysis-Errors.md
@@ -36,19 +36,19 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for
 
 - Download the `BreakingChangeIssues.csv` file from the Jenkins build
 - Open the file using a text editor (such as VS Code) and copy each of the errors you'd like to suppress
-- Paste each of these errors into the `BreakingChangeIssues.csv` file found in their respective [module folder](../tools/StaticAnalysis/Exceptions) (_e.g._, if a breaking change is being suppressed for Compute, then you would paste the corresponding line(s) in the `tools/StaticAnalysis/Exceptions/AzureRM.Compute/BreakingChangeIssues.csv` file) using the same text editor
+- Paste each of these errors into the `BreakingChangeIssues.csv` file found in their respective [module folder](../tools/StaticAnalysis/Exceptions) (_e.g._, if a breaking change is being suppressed for Compute, then you would paste the corresponding line(s) in the `tools/StaticAnalysis/Exceptions/Az.Compute/BreakingChangeIssues.csv` file) using the same text editor
 - Push the changes to the .csv file and ensure the errors no longer show up in the `BreakingChangeIssues.csv` file output from the Jenkins build.
 
 We take breaking changes very seriously, so please be mindful about the violations that you suppress in our repo.
 
 ### Signature Issues
-Signature issues occur when your cmdlets do not follow PowerShell standards.  Please check [this page](https://github.com/Azure/azure-powershell/blob/preview/documentation/development-docs/azure-powershell-design-guidelines.md) to ensure you are following PowerShell guidelines.  Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory.  If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:
+Signature issues occur when your cmdlets do not follow PowerShell standards.  Please check [this page](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-design-guidelines.md) to ensure you are following PowerShell guidelines.  Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory.  If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:
 
 - Download the `SignatureIssues.csv` file from the Jenkins build
 - Open the file using a text editor (such as VS Code) and copy each of the errors you'd like to suppress
-- Paste each of these errors into the `SignatureIssues.csv` file found in their respective [module folder](../tools/StaticAnalysis/Exceptions) (_e.g.,_ if a signature issue is being suppressed for Sql, then you would paste the corresponding line(s) in the `tools/StaticAnalysis/Exceptions/AzureRM.Sql/SignatureIssues.csv` file) using the same text editor
+- Paste each of these errors into the `SignatureIssues.csv` file found in their respective [module folder](../tools/StaticAnalysis/Exceptions) (_e.g.,_ if a signature issue is being suppressed for Sql, then you would paste the corresponding line(s) in the `tools/StaticAnalysis/Exceptions/Az.Sql/SignatureIssues.csv` file) using the same text editor
 - Copy each of the errors you would like to suppress directly from the SignatureIssues.csv file output in the Jenkins build
 - Push the changes to the .csv file and ensure the errors no longer show up in the `SignatureIssues.csv` file output from the Jenkins build.
 
 ### Help Issues
-Most help issues that cause StaticAnalysis to fail occur when help has not been added for a particular cmdlet.  If you have not generated help for your new cmdlets, please follow the instructions [here](https://github.com/Azure/azure-powershell/blob/preview/documentation/development-docs/help-generation.md). If this is not the issue, follow the steps listed under "Remediation" for each violation listed in HelpIssues.csv.
+Most help issues that cause StaticAnalysis to fail occur when help has not been added for a particular cmdlet.  If you have not generated help for your new cmdlets, please follow the instructions [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md). If this is not the issue, follow the steps listed under "Remediation" for each violation listed in HelpIssues.csv.