ReportingRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Reporting |
Methoden
| create |
Erstellt einen neuen erweiterten Filter für die Organisation. |
| delete |
Löscht einen erweiterten Filter. |
| get |
Er erhält einen bestimmten erweiterten Filter über seine ID. |
| get |
Warnungszusammenfassung nach Schweregrad für die Organisation abrufen |
| get |
Abrufen kombinierter Benachrichtigungen für die Organisation |
| get |
Erhalten Sie alle unterschiedlichen Abhängigkeitskomponentennamen der Organisation (verwendet für UX-Filterung) |
| get |
Zusammenfassung der Aktivierung für die Organisation abrufen |
| get |
Hol alle Projekte und Repositories der Organisation (für UX-Filterung verwendet) |
| get |
Hol alle unterschiedlichen Codescanning-Regelnamen der Organisation (verwendet für UX-Filterung) |
| get |
Holen Sie alle unterschiedlichen Geheimnistypen für die Organisation (für UX-Filterung verwendet) |
| get |
|
| list |
Es gibt alle erweiterten Filter für die Organisation. |
| update |
Aktualisiert einen erweiterten Filter. Nur der Name kann aktualisiert werden. |
Details zum Konstruktor
ReportingRestClient(IVssRestClientOptions)
Details zur Methode
createAdvancedFilter(AdvancedFilterCreate)
Erstellt einen neuen erweiterten Filter für die Organisation.
function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>Parameter
- filter
- AdvancedFilterCreate
Der erweiterte Filter zum Erstellen.
Gibt zurück
Promise<AdvancedFilter>
deleteAdvancedFilter(string)
Löscht einen erweiterten Filter.
function deleteAdvancedFilter(filterId: string): Promise<void>Parameter
- filterId
-
string
Die ID des erweiterten Filters zum Löschen.
Gibt zurück
Promise<void>
getAdvancedFilter(string)
Er erhält einen bestimmten erweiterten Filter über seine ID.
function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>Parameter
- filterId
-
string
Die ID des erweiterten Filters zum Abrufen.
Gibt zurück
Promise<AdvancedFilter>
getAlertSummaryForOrg(FilterCriteria)
Warnungszusammenfassung nach Schweregrad für die Organisation abrufen
function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>Parameter
- criteria
- FilterCriteria
Optionen zur Begrenzung der zurückgegebenen Zusammenfassungen
Gibt zurück
Promise<OrgAlertSummary>
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)
Abrufen kombinierter Benachrichtigungen für die Organisation
function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>Parameter
- criteria
- CombinedAlertFilterCriteria
Optionen zum Filtern der kombinierten Warnungen
- top
-
number
Die maximale Anzahl von Warnungen, die zurückgegeben werden sollen
- continuationToken
-
string
Wenn mehr Warnungen vorhanden sind, als zurückgegeben werden können, wird ein Fortsetzungstoken im Header "x-ms-continuationtoken" platziert. Verwenden Sie dieses Token hier, um die nächste Seite mit Warnungen zu erhalten.
Gibt zurück
Promise<PagedList<DashboardAlert>>
getDependencyComponentNamesForOrg()
Erhalten Sie alle unterschiedlichen Abhängigkeitskomponentennamen der Organisation (verwendet für UX-Filterung)
function getDependencyComponentNamesForOrg(): Promise<string[]>Gibt zurück
Promise<string[]>
getEnablementSummaryForOrg(EnablementFilterCriteria)
Zusammenfassung der Aktivierung für die Organisation abrufen
function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>Parameter
- criteria
- EnablementFilterCriteria
Optionen zur Begrenzung der zurückgegebenen Zusammenfassungen
Gibt zurück
Promise<OrgEnablementSummary>
getProjectsAndReposForOrg()
Hol alle Projekte und Repositories der Organisation (für UX-Filterung verwendet)
function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>Gibt zurück
Promise<ProjectAndRepoInfo[]>
getRuleNamesForOrg(string)
Hol alle unterschiedlichen Codescanning-Regelnamen der Organisation (verwendet für UX-Filterung)
function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>Parameter
- toolName
-
string
Optionaler Werkzeugname zum Filtern der Regeln
Gibt zurück
Promise<CodeScanningRuleInfo[]>
getSecretTypesForOrg()
Holen Sie alle unterschiedlichen Geheimnistypen für die Organisation (für UX-Filterung verwendet)
function getSecretTypesForOrg(): Promise<string[]>Gibt zurück
Promise<string[]>
getUXComputedFilters()
function getUXComputedFilters(): Promise<ReportingUXComputedFilters>Gibt zurück
Promise<ReportingUXComputedFilters>
listAdvancedFilters(boolean, string)
Es gibt alle erweiterten Filter für die Organisation.
function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>Parameter
- includeDeleted
-
boolean
Ob man weich gelöschte Filter einbauen sollte.
- keywords
-
string
Optionaler Filter, um Filter nach Namen zu suchen (Groß- und Kleinschreibung, teilweise übereinstimmend).
Gibt zurück
Promise<AdvancedFilter[]>
updateAdvancedFilter(AdvancedFilterUpdate, string)
Aktualisiert einen erweiterten Filter. Nur der Name kann aktualisiert werden.
function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>Parameter
- filter
- AdvancedFilterUpdate
Die Aktualisierungsdaten mit dem neuen Namen.
- filterId
-
string
Die ID des erweiterten Filters zum Aktualisieren.
Gibt zurück
Promise<void>