ManagementRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

ManagementRestClient(IVssRestClientOptions)

Métodos

createBillingSnapshot(MeterUsage)	Durante a computação de faturação multi-organizações na unidade de escala primária (EUS21), esta API é utilizada para criar um instantâneo de faturação para uma organização específica. A unidade de escala primária irá chamar esta API para cada organização em unidades scsle diferentes para criar o instantâneo de faturação. Os dados serão armazenados na base de dados da partição específica da organização –> tabela de instantâneos de faturação. Isto é necessário, uma vez que os clientes irão obter dados de faturação da base de dados de partição específica da organização.
deleteBillingInfo(string)	Elimine as informações de faturação de uma organização.
deleteMeterUsageHistory(string)	Elimine o histórico de utilização do medidor da SU Primária de uma organização.
getBillableCommitterDetails(Date)	Obtenha todos os detalhes dos consolidadores faturáveis, incluindo os que não correspondem a um VSID.
getBillingInfo(string)	Obtenha as informações de faturação de uma organização.
getEstimatedOrgBillablePushers()	Calcule os consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para esta organização.
getEstimatedProjectBillablePushers(string)	Calcule o número de consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para este projeto.
getEstimatedRepoBillableCommitters(string, string)	Calcule os consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para este repositório.
getLastMeterUsage()
getMeterUsage(Date)	Obter consolidadores utilizados ao calcular informações de faturação.
getOrgEnablementStatus(boolean)	Obter o estado atual da Segurança Avançada para a organização
getProjectEnablementStatus(string, boolean)	Obter o estado atual da Segurança Avançada para um projeto
getRepoEnablementStatus(string, string, boolean)	Determinar se a Segurança Avançada está ativada para um repositório
saveBillingInfo(BillingInfo, string)	Guarde as informações de faturação de uma organização.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Atualizar o estado da Segurança Avançada para a organização
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Atualizar o estado da Segurança Avançada para o projeto
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Atualizar a ativação da Segurança Avançada para um repositório

Detalhes do Construtor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

createBillingSnapshot(MeterUsage)

Durante a computação de faturação multi-organizações na unidade de escala primária (EUS21), esta API é utilizada para criar um instantâneo de faturação para uma organização específica. A unidade de escala primária irá chamar esta API para cada organização em unidades scsle diferentes para criar o instantâneo de faturação. Os dados serão armazenados na base de dados da partição específica da organização –> tabela de instantâneos de faturação. Isto é necessário, uma vez que os clientes irão obter dados de faturação da base de dados de partição específica da organização.

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

Parâmetros

meterUsage

MeterUsage

Devoluções

Promise<void>

deleteBillingInfo(string)

Elimine as informações de faturação de uma organização.

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

Parâmetros

organizationId

string

Devoluções

Promise<void>

deleteMeterUsageHistory(string)

Elimine o histórico de utilização do medidor da SU Primária de uma organização.

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

Parâmetros

organizationId

string

Devoluções

Promise<void>

getBillableCommitterDetails(Date)

Obtenha todos os detalhes dos consolidadores faturáveis, incluindo os 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

Devoluções

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

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

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

Parâmetros

organizationId

string

ID da organização para obter informações de faturação.

Devoluções

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Calcule os consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para esta organização.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Devoluções

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Calcule o número de consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para este projeto.

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

Parâmetros

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Calcule os consolidadores que seriam adicionados à utilização do cliente se a Segurança Avançada estivesse ativada para este 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 ID do repositório

Devoluções

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Devoluções

Promise<MeterUsage>

getMeterUsage(Date)

Obter consolidadores utilizados ao calcular informações de faturação.

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

Parâmetros

billingDate

Date

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

Devoluções

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

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

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

Parâmetros

includeAllProperties

boolean

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

Devoluções

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Obter o estado atual da 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 verdadeiro, determine também se os pushes são bloqueados se contêm segredos

Devoluções

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Determinar se a Segurança Avançada está ativada 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 ID do repositório

includeAllProperties

boolean

Quando verdadeiro, também determina se os pushes são bloqueados quando os segredos são detetados

Devoluções

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Guarde as informações de faturação de uma organização.

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

Parâmetros

billingInfo

BillingInfo

organizationId

string

Devoluções

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Atualizar o estado da Segurança Avançada para a organização

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

Parâmetros

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

O novo estado

Devoluções

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

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

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

Parâmetros

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

O novo estado

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Atualizar a ativaçã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 estado

project

string

ID do Projeto ou nome do projeto

repository

string

Nome ou ID do repositório

Devoluções

Promise<void>