Freigeben über


YAML-Konfigurationsoptionen zum Anpassen der Buildtasks

Hinweis

Ab dem 31. Dezember 2022 wurde die Erweiterung „Microsoft-Sicherheitscodeanalyse“ (Microsoft Security Code Analysis, MSCA) eingestellt. MSCA wird durch die Microsoft Security DevOps Azure DevOps-Erweiterung ersetzt. Befolgen Sie die Anweisungen unter "Konfigurieren ", um die Erweiterung zu installieren und zu konfigurieren.

In diesem Artikel sind alle YAML-Konfigurationsoptionen aufgeführt, die in den einzelnen Buildtasks verfügbar sind. Zunächst werden in diesem Artikel die Tasks für die Tools der Sicherheitscodeanalyse erläutert. Zum Schluss werden die Tasks für die Nachbearbeitung beschrieben.

Schadsoftwarescanner-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
Eingabetyp Pickliste immer Richtig Grundlegend Einfach, benutzerdefiniert
Scantyp pickList InputType = Grundlegend Richtig Benutzerdefinierter Scan CustomScan, FullSystemScan, QuickScan, YourConfiguredScan Der für den Antischadsoftware-Scan zu verwendende Scantyp.
FileDirPath filePath ScanTyp = BenutzerdefinierterScan Richtig $(Build.StagingDirectory) Gibt die Datei oder das Verzeichnis für den Scanvorgang an.
Deaktivierung der Behebung Boolescher Wert ScanType = CustomScan Falsch Wahr Bei Aktivierung: 1) Dateiausschlüsse werden ignoriert. 2) Archivdateien werden gescannt. 3) Aktionen werden nach der Erkennung nicht angewendet. 4) Ereignisprotokolleinträge werden nach der Erkennung nicht geschrieben. 5) Erkennungen, die sich aus dem benutzerdefinierten Scan ergeben, werden nicht auf der Benutzeroberfläche angezeigt. 6) In der Konsolenausgabe wird die Liste mit den Erkennungen des benutzerdefinierten Scans angezeigt.
BootSectorScan Boolescher Wert ScanType = Benutzerdefinierter Scan Falsch Falsch Wenn diese Option aktiviert ist, wird die Überprüfung des Startsektors ermöglicht.
Argumente Zeichenfolge InputType = Benutzerdefiniert Richtig -Scan -ScanType 3 -DisableRemediation -File $(Build.StagingDirectory) Die Befehlszeilenargumente, bei denen das Argument für „-File“ ein absoluter Pfad ist, oder ein relativer Pfad zum Verzeichnis „$(Build.StagingDirectory)“, das für Ihren Build-Agent vordefiniert ist. Hinweis: Wenn Sie kein Argument für „-File“ als letztes Argument angeben, wird standardmäßig „$(Build.StagingDirectory)“ verwendet. Sie können auch Ihre eigenen Argumente angeben, die für das Tool „MpCmdRun.exe“ zulässig sind.

Weitere Informationen zu den Befehlszeilenargumenten für dieses Tool finden Sie unter "-h " oder "-? " im Feld "Argumente", und führen Sie die Buildaufgabe aus.
EnableServices Boolescher Wert immer Richtig Falsch Wenn diese Option aktiviert ist, wird versucht, die erforderlichen Dienste für Windows Update zu aktivieren (falls sie deaktiviert sind).
HINWEIS: Stellen Sie sicher, dass die Gruppenrichtlinie die Dienste nicht deaktiviert und das Konto, unter dem dieser Build ausgeführt wird, über Administratorrechte verfügt.
SupportLogOnError Boolescher Wert immer Richtig Falsch Wenn diese Option aktiviert ist, werden die Unterstützungsdateien für die Diagnose erfasst, falls ein Fehler aufgetreten ist. Dieser Vorgang kann einige Minuten dauern.
HINWEIS: Stellen Sie sicher, dass das Konto, unter dem dieser Build ausgeführt wird, über Administratorrechte verfügt.
FehlerBeiAktualisierungDerSignaturBehandelnAls pickList immer Richtig Warnung Fehler, Standard, Warnung Die Protokollebene, die verwendet wird, falls die Signatur zur Laufzeit nicht aktualisiert werden kann. Wenn auf „Fehler“ gesetzt, führt ein Fehler beim Aktualisieren der Signatur dazu, dass die Build-Aufgabe fehlschlägt. Beachten Sie Folgendes: Es kommt häufiger vor, dass die Signatur auf gehosteten Build-Agents nicht erfolgreich ist. Dies kann auch passieren, wenn die Signatur relativ aktuell ist (weniger als drei Stunden alt).
SignatureFreshness pickList immer Richtig UpToDate EinTag, DreiTage, ZweiTage, Aktuell Das maximal zulässige Alter für die Antischadsoftware-Signatur. Wenn die Signatur nicht aktualisiert werden kann und älter als dieser Wert ist, verhält sich die Buildaufgabe entsprechend dem im Feld Signaturalter validieren als ausgewählten Wert. Hinweis: Wenn Sie "Up-To-Date" auswählen, dürfen die Signaturen bis zu 3 Stunden alt sein.
BehandleVeralteteSignaturAls pickList immer Richtig Fehler Fehler, Standard, Warnung Die Protokollstufe, die verwendet wird, wenn das Signaturalter älter als das ausgewählte Antimalware-Signaturalter ist. Eine veraltete Signatur kann als Warnung oder Information behandelt werden, um mit dem Antischadsoftwarescan fortzufahren, dies wird jedoch nicht empfohlen.

