Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit a39ce72

Browse files
authoredJun 11, 2021
change the branch name from master to main (#15238)
1 parent 4668bff commit a39ce72

13 files changed

+64
-64
lines changed
 

‎.azure-pipelines/daily-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ schedules:
55
displayName: Daily Midnight Build
66
branches:
77
include:
8-
- master
8+
- main
99

1010
pr: none
1111

‎documentation/Debugging-StaticAnalysis-Errors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for
4242
We take breaking changes very seriously, so please be mindful about the violations that you suppress in our repo.
4343

4444
### Signature Issues
45-
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check the [_Cmdlet Best Practices_](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/design-guidelines/cmdlet-best-practices.md) and the [_Parameter Best Practices_](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/design-guidelines/parameter-best-practices.md) documents 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:
45+
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check the [_Cmdlet Best Practices_](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/design-guidelines/cmdlet-best-practices.md) and the [_Parameter Best Practices_](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/design-guidelines/parameter-best-practices.md) documents 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:
4646

4747
- Download the `SignatureIssues.csv` file from the Jenkins build
4848
- 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
5151
- 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.
5252

5353
### Help Issues
54-
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.
54+
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/main/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.

‎documentation/development-docs/azure-powershell-developer-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ You now be able to create your own branches, commit changes, and push commits to
7676
git remote add upstream https://github.com/Azure/azure-powershell.git
7777
```
7878

79-
Then, to pull changes from the **master** branch in _Azure/azure-powershell_ into your local working branch, run the following command:
79+
Then, to pull changes from the **main** branch in _Azure/azure-powershell_ into your local working branch, run the following command:
8080

8181
```
82-
git pull upstream master
82+
git pull upstream main
8383
```
8484

8585
## Building the Environment

‎documentation/development-docs/cleaning-up-commits.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ For more information on squashing, click [here](https://git-scm.com/book/en/v2/G
6060

6161
If you want to merge specific commits from another branch into the current one you are working from, use **cherry-picking**.
6262

63-
For example, if you're working on the **master** branch and want to pull commit X (the commit-hash) from the **feature** branch, you may run the following commands:
63+
For example, if you're working on the **main** branch and want to pull commit X (the commit-hash) from the **feature** branch, you may run the following commands:
6464

6565
```
66-
git checkout master
66+
git checkout main
6767
git cherry-pick X -n
6868
```
6969

@@ -73,7 +73,7 @@ Now, if you want to cherry-pick a range of commits, say X through Y, from the **
7373

7474
```
7575
git checkout -b temp-branch X
76-
git rebase --onto master Y^
76+
git rebase --onto main Y^
7777
```
7878

7979
For more information on cherry-picking, click [here](https://git-scm.com/docs/git-cherry-pick).

‎documentation/development-docs/design-guidelines/cmdlet-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ $job | Wait-Job
139139
$subscriptions = $job | Receive-Job
140140
````
141141

142-
To set a custom job name, please use [`SetBackgroupJobDescription`](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}'"
142+
To set a custom job name, please use [`SetBackgroupJobDescription`](https://github.com/Azure/azure-powershell-common/blob/main/src/Common/AzurePSCmdlet.cs#L810). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'"
143143

144144
### Required Parameter Sets
145145

‎documentation/development-docs/examples/private-link-resource-example.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ if "List Private Endpoint Connection API" is not available, `Private Endpoint Co
2323
`privateEndpointConnections` need to be defined under this API
2424

2525
## Code Changes Needed
26-
Add corresponding {Provider}, {Top-Level-Resource} and {API-Version} into [ProviderConfiguration.cs](https://github.com/Azure/azure-powershell/blob/master/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/ProviderConfiguration.cs#L12)
26+
Add corresponding {Provider}, {Top-Level-Resource} and {API-Version} into [ProviderConfiguration.cs](https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/ProviderConfiguration.cs#L12)
2727
in following pattern:
2828
```
2929
RegisterConfiguration("{Provider}/{Top-Level-Resource}", "{API-Version}")
3030
```
3131
For example:
3232

33-
if "List Private Endpoint Connection API" is [available](https://github.com/Azure/azure-powershell/blob/master/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs#L74),
33+
if "List Private Endpoint Connection API" is [available](https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs#L74),
3434
```
3535
RegisterConfiguration("Microsoft.Sql/servers", "2018-06-01-preview")
3636
```
37-
if "List Private Endpoint Connection API" is [not available](https://github.com/Azure/azure-powershell/blob/master/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs#L93), provide extra bool parameter 'false'
37+
if "List Private Endpoint Connection API" is [not available](https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs#L93), provide extra bool parameter 'false'
3838
```
3939
RegisterConfiguration("Microsoft.Storage/storageAccounts", "2019-06-01", false)
4040
```

‎documentation/development-docs/generate-format.ps1xml-file.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Our team trends to make the cmdlets output more convenient and consistent across
1414

1515
# How table view output works by default.
1616

17-
As an example let's consider [Get-AzSubscription](https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/Subscription/GetAzureRMSubscription.cs) cmdlet.
17+
As an example let's consider [Get-AzSubscription](https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/Subscription/GetAzureRMSubscription.cs) cmdlet.
1818

1919
The cmdlet class specifies the ```PSAzureSubscription``` class as an output type with the **OutputType attribute**:
2020

@@ -31,7 +31,7 @@ namespace Microsoft.Azure.Commands.Profile
3131
// omitted for brevity the rest of the definition.
3232
```
3333

34-
The [PSAzureSubscription](https://github.com/Azure/azure-powershell-common/blob/master/src/Authentication.ResourceManager/Models/PSAzureSubscription.cs) class contains several public properties.
34+
The [PSAzureSubscription](https://github.com/Azure/azure-powershell-common/blob/main/src/Authentication.ResourceManager/Models/PSAzureSubscription.cs) class contains several public properties.
3535
3636
* Id
3737
* Name
@@ -122,7 +122,7 @@ To provide a better PowerShell Azure cmdlets output experience we worked out a m
122122

123123
# Ps1XmlAttribute attribute.
124124

125-
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:
125+
The key element of the mechanism is the **Ps1XmlAttribute** attribute located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/blob/main/src/Common/Attributes/Ps1XmlAttribute.cs) project. Below is the attribute definition:
126126
127127
```Cs
128128
namespace Microsoft.WindowsAzure.Commands.Common.Attributes
@@ -223,7 +223,7 @@ namespace Microsoft.Azure.Commands.Profile.Models
223223
```
224224
* If **Label** is not specified - the property name will be used.
225225

226-
* 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.
226+
* Since the **Ps1Xml attribute** definition is located in the [Commands.Common](https://github.com/Azure/azure-powershell-common/tree/main/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.
227227
228228
## Properties of complex types.
229229

@@ -425,12 +425,12 @@ c9cbd920-c00c-427c-852b-c329e824c3a8 Azure SDK Powershell Test Enabled 72f988bf-
425425

426426
**Note:** All the paths used in the example in the section are under **_azure-powershell/src/Accounts_**
427427

428-
1. Copy the generated file into your project source folder. In our example this is [src/Accounts/Accounts](https://github.com/Azure/azure-powershell/tree/master/src/Accounts/Accounts) folder.
428+
1. Copy the generated file into your project source folder. In our example this is [src/Accounts/Accounts](https://github.com/Azure/azure-powershell/tree/main/src/Accounts/Accounts) folder.
429429
430-
2. Reference the generated format.ps1xml file form your project. In our example this is [Accounts.csproj](https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/Accounts.csproj) file.
430+
2. Reference the generated format.ps1xml file form your project. In our example this is [Accounts.csproj](https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/Accounts.csproj) file.
431431
- **Note**: This is now automatically referenced based on `Az.props` being imported in your csproj file.
432432

433-
3. Add the generated format.ps1xml file to your source module manifest **FormatsToProcess** variable. In our example this is [src/Accounts/Az.Accounts.psd1](https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Az.Accounts.psd1) file:
433+
3. Add the generated format.ps1xml file to your source module manifest **FormatsToProcess** variable. In our example this is [src/Accounts/Az.Accounts.psd1](https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Az.Accounts.psd1) file:
434434
```Powershell
435435
# script omitted for brevity
436436

‎documentation/development-docs/help-generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ If you would like to update the inputs/outputs for a markdown file, please run t
7979

8080
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.
8181

82-
_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/Network) module run the cmd from under [`Commands.Network/help`](https://github.com/Azure/azure-powershell/tree/master/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_
82+
_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/main/src/Network) module run the cmd from under [`Commands.Network/help`](https://github.com/Azure/azure-powershell/tree/main/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_
8383

8484
#### Updating a single markdown file
8585

‎documentation/development-docs/sdkbased-vs-autogen.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Highlight parameters differences in auto-gen modules as below.
3131
- Implement cmdlets in C# based on management SDK for Dotnet
3232
- Implement testcases
3333
- Generate docs, and populate them with examples
34-
- Create a PR in master branch for code review
34+
- Create a PR in main branch for code review
3535

3636
### Auto-gen Module
3737

@@ -45,7 +45,7 @@ Highlight parameters differences in auto-gen modules as below.
4545
- Implement testcases
4646
- Generate docs and populate them with examples
4747
- Create a PR in **generation** branch for code review
48-
- Azure team members will help merge code from generation branch to master branch
48+
- Azure team members will help merge code from generation branch to main branch
4949

5050
## Customization
5151

@@ -78,7 +78,7 @@ Generally speaking, hero scenarios are implemented through customization through
7878

7979
### SDK-based Module
8080

81-
Docs are generated through playPS, please see [platyPS](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md#Installing-platyPS) for details. And developers should populate generated docs with examples.
81+
Docs are generated through playPS, please see [platyPS](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/help-generation.md#Installing-platyPS) for details. And developers should populate generated docs with examples.
8282

8383
### Auto-gen Module
8484

‎documentation/development-docs/vm-for-partners.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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.
1+
If you need an Azure Virtual Machine with all the [prerequisites](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/azure-powershell-developer-guide.md#prerequisites) installed and ready to build and test Powershell Azure - follow the steps below.
22

33
# Copy the PowerShell Azure VHD blob to your subscription and create a VM from it.
44

@@ -134,7 +134,7 @@ git config --global user.email "<Your email on GitHub>"
134134
```
135135
git config --global user.name "<Your name>"
136136
```
137-
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.
137+
Next, you will need to follow the steps [here](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/azure-powershell-developer-guide.md#environment-setup) to set up your local fork of Azure/azure-powershell.
138138
139139
# Building and Running Tests
140-
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).
140+
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/main/documentation/development-docs/azure-powershell-developer-guide.md#recordingrunning-tests).

‎documentation/internal/resource-manager-active-directory.md

Lines changed: 36 additions & 36 deletions
Large diffs are not rendered by default.

‎documentation/testing-docs/using-azure-test-framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ AZURE_TEST_MODE=Record
124124

125125
## Record or Playback Tests
126126

127-
- [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
127+
- [Run the tests](https://github.com/Azure/azure-powershell/blob/main/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
128128
- 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"
129129
- 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
130130

‎documentation/troubleshoot-ci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The url should exactly match the schema `https://docs.microsoft.com/en-us/powers
4444

4545
### Message
4646

47-
> c:\workspace\powershell\build.proj(597,5): error MSB3073: The command "c:\workspace\powershell\artifacts\\**StaticAnalysis.exe** -p c:\workspace\powershell\artifacts\Debug -r c:\workspace\powershell\artifacts -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](Debugging-StaticAnalysis-Errors.md)
47+
> c:\workspace\powershell\build.proj(597,5): error MSB3073: The command "c:\workspace\powershell\artifacts\\**StaticAnalysis.exe** -p c:\workspace\powershell\artifacts\Debug -r c:\workspace\powershell\artifacts -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/main/documentation/Debugging-StaticAnalysis-Errors.md](Debugging-StaticAnalysis-Errors.md)
4848
4949
### Reasons
5050

0 commit comments

Comments
 (0)
Please sign in to comment.