You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/Debugging-StaticAnalysis-Errors.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for
42
42
We take breaking changes very seriously, so please be mindful about the violations that you suppress in our repo.
43
43
44
44
### 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:
46
46
47
47
- Download the `SignatureIssues.csv` file from the Jenkins build
48
48
- 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
51
51
- 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.
52
52
53
53
### 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.
Copy file name to clipboardExpand all lines: documentation/development-docs/cleaning-up-commits.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -60,10 +60,10 @@ For more information on squashing, click [here](https://git-scm.com/book/en/v2/G
60
60
61
61
If you want to merge specific commits from another branch into the current one you are working from, use **cherry-picking**.
62
62
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:
64
64
65
65
```
66
-
git checkout master
66
+
git checkout main
67
67
git cherry-pick X -n
68
68
```
69
69
@@ -73,7 +73,7 @@ Now, if you want to cherry-pick a range of commits, say X through Y, from the **
73
73
74
74
```
75
75
git checkout -b temp-branch X
76
-
git rebase --onto master Y^
76
+
git rebase --onto main Y^
77
77
```
78
78
79
79
For more information on cherry-picking, click [here](https://git-scm.com/docs/git-cherry-pick).
Copy file name to clipboardExpand all lines: documentation/development-docs/design-guidelines/cmdlet-best-practices.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,7 @@ $job | Wait-Job
139
139
$subscriptions = $job | Receive-Job
140
140
````
141
141
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}'"
Copy file name to clipboardExpand all lines: documentation/development-docs/examples/private-link-resource-example.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -23,18 +23,18 @@ if "List Private Endpoint Connection API" is not available, `Private Endpoint Co
23
23
`privateEndpointConnections` need to be defined under this API
24
24
25
25
## 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)
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),
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'
Copy file name to clipboardExpand all lines: documentation/development-docs/generate-format.ps1xml-file.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Our team trends to make the cmdlets output more convenient and consistent across
14
14
15
15
# How table view output works by default.
16
16
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.
18
18
19
19
The cmdlet class specifies the ```PSAzureSubscription``` class as an output type with the **OutputType attribute**:
// omitted for brevity the rest of the definition.
32
32
```
33
33
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.
35
35
36
36
* Id
37
37
* Name
@@ -122,7 +122,7 @@ To provide a better PowerShell Azure cmdlets output experience we worked out a m
122
122
123
123
# Ps1XmlAttribute attribute.
124
124
125
-
Thekeyelementofthemechanismisthe **Ps1XmlAttribute** attributelocatedinthe [Commands.Common](https://github.com/Azure/azure-powershell-common/blob/master/src/Common/Attributes/Ps1XmlAttribute.cs) project. Below is the attribute definition:
125
+
Thekeyelementofthemechanismisthe **Ps1XmlAttribute** attributelocatedinthe [Commands.Common](https://github.com/Azure/azure-powershell-common/blob/main/src/Common/Attributes/Ps1XmlAttribute.cs) project. Below is the attribute definition:
* If **Label** is not specified - the property name will be used.
225
225
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.
**Note:** All the paths used in the example in the section are under **_azure-powershell/src/Accounts_**
427
427
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.
429
429
430
-
2. Referencethegeneratedformat.ps1xmlfileformyour project. Inourexamplethis is [Accounts.csproj](https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/Accounts.csproj) file.
430
+
2. Referencethegeneratedformat.ps1xmlfileformyour project. Inourexamplethis is [Accounts.csproj](https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/Accounts.csproj) file.
431
431
- **Note**: Thisisnowautomaticallyreferencedbased on `Az.props` beingimportedinyourcsproj file.
432
432
433
-
3. Addthegeneratedformat.ps1xmlfiletoyoursourcemodule manifest **FormatsToProcess** variable. Inourexamplethis is [src/Accounts/Az.Accounts.psd1](https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Az.Accounts.psd1) file:
433
+
3. Addthegeneratedformat.ps1xmlfiletoyoursourcemodule manifest **FormatsToProcess** variable. Inourexamplethis is [src/Accounts/Az.Accounts.psd1](https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Az.Accounts.psd1) file:
Copy file name to clipboardExpand all lines: documentation/development-docs/help-generation.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ If you would like to update the inputs/outputs for a markdown file, please run t
79
79
80
80
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.
81
81
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 <Repobasepath>/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 <Repobasepath>/artifacts/Debug/Az.Accounts/Az.Accounts.psd1_
Copy file name to clipboardExpand all lines: documentation/development-docs/sdkbased-vs-autogen.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Highlight parameters differences in auto-gen modules as below.
31
31
- Implement cmdlets in C# based on management SDK for Dotnet
32
32
- Implement testcases
33
33
- 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
35
35
36
36
### Auto-gen Module
37
37
@@ -45,7 +45,7 @@ Highlight parameters differences in auto-gen modules as below.
45
45
- Implement testcases
46
46
- Generate docs and populate them with examples
47
47
- 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
49
49
50
50
## Customization
51
51
@@ -78,7 +78,7 @@ Generally speaking, hero scenarios are implemented through customization through
78
78
79
79
### SDK-based Module
80
80
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.
Copy file name to clipboardExpand all lines: documentation/development-docs/vm-for-partners.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff 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.
2
2
3
3
# Copy the PowerShell Azure VHD blob to your subscription and create a VM from it.
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.
138
138
139
139
# 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).
0 commit comments