BinSkim-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
Eingabetyp pickList immer Richtig Grundlegend Grundlegend, Befehlszeile
Argumente Zeichenfolge InputType = Befehlszeile Richtig BinSkim-Standard-Befehlszeilenargumente, die ausgeführt werden sollen. Der Ausgabepfad wird entfernt und ersetzt.
Weitere Informationen zu den Befehlszeilenargumenten für dieses Tool erhalten Sie, indem Sie im Feld "Argumente" help eingeben und die Build-Aufgabe ausführen.
Funktion pickList InputType = Basic Richtig analysieren analysieren, dump, exportConfig, exportRules
AnalyzeTarget filePath InputType = Basic && Function = analyze Richtig $(Build.ArtifactStagingDirectory)*.dll;
$(Build.ArtifactStagingDirectory)*.exe
Mindestens ein Spezifizierer für eine Datei, ein Verzeichnis oder ein Filtermuster, der in mindestens eine zu analysierende Binärdatei aufgelöst wird. (per Semikolon getrennte Liste)
AnalyzeSymPath Zeichenfolge InputType = Basic && Funktion = analysieren Falsch Der Pfad zur Symboldatei für das Ziel.
AnalyzeConfigPath Zeichenfolge InputType = Basic && Function = analysieren Falsch Vorgabe Pfad zu einer Richtliniendatei, die zum Konfigurieren der Analyse verwendet wird. Übergeben Sie den Wert „default“, um integrierte Einstellungen zu verwenden.
AnalyzePluginPath Zeichenfolge InputType = Basic && Funktion = analysieren Falsch Pfad zu einem Plug-In, das für alle Ziele im Analysesatz aufgerufen wird.
AnalyzeRecurse Boolescher Wert Eingabetyp = Basic && Funktion = analysieren Falsch Wahr Rekursives Durchlaufen von Unterverzeichnissen beim Auswerten von Dateispezifiziererargumenten.
AnalyzeVerbose Boolescher Wert InputType = Basic && Funktion = analysieren Falsch Falsch Gibt eine ausführliche Ausgabe aus. Der sich ergebende umfassende Bericht ist so konzipiert, dass für Konformitätsszenarien die passenden Beweise geliefert werden.
Analyse von Hashes Boolescher Wert Eingabetyp = Basic && Funktion = analysieren Falsch Falsch Ausgabe eines SHA-256-Hashs von Analysezielen, wenn SARIF-Berichte ausgegeben werden.
Statistiken analysieren Boolescher Wert Input-Typ = Basic && Funktion = analysieren Falsch Falsch Generiert Zeit- und andere Statistiken für die Analysesitzung.
AnalyzeEnvironment Boolescher Wert InputType = Basic && Funktion = analysieren Falsch Falsch Protokolliert die Details zur Computerumgebung für die Ausführung in einer Ausgabedatei. WARNUNG: Mit dieser Option werden Informationen, die sensibler Art sein können (z. B. alle Werte von Umgebungsvariablen), in ausgegebenen Protokollen aufgezeichnet.
ExportRulesOutputType pickList InputType = Basic && Function = exportRules Falsch SARIF SARIF, SonarQube Der Typ der auszugebenden Regeldeskriptordatei. Wird in den BinSkim-Protokollordner eingefügt, der vom Buildtask „Veröffentlichen von Sicherheitsanalyseprotokollen“ veröffentlicht wird.
DumpTarget filePath InputType = Basic && Function = dump Richtig $(Build.ArtifactStagingDirectory) Mindestens ein Spezifizierer für eine Datei, ein Verzeichnis oder ein Filtermuster, der in mindestens eine zu analysierende Binärdatei aufgelöst wird. (per Semikolon getrennte Liste)
DumpRecurse Boolescher Wert InputType = Basic && Function = dump Falsch Wahr Rekursives Durchlaufen von Unterverzeichnissen beim Auswerten von Dateispezifiziererargumenten.
DumpVerbose Boolescher Wert InputType = Basic && Function = dump Falsch Wahr Gibt eine ausführliche Ausgabe aus. Der sich ergebende umfassende Bericht ist so konzipiert, dass für Konformitätsszenarien die passenden Beweise geliefert werden.
Werkzeugversion pickList immer Falsch Neueste Version 1.5.0, Neueste, NeuesteVorabversion Die Version des Tools, das ausgeführt werden soll.

