ManagementRestClient 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

ManagementRestClient(IVssRestClientOptions)

Métodos

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 um instantâneo 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 cobrança. Os dados serão armazenados na tabela de snapshot de faturamento do banco de dados> da partição específica da organização. Isso é necessário, pois os clientes buscarão dados de faturamento do banco de dados de partição específico da organização.
getBillableCommitterDetails2(Plan, Date)	Obtenha todos os detalhes dos committers faturáveis, incluindo aqueles que não correspondem a um VSID.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para esse repositório.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para essa organização.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Estimar os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este projeto.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Obtenha confirmadores usados ao calcular informações de cobrança.
getOrgEnablementStatus2(boolean)	Obter o status atual da Segurança Avançada para a organização
getProjectEnablementStatus2(string, boolean)	Obter o status atual da Segurança Avançada para um projeto
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.
updateOrgEnablementStatus2(OrgEnablementSettings)	Atualizar o status da Segurança Avançada para a organização
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Atualizar o status da Segurança Avançada para o projeto
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Atualize o status de habilitação da Segurança de Código e proteção secreta, juntamente com seus respectivos recursos, para um determinado repositório.

Detalhes do construtor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

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 um instantâneo 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 cobrança. Os dados serão armazenados na tabela de snapshot de faturamento do banco de dados> da partição específica da organização. Isso é necessário, pois os clientes buscarão dados de faturamento do 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

Retornos

Promise<void>

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 a ser consultado. Planos com suporte: CodeSecurity e SecretProtection. Esse parâmetro é obrigatório.

billingDate

Date

A data para consultar, ou se não for fornecida, hoje

Retornos

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para esse repositório.

function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID do repositório

plan

Plan

O plano a ser consultado.

Retornos

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para essa organização.

function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

Parâmetros

plan

Plan

O plano a ser consultado.

Retornos

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Estimar os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este projeto.

function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>

Parâmetros

project

string

ID do projeto ou nome do projeto

plan

Plan

Retornos

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

Parâmetros

plan

Plan

Retornos

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Obtenha confirmadores usados ao calcular informações de cobrança.

function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>

Parâmetros

plan

Plan

O plano a ser consultado. Planos com suporte: CodeSecurity e SecretProtection. Esse parâmetro é obrigatório.

billingDate

Date

A data para consultar, ou se não for fornecida, hoje

Retornos

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

Obter o status atual da Segurança Avançada para a organização

function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>

Parâmetros

includeAllProperties

boolean

Quando true, também determine se os pushes são bloqueados se eles contêm segredos

Retornos

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Obter o status atual da Segurança Avançada para um projeto

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

Parâmetros

project

string

ID do projeto ou nome do projeto

includeAllProperties

boolean

Quando true, também determine se os pushes são bloqueados se eles contêm segredos

Retornos

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 projeto ou nome do projeto

repository

string

O nome ou a ID do repositório

includeAllProperties

boolean

Quando true, também determinará se os pushes são bloqueados quando os segredos são detectados

Retornos

Promise<RepoEnablementSettings>

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 status

Retornos

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Atualizar o status da Segurança Avançada para o projeto

function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>

Parâmetros

projectEnablementSettings

ProjectEnablementSettings

O novo status

project

string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Atualize o status de habilitação da Segurança de Código e proteção secreta, juntamente com seus respectivos recursos, para um determinado repositório.

function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parâmetros

repoEnablementSettings

RepoEnablementSettings

Novo status

project

string

ID do projeto ou nome do projeto

repository

string

Nome ou ID do repositório

Retornos

Promise<void>