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 de autofix com o resultado da execução. Idempotente: chamadas repetidas para uma solicitação já em estado terminal retornam 200 sem alterações. |
| create |
Crie uma solicitação de autofixação para o alerta especificado. |
| create |
Crie um trabalho alerta. |
| create |
Crie uma revisão legal. Isso cria a revisão legal associada ao alerta. Ele inclui a url do item de trabalho de revisão. |
| delete |
Exclui os dados de análise para todos os pipelines em um repositório, limpando os alertas de Segurança Avançada associados. |
| delete |
Exclui os dados de análise para um pipeline específico, limpando os alertas de Segurança Avançada associados. |
| export |
Exportar alertas como um único arquivo SARIF |
| get |
Baixe o blob completo de metadados de IA para um alerta de código de IA. |
| get |
Obtenha um alerta. |
| get |
Obter instâncias de um alerta em um branch especificado com @ref. Se @ref não for fornecido, retorne instâncias de um alerta no branch padrão (se o alerta existir no branch padrão) ou no branch afetado mais recente. |
| get |
Receba um alerta com metadados. |
| get |
Receba alertas e metadados. |
| get |
Obter alertas para um repositório |
| get |
Obtenha um alerta. |
| get |
Obter alertas por IDs de alerta atualmente dá suporte apenas à busca de alertas secretos. |
| get |
Receba todos os pedidos de correção automática para o alerta especificado. |
| get |
Retorna os branches para os quais os resultados da análise foram enviados. |
| get |
Receba alertas de Draft para um repositório. |
| get |
Receba um emprego alerta por ID. |
| get |
Receba os alertas de empregos associados a um alerta. |
| get |
Receba alertas por seus IDs no nível da organização. Apenas reprisa alertas que o usuário tem permissão para exibir. Retorna apenas alertas de planos sku habilitados. |
| get |
Obter o status do trabalho de processamento do Sarif |
| get |
|
| get |
|
| get |
Obtenha os detalhes de validade de um alerta. |
| initiate |
Iniciar o processo de validação para um determinado alerta |
| query |
Consultar alertas para um repositório por vinculação de tipo de metadados. |
| submit |
Durável admite um lote de avaliações de triagem neutras para o prestador. |
| update |
Atualizar o status de um alerta |
| update |
Alerta de atualização de lote indica. |
| update |
Atualizar associações de metadados de alerta. |
| update |
Atualize um alerta de trabalho. |
| upload |
Carregar um arquivo Sarif no nível da organização |
| upload |
Carregar um Sarif contendo alertas de segurança |
| upload |
Envie um SARIF para o GitHub Code Scanning via um aplicativo GitOps. |
Detalhes do construtor
AlertRestClient(IVssRestClientOptions)
Detalhes do método
autofixCallback(AutofixCallbackRequest, string, string)
Recebe um callback do pipeline de autofix com o resultado da execução. Idempotente: chamadas repetidas para uma solicitação 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 retorno contém requestId, status e opcional pullRequestId.
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório.
Retornos
Promise<void>
createAutofixRequest(string, number, string, string)
Crie uma solicitação de autofixação 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 a ID do repositório.
- ref
-
string
O ref Git (ex.: refs/heads/feature/x) que o autofix deve mirar.
Retornos
Promise<AutofixRequest>
createJob(any, string, string)
Crie um trabalho 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 a ID do repositório
Retornos
Promise<AlertJob>
createLegalReview(string, string, number, string)
Crie uma 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 o alerta legal
- alertId
-
number
ID de alerta de segurança avançada do alerta legal para obter a revisão legal
- ref
-
string
Retornos
Promise<LegalReview>
deleteAllPipelineAnalyses(string, string)
Exclui os dados de análise para todos os pipelines em um 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 a ID do repositório.
Retornos
Promise<void>
deletePipelineAnalysis(string, string, number)
Exclui os 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 a ID do repositório.
- adoPipelineId
-
number
A ID do pipeline do ADO cujos dados de análise devem ser limpos.
Retornos
Promise<void>
exportSarif(string, string, number[], string)
Exportar alertas como um único arquivo 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 a ID de um repositório
- alertIds
-
number[]
Lista de IDs de alerta para exportação
- branchName
-
string
O nome da filial alerta do alvo. Se não especificado, o ramo padrão será usado.
Retornos
Promise<any>
getAiMetadataContent(string, number, string)
Baixe 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 baixado.
- repository
-
string
Nome ou ID do repositório do qual o alerta faz parte.
Retornos
Promise<any>
getAlert(string, number, string, string, ExpandOption)
Obtenha 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 ser recuperado
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda atributos de um alerta secreto. Os valores possíveis são: None e ValidationFingerprint. Usa None como padrão. Lembre-se de que, se expand estiver definido como ValidationFingerprint, a resposta poderá conter o segredo em sua forma não criptografada. Tenha cuidado ao usar esses dados.
Retornos
Promise<Alert>
getAlertInstances(string, number, string, string)
Obter instâncias de um alerta em um branch especificado com @ref. Se @ref não for fornecido, retorne instâncias de um alerta no branch padrão (se o alerta existir no branch padrão) ou no branch afetado 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 ser recuperado
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
Retornos
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 ser recuperado
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
Retornos
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
Retornos
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 a ID do repositório
- top
-
number
O número máximo de alertas a serem retornados
- orderBy
-
string
Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severidade" Padrões para "id"
- criteria
- SearchCriteria
Opções para limitar os alertas retornados
- expand
- AlertListExpandOption
- continuationToken
-
string
Se houver mais alertas do que pode ser retornado, 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
Retornos
getAlertSarif(string, number, string, string, ExpandOption)
Obtenha 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 ser recuperado
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda atributos de um alerta secreto. Os valores possíveis são: None e ValidationFingerprint. Usa None como padrão. Lembre-se de que, se expand estiver definido como ValidationFingerprint, a resposta poderá conter o segredo em sua forma não criptografada. Tenha cuidado ao usar esses dados.
Retornos
Promise<string>
getAlertsByIds(AlertBatchRequest, string, string, boolean)
Obter alertas por IDs de alerta atualmente dá suporte apenas à busca de alertas secretos.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>Parâmetros
- request
- AlertBatchRequest
Solicitação 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 a ID do repositório
- includeSensitiveInformation
-
boolean
Vale apenas para alertas secretos. Quando false (o padrão), o 'ValidationFingerprintJson' das impressões digitais de validação de cada alerta secreto é omitido da resposta. Coloque como verdadeiro para incluir; esteja ciente de que o JSON da impressão digital de validação pode conter o segredo não criptografado e outros dados sensíveis, portanto, tenha cautela ao solicitá-lo.
Retornos
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string, string)
Receba todos os pedidos de correção automática 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 a ID do repositório.
- ref
-
string
O ref Git (ex.: refs/heads/feature/x) que o autofix deve mirar.
Retornos
Promise<AutofixRequest[]>
getBranches(string, string, AlertType, string, string, number, boolean)
Retorna os branches para os 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), QL de Código (3), etc.
- continuationToken
-
string
Uma variável de cadeia de caracteres que representa o nome do branch e é usada para buscar branches que o seguem em ordem alfabética.
- branchNameContains
-
string
Uma variável de cadeia de caracteres usada para buscar branches que contêm essa cadeia de caracteres em qualquer lugar no nome do branch, não diferencia maiúsculas de minúsculas.
- top
-
number
Uma variável int usada para retornar os branches k superiores que atendem aos critérios de pesquisa.
- includePullRequestBranches
-
boolean
Uma variável bool que indica se os branches de solicitação de pull devem ou não ser incluídos.
Retornos
Promise<Branch[]>
getDraftAlerts(string, string, number, string, string, number, string)
Receba alertas de Draft para um repositório.
function getDraftAlerts(project: string, repository: string, top?: number, orderBy?: string, continuationToken?: string, sarifSubmissionId?: number, triageState?: string): Promise<PagedList<Alert>>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório
- top
-
number
O número máximo de alertas a serem retornados
- orderBy
-
string
Deve ser "id", "firstSeen", "lastSeen", "fixedOn" ou "severity". O padrão é "id". Quando o triageState é fornecido, apenas "id" é suportado.
- continuationToken
-
string
Se houver mais alertas do que pode ser retornado, 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
- sarifSubmissionId
-
number
Se forem fornecidos, devolva apenas os alertas do Código de IA rascunho representados por esta submissão SARIF
- triageState
-
string
Se for, retorne apenas as instâncias de alerta do Código de Rascunho de IA neste estado de fluxo de trabalho de triagem
Retornos
getJob(string, string, string)
Receba um emprego alerta por ID.
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 a ID do repositório
- jobId
-
string
O identificador de trabalho atribuído pelo provedor
Retornos
Promise<AlertJob>
getJobsForAlert(string, string, number, number, string)
Receba os alertas de empregos 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 a ID do repositório
- alertId
-
number
A ID do alerta
- top
-
number
O número máximo de empregos a serem retornados
- continuationToken
-
string
Se houver mais trabalhos do que podem ser retornados, um token de continuação é colocado no cabeçalho "x-ms-continuationtoken". Use esse token aqui para obter a próxima página de empregos
Retornos
getOrgLevelAlertsByIds(number[])
Receba alertas por seus IDs no nível da organização. Apenas reprisa alertas que o usuário tem permissão para exibir. Retorna apenas alertas de planos sku habilitados.
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>Parâmetros
- alertIds
-
number[]
Lista de IDs de alerta a serem recuperadas
Retornos
Promise<Alert[]>
getSarif(number)
Obter o status do trabalho de processamento do Sarif
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parâmetros
- sarifId
-
number
A ID do Sarif retornou quando o Sarif foi carregado
Retornos
Promise<SarifUploadStatus>
getSarifContent(number)
function getSarifContent(submissionId: number): Promise<any>Parâmetros
- submissionId
-
number
Retornos
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 a ID de um repositório
- alertId
-
number
A ID do alerta
Retornos
Promise<ValidationRequestInfo>
initiateValidation(string, string, number)
Iniciar o processo de validação para 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 a ID de um repositório
- alertId
-
number
A ID do alerta
Retornos
Promise<AlertValidationRequestStatus>
queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)
Consultar alertas para um repositório por vinculação de tipo 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 retornados
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório
- top
-
number
O número máximo de alertas a serem retornados
- orderBy
-
string
Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severidade" Padrões para "id"
- expand
- AlertListExpandOption
Opções para expandir a resposta, por exemplo, retornando contagens de alertas em vez de alertas
- continuationToken
-
string
Se houver mais alertas do que pode ser retornado, 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
Retornos
submitTriageSignals(TriageSignalSubmissionRequest, string, string)
Durável admite um lote de avaliações de triagem neutras para o prestador.
function submitTriageSignals(submission: TriageSignalSubmissionRequest, project: string, repository: string): Promise<TriageSignalSubmissionResponse>Parâmetros
- submission
- TriageSignalSubmissionRequest
O sinal de triagem para admitir.
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório.
Retornos
Promise<TriageSignalSubmissionResponse>
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 status do alerta
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
A ID do alerta
- repository
-
string
O nome ou a ID do repositório
Retornos
Promise<Alert>
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)
Alerta de atualização de lote indica.
function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>Parâmetros
- request
- AlertBatchStateUpdateRequest
Solicitação contendo atualizações de estado de alerta
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório
Retornos
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 a ID do repositório.
Retornos
Promise<AlertMetadataChange[]>
updateJob(any, string, string, string)
Atualize um alerta de trabalho.
function updateJob(patch: any, project: string, repository: string, jobId: string): Promise<AlertJob>Parâmetros
- patch
-
any
O patch que descreve os campos a serem atualizados
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID do repositório
- jobId
-
string
O identificador de trabalho atribuído pelo provedor
Retornos
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 a ser carregado
Retornos
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 a ser carregado
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou a ID de um repositório
- notificationFlag
-
String
Cabeçalho para sinalizar que esta é uma notificação de progresso
Retornos
Promise<number>
uploadSarifToGitHub(string, string, string, string, string)
Envie um SARIF para o GitHub Code Scanning via um aplicativo GitOps.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Parâmetros
- content
-
string
Conteúdo a ser carregado
- project
-
string
ID do projeto ou nome do projeto
- hostname
-
string
O nome de host GitHub (por exemplo, github.com ou microsoft.ghe.com)
- owner
-
string
O proprietário do repositório do GitHub (organização ou usuário)
- repo
-
string
O nome do repositório GitHub
Retornos
Promise<string>