Credential Scanner-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
Ausgabeformat pickList immer Falsch pre csv, pre, tsv Das Ausgabeformat der Credential Scanner-Ergebnisdatei.
Werkzeugversion pickList immer Falsch Neueste Version 1.27.7, Neueste, NeuesteVorabversion Die Version des Tools, das ausgeführt werden soll.
scanFolder filePath immer Falsch $(Build.SourcesDirectory) Der Ordner in Ihrem Repository, der auf Anmeldeinformationen überprüft werden soll.
SearchersDateityp pickList immer Falsch Standard Benutzerdefiniert, Standard, DefaultAndCustom Optionen zum Suchen nach der zum Scannen verwendeten Suchroutinendatei.
searchersFile filePath searchersFileType == Custom OR searchersFileType == DefaultAndCustom Falsch Die Konfigurationsdatei der Credential Scanner-Suchroutinen für die auszuführenden Überprüfungen. Mehrere Werte können eingefügt und verwendet werden, indem eine kommagetrennte Liste mit Pfaden zu den Credential Scanner-Suchroutinendateien bereitgestellt wird.
suppressionsFile filePath immer Falsch Die Credential Scanner-Unterdrückungsdatei, die zum Unterdrücken von Problemen im Ausgabeprotokoll verwendet wird.
suppressAsError Boolescher Wert immer Falsch Falsch Unterdrückte Übereinstimmungen werden in der Ausgabedatei „[-O]-matches.[-f]“ ausgegeben, und nicht in der Standardausgabedatei „[-O]-suppressed.[-f]“ für Unterdrückungen. (Der Standardwert ist „False“.)
verboseOutput Boolescher Wert immer Falsch Falsch Gibt ausführliche Informationen aus.
Batchgröße Zeichenfolge immer Falsch Die Anzahl von parallelen Threads, die verwendet werden, um Credential Scanner-Instanzen parallel auszuführen. (Der Standardwert ist 20.)
Der Wert muss im Bereich zwischen 1 und 2.147.483.647 liegen.
regexÜbereinstimmungszeitüberschreitungInSekunden Zeichenfolge immer Falsch Gibt an, wie viele Sekunden die Suchroutine versucht, eine Übereinstimmung zu finden, bevor die Überprüfung abgebrochen wird.
Fügt -Co RegexMatchTimeoutInSeconds=<Value> der Befehlszeile hinzu.
DateiScanLesepufferGröße Zeichenfolge immer Falsch Puffergröße beim Lesen von Inhalt in Byte. (Der Standardwert ist 524.288.)
Fügt -Co FileScanReadBufferSize=<Value> der Befehlszeile hinzu.
maxFileScanReadBytes Zeichenfolge immer Falsch Maximale Anzahl von Bytes, die während der Inhaltsanalyse aus der jeweiligen Datei gelesen werden. (Der Standardwert ist 104.857.600.)
Fügt -Co MaxFileScanReadBytes=<Value> der Befehlszeile hinzu.

Roslyn Analyzers-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
userProvideBuildInfo pickList immer Richtig Auto auto, msBuildInfo Optionen für einen Benutzer zum Angeben der MSBuild-Version, MSBuild-Architektur und Buildbefehlszeile für die Roslyn-Analyse. Wenn Auto ausgewählt ist, ruft diese Aufgabe die Buildinformationen aus den vorherigen MSBuild-, VSBuild- und/oder .NET Core-Aufgaben (für Build)-Aufgaben in derselben Pipeline ab.
msBuildVersion pickList userProvideBuildInfo == msBuildInfo Richtig 16,0 15.0, 16.0 MSBuild-Version
msBuildArchitecture pickList userProvideBuildInfo == msBuildInfo Richtig x86 DotNetCore, x64, x86 MSBuild-Architektur Hinweis: Wenn die Build-Befehlszeile dotnet.exe Build aufruft, wählen Sie die Option "Über .NET Core " aus.
msBuildCommandline Zeichenfolge userProvideBuildInfo == msBuildInfo Richtig Die vollständige Buildbefehlszeile zum Kompilieren Ihrer Projektmappe oder Projekte.

