diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0ecf70e6118a..49ff700b3f0e 100644 --- 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/dev/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md) +- [ ] 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) - [ ] The title of the PR is clear and informative -- [ ] 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) +- [ ] 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) - [ ] 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/dev/documentation/development-docs/help-generation.md) + - [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c408dfaaf0a6..fc4f01e58b65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,8 +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 **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 **master** branch is for active development; changes in this branch will be in the next Azure PowerShell 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 - Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed @@ -128,7 +127,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/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-changes-definition.md) (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/master/documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module) #### Testing guidelines @@ -151,8 +150,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://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 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/master/documentation/development-docs/should-process-confirm-impact.md). +- Cmdlets should derive from [`AzureRmCmdlet`](https://github.com/Azure/azure-powershell-common/blob/master/src/ResourceManager/Version2016_09_01/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](https://github.com/Azure/azure-powershell-common/blob/master/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 @@ -180,4 +179,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) +- More information can be found [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/piping-in-powershell.md) diff --git a/README.md b/README.md index 3183fbd97bac..01e3616ae90f 100644 --- a/README.md +++ b/README.md @@ -57,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://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzAccount.md) cmdlet. +To connect to Azure, use the [`Connect-AzAccount`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzAccount.md) cmdlet. ```powershell # Interactive login - you will get a dialog box asking for your Azure credentials @@ -76,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://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Get-AzContext.md) 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/master/src/ResourceManager/Profile/Commands.Profile/help/Get-AzContext.md) cmdlet: ```powershell # Get the context you are currently using @@ -86,7 +86,7 @@ Get-AzContext Get-AzContext -ListAvailable ``` -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: +To get the subscriptions in a tenant, use the [`Get-AzSubscription`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Get-AzSubscription.md) cmdlet: ```powershell # Get all of the subscriptions in your current tenant @@ -96,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`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Set-AzContext.md) cmdlet: +To change the subscription that you are using for your current context, use the [`Set-AzContext`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Set-AzContext.md) cmdlet: ```powershell # Set the context to a specific subscription @@ -155,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/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. +More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md) folder. ## Learn More diff --git a/build.proj b/build.proj index 87a427fb7c38..28eb5dc21d72 100644 --- a/build.proj +++ b/build.proj @@ -572,7 +572,7 @@ - + diff --git a/documentation/Debugging-StaticAnalysis-Errors.md b/documentation/Debugging-StaticAnalysis-Errors.md index 735a3c7b4b9c..c59d1b778d31 100644 --- a/documentation/Debugging-StaticAnalysis-Errors.md +++ b/documentation/Debugging-StaticAnalysis-Errors.md @@ -42,7 +42,7 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for 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/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: +Signature issues occur when your cmdlets do not follow PowerShell standards. Please check [this page](https://github.com/Azure/azure-powershell/blob/master/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 @@ -51,4 +51,4 @@ Signature issues occur when your cmdlets do not follow PowerShell standards. Pl - 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/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. +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/master/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. diff --git a/documentation/development-docs/azure-powershell-design-guidelines.md b/documentation/development-docs/azure-powershell-design-guidelines.md index d4b561ce2802..1cdf7f8c546f 100644 --- a/documentation/development-docs/azure-powershell-design-guidelines.md +++ b/documentation/development-docs/azure-powershell-design-guidelines.md @@ -274,7 +274,7 @@ $job | Wait-Job $subcriptions = $job | Receive-Job ```` -To set a custom job name, please use [SetBackgroupJobDescription(string name)](https://github.com/Azure/azure-powershell-common/blob/dev/src/Common/AzurePSCmdlet.cs#L810). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'" +To set a custom job name, please use [SetBackgroupJobDescription(string name)](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}'" ## Argument Completers diff --git a/documentation/development-docs/azure-powershell-developer-guide.md b/documentation/development-docs/azure-powershell-developer-guide.md index cecffb34267a..27956edb2350 100644 --- a/documentation/development-docs/azure-powershell-developer-guide.md +++ b/documentation/development-docs/azure-powershell-developer-guide.md @@ -52,7 +52,7 @@ The following prerequisites should be completed before contributing to the Azure - Install [Visual Studio 2017](https://www.visualstudio.com/downloads/) - Install the latest version of [Git](https://git-scm.com/downloads) -- Install the [`platyPS` module](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md#installing-platyps) +- Install the [`platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md#installing-platyps) - Set the PowerShell [execution policy](https://technet.microsoft.com/en-us/library/ee176961.aspx) to **Unrestricted** for the following versions of PowerShell: - `C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe` - `C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe` @@ -85,10 +85,10 @@ You now be able to create your own branches, commit changes, and push commits to git remote add upstream https://github.com/Azure/azure-powershell.git ``` -Then, to pull changes from the **dev** branch in _Azure/azure-powershell_ into your local working branch, run the following command: +Then, to pull changes from the **master** branch in _Azure/azure-powershell_ into your local working branch, run the following command: ``` -git pull upstream dev +git pull upstream master ``` ## Building the Environment @@ -369,7 +369,7 @@ Create these environment variables for the AD scenario tests: # After Development -Once all of your cmdlets have been created and the appropriate tests have been added, you can open a pull request in the Azure PowerShell repository to have your cmdlets added to the next release. Please make sure to read [CONTRIBUTING.md](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md) for more information on how to open a pull request, clean up commits, make sure appropriate files have been added/changed, and more. +Once all of your cmdlets have been created and the appropriate tests have been added, you can open a pull request in the Azure PowerShell repository to have your cmdlets added to the next release. Please make sure to read [CONTRIBUTING.md](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md) for more information on how to open a pull request, clean up commits, make sure appropriate files have been added/changed, and more. # Misc diff --git a/documentation/development-docs/generate-format.ps1xml-file.md b/documentation/development-docs/generate-format.ps1xml-file.md index 56b1dfaa57f4..0657e1a1e79a 100644 --- a/documentation/development-docs/generate-format.ps1xml-file.md +++ b/documentation/development-docs/generate-format.ps1xml-file.md @@ -14,7 +14,7 @@ Our team trends to make the cmdlets output more convenient and consistent across # How table view output works by default. - As an example let's consider [Get-AzSubscription](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/Subscription/GetAzureRMSubscription.cs) cmdlet. + As an example let's consider [Get-AzSubscription](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/Subscription/GetAzureRMSubscription.cs) cmdlet. The cmdlet class specifies the ```PSAzureSubscription``` class as an output type with the **OutputType attribute**: @@ -31,7 +31,7 @@ namespace Microsoft.Azure.Commands.Profile // omitted for brevity the rest of the definition. ``` -The [PSAzureSubscription](https://github.com/Azure/azure-powershell-common/blob/dev/src/Authentication.ResourceManager/Models/PSAzureSubscription.cs) class contains several public properties. +The [PSAzureSubscription](https://github.com/Azure/azure-powershell-common/blob/master/src/Authentication.ResourceManager/Models/PSAzureSubscription.cs) class contains several public properties. * Id * Name @@ -115,14 +115,14 @@ To provide a better PowerShell Azure cmdlets output experience we worked out a m 2. Run the New-FormatPs1Xml cmdlet to generate the format.ps1xml file. --- - We presume that for the [output type](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-design-guidelines.md#output-type) you created a new class that, for example, wraps a returning .NET SDK type, rather than PSObject. + We presume that for the [output type](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-design-guidelines.md#output-type) you created a new class that, for example, wraps a returning .NET SDK type, rather than PSObject. --- # Ps1XmlAttribute attribute. -The key element of the mechanism is the **Ps1XmlAttribute** attribute located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/blob/dev/src/Common/Attributes/Ps1XmlAttribute.cs) project. Below is the attribute definition: +The key element of the mechanism is the **Ps1XmlAttribute** attribute located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/blob/master/src/Common/Attributes/Ps1XmlAttribute.cs) project. Below is the attribute definition: ```Cs namespace Microsoft.WindowsAzure.Commands.Common.Attributes @@ -223,7 +223,7 @@ namespace Microsoft.Azure.Commands.Profile.Models ``` * If **Label** is not specified - the property name will be used. -* Since the **Ps1Xml attribute** definition is located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/tree/dev/src/Common) project and the Command.Common project is likely referenced from your project - to make the attribute visible - you only need to add ```using Microsoft.WindowsAzure.Commands.Common.Attributes;``` statement. +* Since the **Ps1Xml attribute** definition is located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/tree/master/src/Common) project and the Command.Common project is likely referenced from your project - to make the attribute visible - you only need to add ```using Microsoft.WindowsAzure.Commands.Common.Attributes;``` statement. ## Properties of complex types. @@ -309,7 +309,7 @@ This will place the column at the very beginning of the table. # How to generate format.ps1xml file. -1. First of all you need to [build](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md#building-the-environment) PowerShell Azure: +1. First of all you need to [build](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md#building-the-environment) PowerShell Azure: ```Powershell PS E:\git\azure-powershell> msbuild build.proj /p:SkipHelp=true @@ -409,9 +409,9 @@ c9cbd920-c00c-427c-852b-c329e824c3a8 Azure SDK Powershell Test Enabled 72f988bf- **Note:** All the paths used in the example in the section are under **_azure-powershell/src/ResourceManager/Profile_** -1. Copy the generated file into your project source folder. In our example this is [src/ResourceManager/Profile/Commands.Profile](https://github.com/Azure/azure-powershell/tree/dev/src/ResourceManager/Profile/Commands.Profile) folder. +1. Copy the generated file into your project source folder. In our example this is [src/ResourceManager/Profile/Commands.Profile](https://github.com/Azure/azure-powershell/tree/master/src/ResourceManager/Profile/Commands.Profile) folder. -2. Reference the generated format.ps1xml file form your project. In our example this is [Commands.Profile.csproj](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/Commands.Profile.csproj) file: +2. Reference the generated format.ps1xml file form your project. In our example this is [Commands.Profile.csproj](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/Commands.Profile.csproj) file: ```Xml @@ -438,7 +438,7 @@ c9cbd920-c00c-427c-852b-c329e824c3a8 Azure SDK Powershell Test Enabled 72f988bf- ``` -3. Add the generated format.ps1xml file to your source module manifest **FormatsToProcess** variable. In our example this is [src/ResourceManager/Profile/Az.Profile.psd1](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Az.Profile.psd1) file: +3. Add the generated format.ps1xml file to your source module manifest **FormatsToProcess** variable. In our example this is [src/ResourceManager/Profile/Az.Profile.psd1](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Az.Profile.psd1) file: ```Powershell # script omitted for brevity diff --git a/documentation/development-docs/help-generation.md b/documentation/development-docs/help-generation.md index 250b20f46852..011886e6abb0 100644 --- a/documentation/development-docs/help-generation.md +++ b/documentation/development-docs/help-generation.md @@ -69,7 +69,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.Profile.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`](https://github.com/Azure/azure-powershell/tree/dev/src/ResourceManager/Network) module run the cmd from under [`Commands.Network/help`](https://github.com/Azure/azure-powershell/tree/dev/src/ResourceManager/Network/Commands.Network/help)). Also, you will have to import the profile module from under /src/Package/Debug/ResourceManager/AzureResourceManager/Az.Profile/Az.Profile.psd1_ +_This seems to work better when run from within the `help` folder itself (For e.g. to generate the help files for the [`Network`](https://github.com/Azure/azure-powershell/tree/master/src/ResourceManager/Network) module run the cmd from under [`Commands.Network/help`](https://github.com/Azure/azure-powershell/tree/master/src/ResourceManager/Network/Commands.Network/help)). Also, you will have to import the profile module from under /src/Package/Debug/ResourceManager/AzureResourceManager/Az.Profile/Az.Profile.psd1_ #### Updating a single markdown file diff --git a/documentation/development-docs/piping-in-powershell.md b/documentation/development-docs/piping-in-powershell.md index 1e0134e48ff1..f87f08f5a1e9 100644 --- a/documentation/development-docs/piping-in-powershell.md +++ b/documentation/development-docs/piping-in-powershell.md @@ -107,7 +107,7 @@ Find-AzResource -ResourceType Microsoft.Foo/foo -ResourceGroupEquals "RG" | ForE Find-AzResource -ResourceGroupEquals "RG" -ResourceNameEquals "FooName" | ForEach-Object { Remove-AzFoo -ResourceId $_.ResourceId } ``` -To implement this scenario, please see the [`ResourceIdentifier`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Common/Commands.ResourceManager.Common/Utilities/Models/ResourceIdentifier.cs) class in the `Commands.ResourceManager.Common` project. This class will allow you to create a `ResourceIdentifier` object that accepts a `ResourceId` string in its constructor and has properties `ResourceName`, `ResourceGroupName`, and others. +To implement this scenario, please see the [`ResourceIdentifier`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Common/Commands.ResourceManager.Common/Utilities/Models/ResourceIdentifier.cs) class in the `Commands.ResourceManager.Common` project. This class will allow you to create a `ResourceIdentifier` object that accepts a `ResourceId` string in its constructor and has properties `ResourceName`, `ResourceGroupName`, and others. ## Summary For all Remove/Set/Update cmdlets (and any other cmdlet where an existing resource is being operated on), you will have three parameter sets (and potentially a multiple of three if you have initially have multiple parameter sets): diff --git a/documentation/development-docs/vm-for-partners.md b/documentation/development-docs/vm-for-partners.md index 0cbb20fde480..9cc1e7655067 100644 --- a/documentation/development-docs/vm-for-partners.md +++ b/documentation/development-docs/vm-for-partners.md @@ -1,4 +1,4 @@ -If you need an Azure Virtual Machine with all the [prerequisites](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md#prerequisites) installed and ready to build and test Powershell Azure - follow the steps below. +If you need an Azure Virtual Machine with all the [prerequisites](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md#prerequisites) installed and ready to build and test Powershell Azure - follow the steps below. # Copy the PowerShell Azure VHD blob to your subscription and create a VM from it. @@ -134,7 +134,7 @@ git config --global user.email "" ``` git config --global user.name "" ``` -Next, you will need to follow the steps [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md#environment-setup) to set up your local fork of Azure/azure-powershell. +Next, you will need to follow the steps [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md#environment-setup) to set up your local fork of Azure/azure-powershell. # Building and Running Tests -This image has been set up to build and run tests immediately. To build the project, run msbuild build.proj in the Developer Command Prompt for VS2015. Once this has completed, you can open your module in Visual Studio and start development there. To record tests, follow the instructions [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md#recordingrunning-tests). +This image has been set up to build and run tests immediately. To build the project, run msbuild build.proj in the Developer Command Prompt for VS2015. Once this has completed, you can open your module in Visual Studio and start development there. To record tests, follow the instructions [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md#recordingrunning-tests). diff --git a/documentation/testing-docs/using-azure-test-framework.md b/documentation/testing-docs/using-azure-test-framework.md index 1b27cb76971e..7b4a3524a331 100644 --- a/documentation/testing-docs/using-azure-test-framework.md +++ b/documentation/testing-docs/using-azure-test-framework.md @@ -157,7 +157,7 @@ AZURE_TEST_MODE=Record ## Record or Playback Tests -- [Run the tests](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md#recordingrunning-tests) and make sure that you got a generated `.json` file that matches the test name in the bin folder under the `SessionRecords` folder +- [Run the tests](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md#recordingrunning-tests) and make sure that you got a generated `.json` file that matches the test name in the bin folder under the `SessionRecords` folder - Copy the `SessionRecords` folder inside the test project and add all `*.json` files in Visual Studio setting "Copy to Output Directory" property to "Copy if newer" - To assure that the records work fine, delete the connection string (default mode is Playback mode) OR change HttpRecorderMode within the connection string to "Playback" and run the tests diff --git a/documentation/troubleshoot-ci.md b/documentation/troubleshoot-ci.md index 859bfe2b6076..fd586bc7f180 100644 --- a/documentation/troubleshoot-ci.md +++ b/documentation/troubleshoot-ci.md @@ -16,18 +16,18 @@ This means there are issues with your help files. ### Reasons: -- Cmdlet was changed while .md help files were not regenerated [this way](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md) or there is no help files at all. +- Cmdlet was changed while .md help files were not regenerated [this way](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md) or there is no help files at all. - Help files were re-generated, however they weren't filled with real data. I.e. help generator leaves templates like this `"{{Description there}}"` and they need to be manually filled by developer with descriptions, examples, etc. ### Solution -Regenerate MD help files [this way](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md) and update "{{\*}}" placeholders +Regenerate MD help files [this way](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md) and update "{{\*}}" placeholders ## Code analysis failures ### Message -> c:\workspace\powershell\build.proj(597,5): error MSB3073: The command "c:\workspace\powershell\src\Package\\**StaticAnalysis.exe** -p c:\workspace\powershell\src\Package\Debug -r c:\workspace\powershell\src\Package -m Az.Network" exited with code 255.c:\workspace\powershell\build.proj(609,5): error : StaticAnalysis has failed. Please follow the instructions on this doc: [https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md](https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md) +> c:\workspace\powershell\build.proj(597,5): error MSB3073: The command "c:\workspace\powershell\src\Package\\**StaticAnalysis.exe** -p c:\workspace\powershell\src\Package\Debug -r c:\workspace\powershell\src\Package -m Az.Network" exited with code 255.c:\workspace\powershell\build.proj(609,5): error : StaticAnalysis has failed. Please follow the instructions on this doc: [https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md](https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md) ### Reasons @@ -35,7 +35,7 @@ Something that is considered as unacceptable was added with your PR e.g. breakin ### Solution -According to the [link above](https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md) you would need to investigate .csv files in the build artifacts. +According to the [link above](https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md) you would need to investigate .csv files in the build artifacts. There are several ways to act: @@ -43,13 +43,13 @@ There are several ways to act: 2. In case changes could be improved without affecting functionality (e.g. signature is incorrect, but you could adjust it to suit requirements), try to fix. -3. In case messages in csv files describe expected changes, add them to [exclusions](https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes). +3. In case messages in csv files describe expected changes, add them to [exclusions](https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes). ### Example: One of the often reasons are BreakingChangesIssues. -If collected Breaking Changes issues are expected (e.g. cmdlet was really changed), you would need to update Exclusions file [like this](https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes) to bypass CI build. +If collected Breaking Changes issues are expected (e.g. cmdlet was really changed), you would need to update Exclusions file [like this](https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes) to bypass CI build. ## Test failures