ManagementRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS
- Extends
Construtores
| Management |
Métodos
| cancel |
Cancela todos os trabalhos CodeQL em execução e em fila e as execuções do pipeline dinâmico em tempo de funcionamento para a organização. |
| create |
Durante o cálculo de faturamento de várias organizações na unidade de escala primária (EUS21), essa API é usada para criar instantâneos de faturamento para uma organização específica. A unidade de escala primária chamará essa API para cada organização em diferentes unidades scsle para criar um instantâneo de faturamento. Os dados serão armazenados na partição específica da organização DB -> tabela de instantâneo de faturamento. Isso é necessário, pois os clientes buscarão dados de faturamento de seu banco de dados de partição específico da organização. |
| get |
URL base para obter Todos os Pools de Agentes Disponíveis + Pool de Agentes Atualmente Selecionados Esta é uma operação de apenas leitura que não requer permissões de gestão. |
| get |
Obtenha todos os detalhes dos committers faturáveis, incluindo aqueles que não correspondem a um VSID. |
| get |
Obtém a contagem de trabalhos CodeQL em execução e em fila e execuções de pipeline dinâmico em tempo de execução para a organização. |
| get |
Obtém a configuração padrão atual do calendário de configuração do CodeQL para a organização. |
| get |
Obtém a configuração padrão atual do calendário de configuração do CodeQL para a organização. |
| get |
Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este repositório. |
| get |
Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para esta organização. |
| get |
Estima os pushers que seriam adicionados à utilização do cliente se a Segurança Avançada fosse ativada para este projeto. |
| get |
|
| get |
Obtenha commiters usados ao calcular informações de faturamento. |
| get |
Obter o status atual de Segurança Avançada para a organização |
| get |
Obtenha o estado atual da Advanced Security para um projecto |
| get |
Determina se a Segurança de Código, a Proteção Secreta e seus recursos estão habilitados para o repositório. |
| update |
Atualizações Valor do Registo do Pool de Agentes Para o Pool de Agentes Selecionado Isto usa automaticamente o cliente http subjacente para pools de agentes para validar que o utilizador tem permissões para usar esse pool |
| update |
Define o dia da semana em que a análise padrão de configuração do CodeQL deve ser executada para a organização. |
| update |
Define o dia da semana em que a análise padrão de configuração do CodeQL deve ser executada para a organização. |
| update |
Atualizar o status da Segurança Avançada para a organização |
| update |
Atualize o estado da Segurança Avançada para o projecto |
| update |
Atualize o status de ativação de Segurança de Código e Proteção Secreta, juntamente com seus respetivos recursos, para um determinado repositório. |
Detalhes do Construtor
ManagementRestClient(IVssRestClientOptions)
Detalhes de Método
cancelCodeQLJobs()
Cancela todos os trabalhos CodeQL em execução e em fila e as execuções do pipeline dinâmico em tempo de funcionamento para a organização.
function cancelCodeQLJobs(): Promise<number>Devoluções
Promise<number>
createBillingSnapshot2(MeterUsageForPlan, Plan)
Durante o cálculo de faturamento de várias organizações na unidade de escala primária (EUS21), essa API é usada para criar instantâneos de faturamento para uma organização específica. A unidade de escala primária chamará essa API para cada organização em diferentes unidades scsle para criar um instantâneo de faturamento. Os dados serão armazenados na partição específica da organização DB -> tabela de instantâneo de faturamento. Isso é necessário, pois os clientes buscarão dados de faturamento de seu banco de dados de partição específico da organização.
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>Parâmetros
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Devoluções
Promise<void>
getAdvancedSecurityAgentPoolSelection()
URL base para obter Todos os Pools de Agentes Disponíveis + Pool de Agentes Atualmente Selecionados Esta é uma operação de apenas leitura que não requer permissões de gestão.
function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>Devoluções
Promise<AgentPoolDetails>
getBillableCommitterDetails2(Plan, Date)
Obtenha todos os detalhes dos committers faturáveis, incluindo aqueles que não correspondem a um VSID.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>Parâmetros
- plan
- Plan
O plano para consultar. Planos suportados: CodeSecurity e SecretProtection. Este é um parâmetro obrigatório.
- billingDate
-
Date
A data para consultar, ou se não fornecida, hoje
Devoluções
Promise<BillableCommitterDetails[]>
getCodeQLJobCount()
Obtém a contagem de trabalhos CodeQL em execução e em fila e execuções de pipeline dinâmico em tempo de execução para a organização.
function getCodeQLJobCount(): Promise<number>Devoluções
Promise<number>
getCodeQLSchedule()
Obtém a configuração padrão atual do calendário de configuração do CodeQL para a organização.
function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>Devoluções
Promise<CodeQLScheduleDetails>
getCodeQLScheduleLegacy()
Obtém a configuração padrão atual do calendário de configuração do CodeQL para a organização.
function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>Devoluções
Promise<CodeQLScheduleDetails>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este repositório.
function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>Parâmetros
- project
-
string
ID do Project ou nome do project
- repository
-
string
O nome ou ID do repositório
- plan
- Plan
O plano para consultar.
Devoluções
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para esta organização.
function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>Parâmetros
- plan
- Plan
O plano para consultar.
Devoluções
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
Estima os pushers que seriam adicionados à utilização do cliente se a Segurança Avançada fosse ativada para este projeto.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>Parâmetros
- project
-
string
ID do Project ou nome do project
- plan
- Plan
Devoluções
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>Parâmetros
- plan
- Plan
Devoluções
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
Obtenha commiters usados ao calcular informações de faturamento.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>Parâmetros
- plan
- Plan
O plano para consultar. Planos suportados: CodeSecurity e SecretProtection. Este é um parâmetro obrigatório.
- billingDate
-
Date
A data para consultar, ou se não fornecida, hoje
Devoluções
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
Obter o status atual de Segurança Avançada para a organização
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>Parâmetros
- includeAllProperties
-
boolean
Quando verdadeiro, determine também se os pushes são bloqueados se contiverem segredos
Devoluções
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
Obtenha o estado atual da Advanced Security para um projecto
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>Parâmetros
- project
-
string
ID do Project ou nome do project
- includeAllProperties
-
boolean
Quando verdadeiro, determine também se os pushes são bloqueados se contiverem segredos
Devoluções
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
Determina se a Segurança de Código, a Proteção Secreta e seus recursos estão habilitados para o repositório.
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>Parâmetros
- project
-
string
ID do Project ou nome do project
- repository
-
string
O nome ou ID do repositório
- includeAllProperties
-
boolean
Quando verdadeiro, também determinará se os pushes serão bloqueados quando segredos forem detetados
Devoluções
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
Atualizações Valor do Registo do Pool de Agentes Para o Pool de Agentes Selecionado Isto usa automaticamente o cliente http subjacente para pools de agentes para validar que o utilizador tem permissões para usar esse pool
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>Parâmetros
- agentPoolName
-
string
Devoluções
Promise<AgentPoolDetails>
updateCodeQLSchedule(number)
Define o dia da semana em que a análise padrão de configuração do CodeQL deve ser executada para a organização.
function updateCodeQLSchedule(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>Parâmetros
- scheduleDayOfWeek
-
number
Dia da semana como inteiro: 0=domingo, 1=segunda-feira, ..., 6=sábado.
Devoluções
Promise<CodeQLScheduleDetails>
updateCodeQLScheduleLegacy(number)
Define o dia da semana em que a análise padrão de configuração do CodeQL deve ser executada para a organização.
function updateCodeQLScheduleLegacy(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>Parâmetros
- scheduleDayOfWeek
-
number
Dia da semana como inteiro: 0=domingo, 1=segunda-feira, ..., 6=sábado.
Devoluções
Promise<CodeQLScheduleDetails>
updateOrgEnablementStatus2(OrgEnablementSettings)
Atualizar o status da Segurança Avançada para a organização
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>Parâmetros
- orgEnablementSettings
- OrgEnablementSettings
O novo estatuto
Devoluções
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Atualize o estado da Segurança Avançada para o projecto
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>Parâmetros
- projectEnablementSettings
- ProjectEnablementSettings
O novo estatuto
- project
-
string
ID do Project ou nome do project
Devoluções
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
Atualize o status de ativação de Segurança de Código e Proteção Secreta, juntamente com seus respetivos recursos, para um determinado repositório.
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>Parâmetros
- repoEnablementSettings
- RepoEnablementSettings
novo estatuto
- project
-
string
ID do Project ou nome do project
- repository
-
string
Nome ou ID do repositório
Devoluções
Promise<void>