Hinweis: Die Befehlszeile sollte mit einem vollständigen Pfad zu MSBuild.exe oder dotnet.exebeginnen.
Der Befehl wird mit „$(Build.SourcesDirectory)“ als Arbeitsverzeichnis ausgeführt.
RegelsatzName pickList immer Falsch Empfohlen Benutzerdefiniert, Keine, Empfohlen, Erforderlich Ein benannter Regelsatz, der verwendet werden soll.

Bei Auswahl von Ruleset Configured In Your Visual Studio Project File(s) wird der Regelsatz verwendet, der in Ihren VS-Projektdateien vorkonfiguriert ist. Bei Auswahl von Custom kann eine Option mit einem benutzerdefinierten Regelsatzpfad festgelegt werden.
rulesetVersion pickList rulesetName == Required OR rulesetName == Recommended Falsch Neueste Version 8.0, 8.1, 8.2, Neueste, NeuesteVorabversion Die Version des ausgewählten SDL-Regelsatzes.
customRuleset Zeichenfolge rulesetName = Benutzerdefiniert Falsch Ein zugänglicher Pfad zu einem zu verwendenden Regelsatz. Relative Pfade werden in den Stamm des Quellrepositorys ($(Build.SourcesDirectory)) normalisiert.

Wenn für den Regelsatz Rules die Option Actions auf Error festgelegt ist, tritt für den Buildtask ein Fehler auf. Überprüfen Sie Continue on error unter Control Options für den Buildtask, um einen Regelsatz dieser Art zu verwenden.
microsoftAnalyzersVersion pickList immer Falsch Neueste Version 2.9.3, 2.9.4, 2.9.6, Neueste, NeuesteVorabversion Die Version des Microsoft.CodeAnalysis.FxCopAnalyzers-Pakets, die ausgeführt werden soll.
UnterdrückungsdateiFürCompilerwarnungen filePath immer Falsch Eine Unterdrückungsdatei zum Unterdrücken von C#- und VB-Compilerwarnungen.

Eine Nur-Text-Datei, in der jede Warnungs-ID in einer separaten Zeile aufgeführt ist.
Geben Sie für Compilerwarnungen nur den numerischen Teil des Warnungsbezeichners an. Beispielsweise wird mit 1018 die Warnung CS1018 und mit CA1501 die Warnung CA1501 unterdrückt.

Ein relativer Dateipfad wird an den Stamm des Quellrepositorys ($(Build.SourcesDirectory)) angefügt.

TSLint-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
RuleLibrary pickList immer Richtig tslint custom, microsoft, tslint Alle Ergebnisse enthalten die Regeln, die mit der ausgewählten Version von TSLint (Base Only) ausgeliefert wurden.

Nur Basis - Nur die Regeln wurden mit TSLint ausgeliefert.

Microsoft-Regeln einschließen – Lädt tslint-microsoft-contrib herunter und enthält seine Regeln für die Verwendung in der TSLint-Ausführung. Wenn Sie diese Option auswählen, wird das Kontrollkästchen Type Checking ausgeblendet, da diese Funktion für die Regeln von Microsoft erforderlich ist und automatisch genutzt wird. Außerdem wird das Microsoft Contribution Version Feld eingeblendet, sodass eine Version von tslint-microsoft-contrib aus npm ausgewählt werden kann.

Benutzerdefinierte Regeln einschließen - Blenden Sie das Rules Directory Feld ein, das einen barrierefreien Pfad zu einem Verzeichnis von TSLint-Regeln akzeptiert, das für die Verwendung in der TSLint-Ausführung verfügbar ist.

Anmerkung: Der Standardwert wurde in tslint geändert, da viele Benutzer Probleme beim Konfigurieren des Microsoft-Rulesets hatten. Spezifische Versionskonfiguration finden Sie unter tslint-microsoft-contrib auf GitHub.
Regelverzeichnis Zeichenfolge RuleLibrary == benutzerdefiniert Richtig Ein zugängliches Verzeichnis mit zusätzlichen TSLint-Regeln, damit diese für die Verwendung bei der TSLint-Ausführung verfügbar sind.
Regelwerk pickList RuleLibrary != microsoft Richtig Es wird empfohlen benutzerdefiniert, tslatest, tsrecommended Definiert die Regeln, die für TypeScript-Dateien ausgeführt werden.

