ManagementRestClient class

Pacote:

azure-devops-extension-api

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

Estende

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 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.
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.
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 este repositório.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Estime os pushers que seriam adicionados ao uso do cliente se a Segurança Avançada estivesse habilitada para esta organização.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Estima os pushers que seriam adicionados à utilização do cliente se a Segurança Avançada fosse ativada para este projeto.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Obtenha commiters usados ao calcular informações de faturamento.
getOrgEnablementStatus2(boolean)	Obter o status atual de Segurança Avançada para a organização
getProjectEnablementStatus2(string, boolean)	Obtenha o estado atual da Advanced Security para um projecto
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.
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
updateOrgEnablementStatus2(OrgEnablementSettings)	Atualizar o status da Segurança Avançada para a organização
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Atualize o estado da Segurança Avançada para o projecto
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.

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 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

Regressos

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>

Regressos

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

Regressos

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 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.

Regressos

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.

Regressos

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

Regressos

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Parâmetros

plan

Plan

Regressos

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

Regressos

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

Regressos

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

Regressos

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

Regressos

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

Regressos

Promise<AgentPoolDetails>

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

Regressos

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

Regressos

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

Regressos

Promise<void>