ReportingRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

RestClientBase

Construtores

ReportingRestClient(IVssRestClientOptions)

Métodos

createAdvancedFilter(AdvancedFilterCreate)	Cria um novo filtro avançado para a organização.
deleteAdvancedFilter(string)	Elimina um filtro avançado.
getAdvancedFilter(string)	Recebe um filtro avançado específico pelo seu ID.
getAlertSummaryForOrg(FilterCriteria)	Obter resumo de alertas por gravidade para a organização
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Receba Alertas Combinados para a organização
getDependencyComponentNamesForOrg()	Obtenha todos os nomes distintos dos componentes de dependência da organização (usados para filtragem de UX)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Obtenha um resumo de Capacitação para a organização
getProjectsAndReposForOrg()	Obtenha todos os projetos e repositórios da organização (usados para filtragem de UX)
getRuleNamesForOrg(string)	Obtenha todos os nomes distintos de regras de varredura de código da organização (usado para filtragem de UX)
getSecretTypesForOrg()	Obtenha todos os tipos de segredos distintos para a organização (usados para filtragem de UX)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Recebe todos os filtros avançados para a organização.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Atualiza um filtro avançado. Só o nome pode ser atualizado.

Detalhes do Construtor

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

createAdvancedFilter(AdvancedFilterCreate)

Cria um novo filtro avançado para a organização.

function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>

Parâmetros

filter

AdvancedFilterCreate

O filtro avançado para criar.

Devoluções

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Elimina um filtro avançado.

function deleteAdvancedFilter(filterId: string): Promise<void>

Parâmetros

filterId

string

O ID do filtro avançado para eliminar.

Devoluções

Promise<void>

getAdvancedFilter(string)

Recebe um filtro avançado específico pelo seu ID.

function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>

Parâmetros

filterId

string

O ID do filtro avançado para recuperar.

Devoluções

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Obter resumo de alertas por gravidade para a organização

function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>

Parâmetros

criteria

FilterCriteria

Opções para limitar os resumos devolvidos

Devoluções

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Receba Alertas Combinados para a organização

function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>

Parâmetros

criteria

CombinedAlertFilterCriteria

As opções para filtrar os alertas combinados retornaram

top

number

O número máximo de alertas a retornar

continuationToken

string

Se houver mais alertas do que podem ser retornados, um token de continuação será colocado no cabeçalho "x-ms-continuationtoken". Use esse token aqui para obter a próxima página de alertas

Devoluções

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Obtenha todos os nomes distintos dos componentes de dependência da organização (usados para filtragem de UX)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Devoluções

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Obtenha um resumo de Capacitação para a organização

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

Parâmetros

criteria

EnablementFilterCriteria

Opções para limitar os resumos devolvidos

Devoluções

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Obtenha todos os projetos e repositórios da organização (usados para filtragem de UX)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Devoluções

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Obtenha todos os nomes distintos de regras de varredura de código da organização (usado para filtragem de UX)

function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>

Parâmetros

toolName

string

Nome opcional da ferramenta para filtrar regras por

Devoluções

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Obtenha todos os tipos de segredos distintos para a organização (usados para filtragem de UX)

function getSecretTypesForOrg(): Promise<string[]>

Devoluções

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Devoluções

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Recebe todos os filtros avançados para a organização.

function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>

Parâmetros

includeDeleted

boolean

Se deve incluir filtros com apagamento suave.

keywords

string

Filtro opcional para pesquisar filtros por nome (indistinto a maiúsculas, correspondência parcial).

Devoluções

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Atualiza um filtro avançado. Só o nome pode ser atualizado.

function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>

Parâmetros

filter

AdvancedFilterUpdate

Os dados de atualização que contêm o novo nome.

filterId

string

O ID do filtro avançado para atualizar.

Devoluções

Promise<void>