tslint:latest - Erweitert tslint:recommended und wird kontinuierlich aktualisiert, um die Konfiguration für die neuesten Regeln in jeder TSLint-Version einzubeziehen. Bei Verwendung dieser Konfiguration kann es in Nebenversionen zu Breaking Changes kommen, wenn neue Regeln aktiviert werden. Dies führt zu Lint-Fehlern in Ihrem Code. Wenn für TSLint die nächste Hauptversion erreicht wird, wird tslint:recommended aktualisiert und ist dann mit tslint:latest identisch.

tslint:recommended - Ein stabiler, etwas meinungsstarker Satz von Regeln, die TSLint für die allgemeine TypeScript-Programmierung empfiehlt. Diese Konfiguration folgt semver, sodass es keine Änderungen über kleinere oder Patchversionen hinweg gibt.
Regelsatz von Microsoft pickList RuleLibrary == microsoft Richtig mssdlrequired custom, msrecommended, mssdlrecommended, mssdlrequired, tslatest, tsrecommended Definiert die Regeln, die für TypeScript-Dateien ausgeführt werden.

microsoft:sdl-required - Führen Sie alle verfügbaren Prüfungen aus, die von tslint und den tslint-microsoft-contrib-Regeln bereitgestellt werden, die den erforderlichenSDL-Richtlinien (Security Development Lifecycle) entsprechen.

microsoft:sdl-recommended - Führen Sie alle verfügbaren Prüfungen aus, die von tslint und den tslint-microsoft-contrib-Regeln bereitgestellt werden, die den erforderlichen und empfohlenenSDL-Richtlinien (Security Development Lifecycle) entsprechen.

microsoft:recommended Alle Prüfungen, die von den Erstellern der Tslint-microsoft-contrib-Regeln empfohlen werden. Dies umfasst auch Sicherheitsüberprüfungen und Überprüfungen anderer Art.

tslint:latest - Erweitert tslint:recommended und wird kontinuierlich aktualisiert, um die Konfiguration für die neuesten Regeln in jeder TSLint-Version einzubeziehen. Bei Verwendung dieser Konfiguration kann es in Nebenversionen zu Breaking Changes kommen, wenn neue Regeln aktiviert werden. Dies führt zu Lint-Fehlern in Ihrem Code. Wenn für TSLint die nächste Hauptversion erreicht wird, wird tslint:recommended aktualisiert und ist dann mit tslint:latest identisch.

tslint:recommended - Ein stabiler, tendenziell strenger Satz von Regeln, die TSLint für die allgemeine TypeScript-Programmierung empfiehlt. Diese Konfiguration folgt semver, sodass sie keine umfassenden Änderungen über kleine oder Patchversionen hinweg erfährt.
Regelsatzdatei Zeichenfolge Ruleset == benutzerdefiniert ODER RulesetMicrosoft == benutzerdefiniert Richtig Eine Konfigurationsdatei , die angibt, welche Regeln ausgeführt werden sollen.

Der Pfad zur Konfiguration wird als Pfad für benutzerdefinierte Regeln hinzugefügt.
Dateiauswahltyp pickList immer Richtig fileGlob fileGlob, projectFile
Dateien Zeichenfolge FileSelectionType == fileGlob Richtig .ts Eine Datei-Glob , die bestimmt, welche Dateien verarbeitet werden sollen. Die Pfade gelten relativ zum Wert von Build.SourcesDirectory.

Für die Beitragsbibliothek von Microsoft muss eine Projektdatei verwendet werden. Wenn Sie die Beitragsbibliothek von Microsoft mit der Option File Glob Pattern verwenden, wird eine Projektdatei für Sie generiert.
ECMAScriptVersion pickList FileSelectionType == fileGlob && RuleLibrary == microsoft Richtig ES3 ES2015, ES2016, ES2017, ES3, ES5, ES6, ESNext Die Zielversion von ECMAScript, die mit Ihrem TypeScript-Compiler konfiguriert wurde. Bei Verwendung einer Projektdatei ist dies das Feld „compilerOptions.target“ in Ihrer TypeScript-Datei „tsconfig.json“.
Projekt Zeichenfolge FileSelectionType == projectFile Richtig Pfad zu einer tsconfig.json Datei, die TypeScript-Dateien angibt, auf denen TSLint ausgeführt werden soll. Die Pfade gelten relativ zum Wert von Build.SourcesDirectory.
TypeCheck Boolescher Wert RuleLibrary != microsoft && FileSelectionType == projectFile Falsch Wahr Aktiviert beim Ausführen von Lintingregeln die Typüberprüfung.
ExcludeFiles Zeichenfolge immer Falsch Eine Glob , die Dateien angibt, die vom Linting ausgeschlossen werden sollen. Die Pfade gelten relativ zum Wert von Build.SourcesDirectory. Mehrere Werte können per Semikolon getrennt angegeben werden.
Ausgabeformat pickList immer Richtig json checkstyle, codeFrame, filesList, json, msbuild, pmd, prose, stylish, verbose, vso Der zum Generieren der Ausgabe zu verwendende Formatierer . Beachten Sie, dass das JSON-Format mit der Nachanalyse kompatibel ist.
NodeMemory Zeichenfolge immer Falsch Eine explizite Menge von Arbeitsspeicher in MB, die dem Knoten für die TSLint-Ausführung zugeordnet wird. Beispiel: 8.000

