AlertRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS
- Extends
Construtores
| Alert |
Métodos
| autofix |
Recebe um callback do pipeline autofix com o resultado da execução. Idempotente: chamadas repetidas para um pedido já em estado terminal retornam 200 sem alterações. |
| create |
Crie um pedido de correcção automática para o alerta especificado. |
| create |
Crie um emprego alerta. |
| create |
Criar revisão legal. Isso cria a revisão legal associada ao alerta. Ele inclui a url do item de trabalho de revisão. |
| delete |
Elimina suavemente os dados de análise de todos os pipelines num repositório, limpando os alertas de Segurança Avançada associados. |
| delete |
Apaga suavemente dados de análise para um pipeline específico, limpando os alertas de Segurança Avançada associados. |
| export |
Exportar alertas como um único ficheiro SARIF |
| get |
Descarregue o blob completo de metadados de IA para um alerta de código de IA. |
| get |
Receba um alerta. |
| get |
Obter instâncias de um alerta em uma ramificação especificada com @ref. Se @ref não for fornecido, retorne instâncias de um alerta na ramificação padrão (se o alerta existir na ramificação padrão) ou na ramificação afetada mais recente. |
| get |
Receba um alerta com metadados. |
| get |
Receba alertas e metadados. |
| get |
Obter alertas para um repositório |
| get |
Receba um alerta. |
| get |
Receba alertas por IDs de alerta Atualmente suporta apenas a obtenção de alertas secretos. |
| get |
Recebe todos os pedidos de autofix para o alerta especificado. |
| get |
Devolve as ramificações para as quais os resultados da análise foram enviados. |
| get |
Receba alertas de recrutamento para um repositório. |
| get |
Receba um emprego alerta por identificação. |
| get |
Receba os alertas associados a um alerta. |
| get |
Receba alertas por seus IDs no nível da organização. Somente reprisa alertas que o usuário tem permissão para visualizar. Retorna apenas alertas de planos de sku habilitados. |
| get |
Obter o status do trabalho de processamento Sarif |
| get |
|
| get |
|
| get |
Obtenha os detalhes de validade de um alerta. |
| initiate |
Iniciar o processo de validação de um determinado alerta |
| query |
Alertas de consulta para um repositório por tipo de ligação de metadados. |
| update |
Atualizar o status de um alerta |
| update |
Alerta de atualização em lote indica. Uso interno apenas — usado por scanners de prova para transferir alertas de recrutamento gerados por IA para Ativos ou Dispensados. Os alertas marcados como Draft (indeterminado) permanecem inalterados. |
| update |
Atualizar associações de metadados de alerta. |
| update |
Atualize um emprego de alerta. |
| upload |
Carregar um arquivo Sarif no nível da organização |
| upload |
Carregar um Sarif contendo alertas de segurança |
| upload |
Carregue um SARIF para o GitHub Code Scanning através de uma aplicação GitOps. |
Detalhes do Construtor
AlertRestClient(IVssRestClientOptions)
Detalhes de Método
autofixCallback(AutofixCallbackRequest, string, string)
Recebe um callback do pipeline autofix com o resultado da execução. Idempotente: chamadas repetidas para um pedido já em estado terminal retornam 200 sem alterações.
function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string): Promise<void>Parâmetros
- callbackRequest
- AutofixCallbackRequest
A carga útil de callback contendo requestId, status e opcional pullRequestId.
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório.
Devoluções
Promise<void>
createAutofixRequest(string, number, string, string)
Crie um pedido de correcção automática para o alerta especificado.
function createAutofixRequest(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
O ID do alerta para criar um correcção automática.
- repository
-
string
O nome ou ID do repositório.
- ref
-
string
O ref Git (por exemplo, refs/heads/feature/x) que o autofix deve direcionar.
Devoluções
Promise<AutofixRequest>
createJob(any, string, string)
Crie um emprego alerta.
function createJob(body: any, project: string, repository: string): Promise<AlertJob>Parâmetros
- body
-
any
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
Devoluções
Promise<AlertJob>
createLegalReview(string, string, number, string)
Criar revisão legal. Isso cria a revisão legal associada ao alerta. Ele inclui a url do item de trabalho de revisão.
function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
Nome ou id de um repositório para a indicação legal
- alertId
-
number
ID de alerta de segurança antecipada do alerta legal para obter a revisão legal
- ref
-
string
Devoluções
Promise<LegalReview>
deleteAllPipelineAnalyses(string, string)
Elimina suavemente os dados de análise de todos os pipelines num repositório, limpando os alertas de Segurança Avançada associados.
function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório.
Devoluções
Promise<void>
deletePipelineAnalysis(string, string, number)
Apaga suavemente dados de análise para um pipeline específico, limpando os alertas de Segurança Avançada associados.
function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório.
- adoPipelineId
-
number
O ID do pipeline ADO cujos dados de análise devem ser limpos.
Devoluções
Promise<void>
exportSarif(string, string, number[], string)
Exportar alertas como um único ficheiro SARIF
function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID de um repositório
- alertIds
-
number[]
Lista de IDs de alerta a exportar
- branchName
-
string
O nome do ramo do alvo alerta. Se não for especificado, será usado o ramo padrão.
Devoluções
Promise<any>
getAiMetadataContent(string, number, string)
Descarregue o blob completo de metadados de IA para um alerta de código de IA.
function getAiMetadataContent(project: string, alertId: number, repository: string): Promise<any>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
ID do alerta cujo blob de metadados de IA deve ser descarregado.
- repository
-
string
Nome ou ID do repositório de que o alerta faz parte.
Devoluções
Promise<any>
getAlert(string, number, string, string, ExpandOption)
Receba um alerta.
function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
ID do alerta a recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda os atributos de um alerta secreto. Os valores possíveis são None e ValidationFingerprint. O padrão é None. Esteja ciente de que, se expand estiver definido como ValidationFingerprint, a resposta pode conter o segredo em sua forma não criptografada. Tenha cuidado ao utilizar estes dados.
Devoluções
Promise<Alert>
getAlertInstances(string, number, string, string)
Obter instâncias de um alerta em uma ramificação especificada com @ref. Se @ref não for fornecido, retorne instâncias de um alerta na ramificação padrão (se o alerta existir na ramificação padrão) ou na ramificação afetada mais recente.
function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
ID do alerta a recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
Devoluções
Promise<AlertAnalysisInstance[]>
getAlertMetadata(string, number, string)
Receba um alerta com metadados.
function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
ID do alerta a recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
Devoluções
Promise<AlertMetadata>
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)
Receba alertas e metadados.
function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>Parâmetros
- alertMetadataBatchRequest
- AlertMetadataBatchRequest
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
Devoluções
Promise<AlertMetadata[]>
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)
Obter alertas para um repositório
function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- top
-
number
O número máximo de alertas a retornar
- orderBy
-
string
Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" Padrão para "id"
- criteria
- SearchCriteria
Opções para limitar os alertas retornados
- expand
- AlertListExpandOption
- 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
getAlertSarif(string, number, string, string, ExpandOption)
Receba um alerta.
function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
ID do alerta a recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda os atributos de um alerta secreto. Os valores possíveis são None e ValidationFingerprint. O padrão é None. Esteja ciente de que, se expand estiver definido como ValidationFingerprint, a resposta pode conter o segredo em sua forma não criptografada. Tenha cuidado ao utilizar estes dados.
Devoluções
Promise<string>
getAlertsByIds(AlertBatchRequest, string, string, boolean)
Receba alertas por IDs de alerta Atualmente suporta apenas a obtenção de alertas secretos.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>Parâmetros
- request
- AlertBatchRequest
Pedido contendo IDs de alerta e filtro opcional de tipo de alerta
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- includeSensitiveInformation
-
boolean
Aplica-se apenas a alertas secretos. Quando false (o padrão), o 'ValidationFingerprintJson' das impressões digitais de validação de cada alerta secreto é omitido da resposta. Definido para verdadeiro para o incluir; tenha em atenção que o JSON da impressão digital de validação pode conter o segredo não encriptado e outros dados sensíveis, por isso tenha cautela ao solicitá-los.
Devoluções
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string, string)
Recebe todos os pedidos de autofix para o alerta especificado.
function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
A ID do alerta.
- repository
-
string
O nome ou ID do repositório.
- ref
-
string
O ref Git (por exemplo, refs/heads/feature/x) que o autofix deve direcionar.
Devoluções
Promise<AutofixRequest[]>
getBranches(string, string, AlertType, string, string, number, boolean)
Devolve as ramificações para as quais os resultados da análise foram enviados.
function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
- alertType
- AlertType
O tipo de alerta: Verificação de dependência (1), Segredo (2), Código QL (3), etc.
- continuationToken
-
string
Uma variável de cadeia de caracteres que representa o nome da ramificação e é usada para buscar ramificações que a seguem em ordem alfabética.
- branchNameContains
-
string
Uma variável de cadeia de caracteres usada para buscar ramificações que contêm essa cadeia de caracteres em qualquer lugar no nome da ramificação, sem distinção entre maiúsculas e minúsculas.
- top
-
number
Uma variável int usada para retornar as ramificações k superiores que satisfazem os critérios de pesquisa.
- includePullRequestBranches
-
boolean
Uma variável bool que indica se deve ou não incluir ramificações de solicitação pull.
Devoluções
Promise<Branch[]>
getDraftAlerts(string, string, number, string, string)
Receba alertas de recrutamento para um repositório.
function getDraftAlerts(project: string, repository: string, top?: number, orderBy?: string, continuationToken?: string): Promise<PagedList<Alert>>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- top
-
number
O número máximo de alertas a retornar
- orderBy
-
string
Deve ser "id", "firstSeen", "lastSeen", "fixedOn" ou "severity". Por defeito, "id"
- 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
getJob(string, string, string)
Receba um emprego alerta por identificação.
function getJob(project: string, repository: string, jobId: string): Promise<AlertJob>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- jobId
-
string
O identificador de trabalho atribuído pelo fornecedor
Devoluções
Promise<AlertJob>
getJobsForAlert(string, string, number, number, string)
Receba os alertas associados a um alerta.
function getJobsForAlert(project: string, repository: string, alertId: number, top?: number, continuationToken?: string): Promise<PagedList<AlertJob>>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- alertId
-
number
O ID do alerta
- top
-
number
O número máximo de empregos a regressar
- continuationToken
-
string
Se houver mais trabalhos do que o que pode ser devolvido, um token de continuação é colocado no cabeçalho "x-ms-continuationtoken". Usa esse token aqui para obteres a próxima página de empregos
Devoluções
getOrgLevelAlertsByIds(number[])
Receba alertas por seus IDs no nível da organização. Somente reprisa alertas que o usuário tem permissão para visualizar. Retorna apenas alertas de planos de sku habilitados.
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>Parâmetros
- alertIds
-
number[]
Lista de IDs de alerta a recuperar
Devoluções
Promise<Alert[]>
getSarif(number)
Obter o status do trabalho de processamento Sarif
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parâmetros
- sarifId
-
number
ID do Sarif retornado quando o Sarif foi carregado
Devoluções
Promise<SarifUploadStatus>
getSarifContent(number)
function getSarifContent(submissionId: number): Promise<any>Parâmetros
- submissionId
-
number
Devoluções
Promise<any>
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)
Obtenha os detalhes de validade de um alerta.
function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID de um repositório
- alertId
-
number
O ID do alerta
Devoluções
Promise<ValidationRequestInfo>
initiateValidation(string, string, number)
Iniciar o processo de validação de um determinado alerta
function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID de um repositório
- alertId
-
number
O ID do alerta
Devoluções
Promise<AlertValidationRequestStatus>
queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)
Alertas de consulta para um repositório por tipo de ligação de metadados.
function queryAlerts(criteria: AlertMetadataQueryCriteria, project: string, repository: string, top?: number, orderBy?: string, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>Parâmetros
- criteria
- AlertMetadataQueryCriteria
Filtros de tipo de metadados para limitar os alertas devolvidos
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- top
-
number
O número máximo de alertas a retornar
- orderBy
-
string
Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" Padrão para "id"
- expand
- AlertListExpandOption
Opções para expandir a resposta, por exemplo, devolver contagens de alertas em vez de alertas
- 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
updateAlert(AlertStateUpdate, string, number, string)
Atualizar o status de um alerta
function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>Parâmetros
- stateUpdate
- AlertStateUpdate
O novo estado do alerta
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
O ID do alerta
- repository
-
string
O nome ou ID do repositório
Devoluções
Promise<Alert>
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)
Alerta de atualização em lote indica. Uso interno apenas — usado por scanners de prova para transferir alertas de recrutamento gerados por IA para Ativos ou Dispensados. Os alertas marcados como Draft (indeterminado) permanecem inalterados.
function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>Parâmetros
- request
- AlertBatchStateUpdateRequest
Pedido contendo atualizações de estado de alerta
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
Devoluções
Promise<Alert[]>
updateAlertsMetadata(AlertMetadata[], string, string)
Atualizar associações de metadados de alerta.
function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>Parâmetros
- alertsMetadata
Uma lista de metadados a serem associados a alertas.
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório.
Devoluções
Promise<AlertMetadataChange[]>
updateJob(any, string, string, string)
Atualize um emprego de alerta.
function updateJob(patch: any, project: string, repository: string, jobId: string): Promise<AlertJob>Parâmetros
- patch
-
any
O patch que descreve os campos a atualizar
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório
- jobId
-
string
O identificador de trabalho atribuído pelo fornecedor
Devoluções
Promise<AlertJob>
uploadOrgSarif(string)
Carregar um arquivo Sarif no nível da organização
function uploadOrgSarif(content: string): Promise<number>Parâmetros
- content
-
string
Conteúdo para carregar
Devoluções
Promise<number>
uploadSarif(string, string, string, String)
Carregar um Sarif contendo alertas de segurança
function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>Parâmetros
- content
-
string
Conteúdo para carregar
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID de um repositório
- notificationFlag
-
String
Cabeçalho para sinalizar que esta é uma notificação de progresso
Devoluções
Promise<number>
uploadSarifToGitHub(string, string, string, string, string)
Carregue um SARIF para o GitHub Code Scanning através de uma aplicação GitOps.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Parâmetros
- content
-
string
Conteúdo para carregar
- project
-
string
ID do projeto ou nome do projeto
- hostname
-
string
O nome de anfitrião GitHub (por exemplo, github.com ou microsoft.ghe.com)
- owner
-
string
O proprietário do repositório GitHub (organização ou utilizador)
- repo
-
string
O nome do repositório GitHub
Devoluções
Promise<string>