Suppress mgmt track2 analyzer errors without changing generated codes

[archerzz]

Description

As an SDK developer, I'd like to suppress some errors in the generated codes, after reviewing with arch board.

If we apply mgmt track2 analyzer, there will be some errors which we decide we can ignore. Instead of suppressing in project level, we need to figure out how we can suppress in finer grain. Looks like we need an exception list file for each project, like cspell files, which can point to specific model properties or methods, like:

VirtualMachine.Enabled: AZM0016, AZM0017

[archerzz]

Looks like we don't need to design our own way to suppress errors. After investigation, there are a few options to suppress analyzer errors:

1. <NoWarn> in .csproj: project scope, granularity is too big
2. #pragma warning disable: anywhere in codes, not suitable for generated codes
3. .editorconfig: can be down to .cs file level, but not to each class member

[*.{cs,vb}]
dotnet_diagnostic.<rule-ID>.severity = none

4. SuppressMessageAttribute in codes: like #pragma
5. GlobalSuppressions.cs: using SuppressMessageAttribute, but not bound to specific codes. Here is an example from reference.

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1033:InterfaceMethodsShouldBeCallableByChildTypes", Scope = "member", Target = "System.Runtime.CompilerServices.StrongBox`1.#System.Runtime.CompilerServices.IStrongBox.Value")]

---

Option 5 can fulfill our requirement:

• granularity can be down to each member of a class/struct
• a single file containing all suppressions, making it easy to maintain

@m-nash ^^

[archerzz]

Other ways to handle excessive errors:

• change severity of soft rules to DiagnosticSeverity.Info, so that it will not block CI build
  • setting severity level to DiagnosticSeverity.Info won't show up in the CI build. See: GeneratorExecutionContext.ReportDiagnostic prints nothing when DiagnosticSeverity is set to Info in source generator dotnet/roslyn#50574
• enable rules in .editorconfig, see here.
  • dotnet_diagnostic.<rule ID>.severity = <severity>
• provide a property like .NET analyzers <AnalysisMode> which can enable rules on demand. For example, we can provide a property <AzMgmtSdkAnalysisMode> which provide two values: default and recommended.

[archerzz]

By now, GlobalSuppressions.cs is the best way to suppress errors.