Wird der CLI-Option --max_old_space=<value> für den Knoten zugeordnet. Dies ist eine v8 option.
Werkzeugversion pickList RuleLibrary != microsoft Richtig neueste 4.0.0, 4.0.1, 4.0.2, 4.1.0, 4.1.1, 4.2.0, 4.3.0, 4.3.1, 4.4.0, 4.4.1, 4.4.2, 4.5.0, 4.5.1, 5.0.0, 5.1.0, 5.2.0, 5.3.0, 5.3.2, 5.4.0, 5.4.1, 5.4.2, 5.4.3, 5.5.0, neueste Die Version von TSLint zum Herunterladen und Ausführen.
TypeScript Version pickList immer Richtig neueste 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0, 0.9.1, 0.9.5, 0.9.7, 1.0.0, 1.0.1, 1.3.0, 1.4.1, 1.5.3, 1.6.2, 1.7.3, 1.7.5, 1.8.0, 1.8.10, 1.8.2, 1.8.5, 1.8.6, 1.8.7, 1.8.9, 1.9.0, 2.0.0, 2.0.10, 2.0.2, 2.0.3, 2.0.6, 2.0.7, 2.0.8, 2.0.9, 2.1.1, 2.1.4, 2.1.5, 2.1.6, 2.2.0, 2.2.1, benutzerdefiniert, aktuellste Die Version von TypeScript , die heruntergeladen und verwendet werden soll.
Anmerkung: Dies muss dieselbe Version von TypeScript sein, die zum Kompilieren des Codes verwendet wird.
TypeScript Version Benutzerdefiniert Zeichenfolge TypeScriptVersion == benutzerdefiniert Richtig neueste Die Version von TypeScript , die heruntergeladen und verwendet werden soll.
Anmerkung: Dies muss dieselbe Version von TypeScript sein, die zum Kompilieren des Codes verwendet wird.
MicrosoftContribVersion pickList RuleLibrary == microsoft neueste 4.0.0, 4.0.1, 5.0.0, 5.0.1, neueste Die Version von tslint-microsoft-contrib (SDL Rules), die heruntergeladen und verwendet werden soll.
Anmerkung: Die Version von tslint wird ausgewählt, die mit der für tslint-microsoft-contrib ausgewählten Version kompatibel ist. Für Updates von „tslint-microsoft-contrib“ wird dieser Buildtask als „Gate“ vorgeschaltet, bis Tests durchgeführt werden können.

