Compartilhar via


ManagementRestClient class

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

Extends

Construtores

ManagementRestClient(IVssRestClientOptions)

Métodos

createBillingSnapshot(MeterUsage)

Durante a computação de cobrança de várias organizações na unidade de escala primária (EUS21), essa API é usada para criar instantâneo de cobrança 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 instantâneo de cobrança. Os dados serão armazenados na tabela de instantâneo> de partição específica da organização. Isso é necessário, pois os clientes buscarão dados de cobrança do BD de partição específico da organização.

deleteBillingInfo(string)

Exclua as informações de cobrança de uma organização.

deleteMeterUsageHistory(string)

Exclua o histórico de uso do medidor da SU primária para uma organização.

getBillableCommitterDetails(Date)

Obtenha todos os detalhes dos committers faturáveis, incluindo aqueles que não correspondem a um VSID.

getBillingInfo(string)

Obtenha as informações de cobrança de uma organização.

getEstimatedOrgBillablePushers()

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

getEstimatedProjectBillablePushers(string)

Estimar o número de committers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este projeto.

getEstimatedRepoBillableCommitters(string, string)

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

getLastMeterUsage()
getMeterUsage(Date)

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

getOrgEnablementStatus(boolean)

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

getProjectEnablementStatus(string, boolean)

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

getRepoEnablementStatus(string, string, boolean)

Determinar se a Segurança Avançada está habilitada para um repositório

saveBillingInfo(BillingInfo, string)

Salve as informações de cobrança de uma organização.

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Atualizar o status de Segurança Avançada para a organização

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

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

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Atualizar a habilitação da Segurança Avançada para um repositório

Detalhes do construtor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parâmetros

Detalhes do método

createBillingSnapshot(MeterUsage)

Durante a computação de cobrança de várias organizações na unidade de escala primária (EUS21), essa API é usada para criar instantâneo de cobrança 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 instantâneo de cobrança. Os dados serão armazenados na tabela de instantâneo> de partição específica da organização. Isso é necessário, pois os clientes buscarão dados de cobrança do BD de partição específico da organização.

function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

Parâmetros

meterUsage
MeterUsage

Retornos

Promise<void>

deleteBillingInfo(string)

Exclua as informações de cobrança de uma organização.

function deleteBillingInfo(organizationId: string): Promise<void>

Parâmetros

organizationId

string

Retornos

Promise<void>

deleteMeterUsageHistory(string)

Exclua o histórico de uso do medidor da SU primária para uma organização.

function deleteMeterUsageHistory(organizationId: string): Promise<void>

Parâmetros

organizationId

string

Retornos

Promise<void>

getBillableCommitterDetails(Date)

Obtenha todos os detalhes dos committers faturáveis, incluindo aqueles que não correspondem a um VSID.

function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>

Parâmetros

billingDate

Date

A data de consulta, ou se não for fornecida, hoje

Retornos

getBillingInfo(string)

Obtenha as informações de cobrança de uma organização.

function getBillingInfo(organizationId: string): Promise<BillingInfo>

Parâmetros

organizationId

string

ID da organização para a qual obter informações de cobrança.

Retornos

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

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

function getEstimatedOrgBillablePushers(): Promise<string[]>

Retornos

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Estimar o número de committers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para este projeto.

function getEstimatedProjectBillablePushers(project: string): Promise<string[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

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

function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID do repositório

Retornos

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Retornos

Promise<MeterUsage>

getMeterUsage(Date)

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

function getMeterUsage(billingDate?: Date): Promise<MeterUsage>

Parâmetros

billingDate

Date

A data de consulta, ou se não for fornecida, hoje

Retornos

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

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

function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parâmetros

includeAllProperties

boolean

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

Retornos

getProjectEnablementStatus(string, boolean)

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

function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parâmetros

project

string

ID do projeto ou nome do projeto

includeAllProperties

boolean

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

Retornos

getRepoEnablementStatus(string, string, boolean)

Determinar se a Segurança Avançada está habilitada para um repositório

function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>

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

saveBillingInfo(BillingInfo, string)

Salve as informações de cobrança de uma organização.

function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>

Parâmetros

billingInfo
BillingInfo
organizationId

string

Retornos

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Atualizar o status de Segurança Avançada para a organização

function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>

Parâmetros

savedAdvSecEnablementStatus
AdvSecEnablementSettingsUpdate

O novo status

Retornos

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

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

function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>

Parâmetros

savedAdvSecEnablementStatus
AdvSecEnablementSettingsUpdate

O novo status

project

string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Atualizar a habilitação da Segurança Avançada para um repositório

function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>

Parâmetros

savedAdvSecEnablementStatus
AdvSecEnablementStatusUpdate

novo status

project

string

ID do projeto ou nome do projeto

repository

string

Nome ou ID do repositório

Retornos

Promise<void>