ReportingRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Reporting |
Métodos
| create |
Crea un nuevo filtro avanzado para la organización. |
| delete |
Elimina un filtro avanzado. |
| get |
Obtiene un filtro avanzado específico por su ID. |
| get |
Obtención del resumen de alertas por gravedad para la organización |
| get |
Obtener alertas combinadas para la organización |
| get |
Obtén todos los nombres distintos de componentes de dependencia de la organización (usados para filtrado de UX) |
| get |
Obtener el resumen de habilitación de la organización |
| get |
Obtén todos los proyectos y repositorios de la organización (usados para filtrado de experiencia de usuario) |
| get |
Obtén todos los nombres de reglas de escaneo de código distintos para la organización (usados para filtrado de UX) |
| get |
Obtén todos los tipos de secretos distintos para la organización (usados para filtrado de experiencia de usuario) |
| get |
|
| list |
Tiene todos los filtros avanzados para la organización. |
| update |
Actualiza un filtro avanzado. Solo se puede actualizar el nombre. |
Detalles del constructor
ReportingRestClient(IVssRestClientOptions)
Detalles del método
createAdvancedFilter(AdvancedFilterCreate)
Crea un nuevo filtro avanzado para la organización.
function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>
Parámetros
- filter
- AdvancedFilterCreate
El filtro avanzado para crear.
Devoluciones
Promise<AdvancedFilter>
deleteAdvancedFilter(string)
Elimina un filtro avanzado.
function deleteAdvancedFilter(filterId: string): Promise<void>
Parámetros
- filterId
-
string
El ID del filtro avanzado para eliminar.
Devoluciones
Promise<void>
getAdvancedFilter(string)
Obtiene un filtro avanzado específico por su ID.
function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>
Parámetros
- filterId
-
string
El ID del filtro avanzado para recuperar.
Devoluciones
Promise<AdvancedFilter>
getAlertSummaryForOrg(FilterCriteria)
Obtención del resumen de alertas por gravedad para la organización
function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>
Parámetros
- criteria
- FilterCriteria
Opciones para limitar los resúmenes devueltos
Devoluciones
Promise<OrgAlertSummary>
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)
Obtener alertas combinadas para la organización
function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>
Parámetros
- criteria
- CombinedAlertFilterCriteria
Se devolvieron las opciones para filtrar las alertas combinadas
- top
-
number
Número máximo de alertas que se van a devolver
- continuationToken
-
string
Si hay más alertas de las que se pueden devolver, se coloca un token de continuación en el encabezado "x-ms-continuationtoken". Use ese token aquí para obtener la siguiente página de alertas.
Devoluciones
Promise<PagedList<DashboardAlert>>
getDependencyComponentNamesForOrg()
Obtén todos los nombres distintos de componentes de dependencia de la organización (usados para filtrado de UX)
function getDependencyComponentNamesForOrg(): Promise<string[]>
Devoluciones
Promise<string[]>
getEnablementSummaryForOrg(EnablementFilterCriteria)
Obtener el resumen de habilitación de la organización
function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>
Parámetros
- criteria
- EnablementFilterCriteria
Opciones para limitar los resúmenes devueltos
Devoluciones
Promise<OrgEnablementSummary>
getProjectsAndReposForOrg()
Obtén todos los proyectos y repositorios de la organización (usados para filtrado de experiencia de usuario)
function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>
Devoluciones
Promise<ProjectAndRepoInfo[]>
getRuleNamesForOrg(string)
Obtén todos los nombres de reglas de escaneo de código distintos para la organización (usados para filtrado de UX)
function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>
Parámetros
- toolName
-
string
Nombre opcional de herramienta para filtrar reglas por
Devoluciones
Promise<CodeScanningRuleInfo[]>
getSecretTypesForOrg()
Obtén todos los tipos de secretos distintos para la organización (usados para filtrado de experiencia de usuario)
function getSecretTypesForOrg(): Promise<string[]>
Devoluciones
Promise<string[]>
getUXComputedFilters()
function getUXComputedFilters(): Promise<ReportingUXComputedFilters>
Devoluciones
Promise<ReportingUXComputedFilters>
listAdvancedFilters(boolean, string)
Tiene todos los filtros avanzados para la organización.
function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>
Parámetros
- includeDeleted
-
boolean
Si incluir filtros de eliminación suave.
- keywords
-
string
Filtro opcional para buscar filtros por nombre (insensible a mayúsculas, coincidencia parcial).
Devoluciones
Promise<AdvancedFilter[]>
updateAdvancedFilter(AdvancedFilterUpdate, string)
Actualiza un filtro avanzado. Solo se puede actualizar el nombre.
function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>
Parámetros
- filter
- AdvancedFilterUpdate
Los datos de actualización que contienen el nuevo nombre.
- filterId
-
string
El ID del filtro avanzado para actualizar.
Devoluciones
Promise<void>