Task zum Veröffentlichen von Sicherheitsanalyseprotokollen

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
ArtefaktName Zeichenfolge immer Richtig Codeanalyse-Protokolle Der Name des Artefakts, das erstellt werden soll.
Artefakttyp pickList immer Richtig Behälter Container, Dateipfad Der Typ des Artefakts, das erstellt werden soll.
Zielpfad Zeichenfolge ArtifactType = FilePath Falsch \my\share$(Build.DefinitionName)
$(Build.BuildNumber)
Die Dateifreigabe, auf die die Dateien kopiert werden sollen.
AllTools Boolescher Wert immer Richtig Wahr Dient zum Veröffentlichen von Ergebnissen, die von allen Buildtasks der Tools für die sichere Entwicklung generiert werden.
Antischadsoftware Boolescher Wert AllTools = false Richtig Wahr Dient zum Veröffentlichen von Ergebnissen, die von Antischadsoftware-Buildtasks (AntiMalware) generiert werden.
BinSkim Boolescher Wert AllTools = false Richtig Wahr Dient zum Veröffentlichen von Ergebnissen, die von BinSkim-Buildtasks generiert werden.
CredScan Boolescher Wert AllTools = false Richtig Wahr Dient zum Veröffentlichen von Ergebnissen, die von Credential Scanner-Buildtasks generiert werden.
RoslynAnalyzers Boolescher Wert AllTools = false Richtig Falsch Dient zum Veröffentlichen von Ergebnissen, die von Roslyn Analyzers-Buildtasks generiert werden.
TSLint (Werkzeug zur Analyse von TypeScript-Code) Boolescher Wert AllTools = false Richtig Wahr Dient zum Veröffentlichen von Ergebnissen, die von TSLint-Buildtasks generiert werden. Beachten Sie, dass für Berichte nur TSLint-Protokolle im JSON-Format unterstützt werden. Falls Sie ein anderes Format ausgewählt haben, sollten Sie Ihren TSLint-Buildtask entsprechend aktualisieren.
ToolLogsNichtGefundenAktion Auswahlliste immer Richtig Norm Fehler, Keine, Standard, Warnung Die Aktion, die ausgeführt werden soll, wenn Protokolle für ein ausgewähltes Tool (bzw. ein beliebiges Tool bei Aktivierung von „All Tools“) nicht gefunden werden. Dies impliziert, dass das Tool nicht ausgeführt wurde.

Optionen:
Keine: Die Nachricht wird in den ausführlichen Ausgabedatenstrom geschrieben, auf den nur zugegriffen werden kann, wenn die VSTS-Variable system.debug auf true gesetzt ist.
Standard: (Standard) Schreibt eine Standardausgabemeldung, dass für das Tool keine Protokolle gefunden wurden.
Warnung: Schreibt eine gelbe Warnmeldung, dass für das Tool keine Protokolle gefunden wurden, die auf der Buildzusammenfassungsseite als Warnung angezeigt werden.
Fehler: Schreibt eine rote Fehlermeldung und löst eine Ausnahme aus, die den Build unterbricht. Stellen Sie mit dieser Option sicher, welche einzelnen Tools ausgeführt werden.

Sicherheitsberichts-Task

InputType Typ Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
VstsConsole Boolescher Wert immer Falsch Wahr Dient zum Schreiben von Ergebnissen in die Pipelinekonsole.
TSV-Datei Boolescher Wert immer Falsch Wahr Es wird eine TSV-Datei (tabulatorgetrennte Werte) mit einer Zeile pro gefundenem Ergebnis generiert, in der die Informationen jeweils durch Tabulatoren getrennt sind.
HtmlFile Boolescher Wert immer Falsch Wahr Generiert eine HTML-Berichtsdatei.
AllTools Boolescher Wert immer Richtig Falsch Dient zum Melden von Ergebnissen, die von allen Buildtasks der Tools für die sichere Entwicklung generiert werden.
BinSkim Boolescher Wert AllTools = false Richtig Falsch Dient zum Melden von Ergebnissen, die von BinSkim-Buildtasks generiert werden.
BinSkimBreakOn pickList AllTools = true ODER BinSkim = true Richtig Fehler Fehler, WarnungOben Die Ebene der zu meldenden Ergebnisse.
CredScan Boolescher Wert AllTools = false Richtig Falsch Dient zum Melden von Ergebnissen, die von Credential Scanner-Buildtasks generiert werden.
RoslynAnalyzers Boolescher Wert AllTools = false Richtig Falsch Dient zum Melden von Ergebnissen, die von Roslyn Analyzers-Buildtasks generiert werden.
RoslynAnalyzersBreakOn pickList AllTools = true ODER RoslynAnalyzers = true Richtig Fehler Fehler, WarnungOben Die Ebene der zu meldenden Ergebnisse.
TSLint Boolescher Wert AllTools = false Richtig Falsch Dient zum Melden von Ergebnissen, die von TSLint-Buildtasks generiert werden. Beachten Sie, dass für Berichte nur TSLint-Protokolle im JSON-Format unterstützt werden. Falls Sie ein anderes Format ausgewählt haben, sollten Sie Ihren TSLint-Buildtask entsprechend aktualisieren.
TSLintBreakOn pickList AllTools = true OR TSLint = true Richtig Fehler Fehler, WarnungOben Die Ebene der zu meldenden Ergebnisse.
ToolLogsNotFoundAction Auswahlliste immer Richtig Norm Fehler, Keine, Standard, Warnung Die Aktion, die ausgeführt werden soll, wenn Protokolle für ein ausgewähltes Tool (bzw. ein beliebiges Tool bei Aktivierung von „All Tools“) nicht gefunden werden. Dies impliziert, dass das Tool nicht ausgeführt wurde.

Optionen:
Nichts: Die Nachricht wird nur in den ausführlichen Ausgabedatenstrom geschrieben, auf den nur zugegriffen werden kann, indem die VSTS-Variable "system.debug" auf "true" festgelegt wird.
Standard: (Standard) Schreibt eine Standardausgabemeldung, dass für das Tool keine Protokolle gefunden wurden.
Warnung: Schreibt eine gelbe Warnmeldung, dass für das Tool keine Protokolle gefunden wurden, die auf der Buildzusammenfassungsseite als Warnung angezeigt werden.
Fehler: Schreibt eine rote Fehlermeldung und löst eine Ausnahme aus, die den Build unterbricht. Stellen Sie mit dieser Option sicher, welche einzelnen Tools ausgeführt werden.
CustomLogsFolder Zeichenfolge immer Falsch Der Basisordner, in dem sich die Protokolle des Analysetools befinden. Die einzelnen Protokolldateien befinden sich unter diesem Pfad in den Unterordnern, die nach den einzelnen Tools benannt sind.

Nachanalyse-Task

InputType Art Anwendbar Erforderlich Standardwert Optionen (für Auswahllisten) Beschreibung
AllTools Boolescher Wert immer Richtig Falsch Für den Buildvorgang tritt ein Fehler auf, wenn von einem Buildtask der Microsoft-Sicherheitscodeanalyse Probleme gefunden werden.
BinSkim Boolescher Wert AllTools = false Richtig Falsch Für den Buildvorgang tritt ein Fehler auf, wenn BinSkim-Probleme gefunden werden. Dies hängt von der von Ihnen ausgewählten „Break On“-Option ab.
BinSkimBreakOn pickList AllTools = true OR BinSkim = true Richtig Fehler Fehler, WarnungOben Die Ebene der Probleme, die zum Buildfehler führen.
CredScan Boolescher Wert AllTools = false Richtig Falsch Für den Buildvorgang tritt ein Fehler auf, falls Credential Scanner-Probleme gefunden werden.
RoslynAnalyzers Boolescher Wert AllTools = false Richtig Falsch Für den Buildvorgang tritt ein Fehler auf, wenn Roslyn Analyzers-Probleme gefunden werden.
RoslynAnalyzersBreakOn pickList AllTools = true OR RoslynAnalyzers = true Richtig Fehler Fehler, WarnungOben Die Ebene der Probleme, die zum Buildfehler führen.
TSLint Boolescher Wert AllTools = false Richtig Falsch Für den Buildvorgang tritt ein Fehler auf, wenn TSLint-Probleme gefunden werden. Beachten Sie, dass für die Nachanalyse nur TSLint-Protokolle im JSON-Format unterstützt werden. Falls Sie ein anderes Format ausgewählt haben, sollten Sie Ihren TSLint-Buildtask entsprechend aktualisieren.
TSLintBreakOn pickList AllTools = true OR TSLint = true Richtig Fehler Fehler, WarnungOben Die Ebene der Probleme, die zum Buildfehler führen.
VstsConsole Boolescher Wert immer Falsch Wahr Dient zum Schreiben von Ergebnissen in die Pipelinekonsole.
ToolProtokolleNichtGefundenAktion Auswahlliste immer Richtig Norm Fehler, Keine, Standard, Warnung Die Aktion, die ausgeführt werden soll, wenn Protokolle für ein ausgewähltes Tool (bzw. ein beliebiges Tool bei Aktivierung von „All Tools“) nicht gefunden werden. Dies impliziert, dass das Tool nicht ausgeführt wurde.

Optionen:
Keine: Die Nachricht wird in den ausführlichen Ausgabedatenstrom geschrieben, auf den nur zugegriffen werden kann, wenn die VSTS-Variable "system.debug" auf "true" festgelegt wird.
Standard: (Standard) Schreibt eine Standardausgabemeldung, dass für das Tool keine Protokolle gefunden wurden.
Warnung: Schreibt eine gelbe Warnmeldung, dass für das Tool keine Protokolle gefunden wurden, die auf der Buildzusammenfassungsseite als Warnung angezeigt werden.
Fehler: Schreibt eine rote Fehlermeldung und löst eine Ausnahme aus, die den Build unterbricht. Stellen Sie mit dieser Option sicher, welche einzelnen Tools ausgeführt werden.

Nächste Schritte

Wenn Sie weitere Fragen zur Erweiterung "Security Code Analysis" und den angebotenen Tools haben, schauen Sie sich unsere FAQ-Seite an.