PolicyRestClient 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

PolicyRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createPolicyConfiguration(PolicyConfiguration, string)	Crie uma configuração de política de um determinado tipo de política.
deletePolicyConfiguration(string, number)	Elimine uma configuração de política pelo respetivo ID.
getPolicyConfiguration(string, number)	Obtenha uma configuração de política pelo respetivo ID.
getPolicyConfigurationRevision(string, number, number)	Obtenha uma revisão específica de uma determinada política por ID.
getPolicyConfigurationRevisions(string, number, number, number)	Obter todas as revisões de uma determinada política.
getPolicyConfigurations(string, string, string)	Obtenha uma lista de configurações de políticas num projeto.
getPolicyEvaluation(string, string)	Obtém o estado de avaliação atual de uma política.
getPolicyEvaluations(string, string, boolean, number, number)	Obtém uma lista de todos os estados de avaliação de políticas para um pedido Pull específico.
getPolicyType(string, string)	Obter um tipo de política específico por ID.
getPolicyTypes(string)	Obtenha todos os tipos de política disponíveis.
requeuePolicyEvaluation(string, string)	Reconsulte a avaliação da política.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Atualize uma configuração de política pelo respetivo ID.

Detalhes do Construtor

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createPolicyConfiguration(PolicyConfiguration, string)

Crie uma configuração de política de um determinado tipo de política.

function createPolicyConfiguration(configuration: PolicyConfiguration, project: string): Promise<PolicyConfiguration>

Parâmetros

configuration

PolicyConfiguration

A configuração da política a criar.

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Elimine uma configuração de política pelo respetivo ID.

function deletePolicyConfiguration(project: string, configurationId: number): Promise<void>

Parâmetros

project

string

ID do Projeto ou nome do projeto

configurationId

number

ID da configuração da política a eliminar.

Devoluções

Promise<void>

getPolicyConfiguration(string, number)

Obtenha uma configuração de política pelo respetivo ID.

function getPolicyConfiguration(project: string, configurationId: number): Promise<PolicyConfiguration>

Parâmetros

project

string

ID do Projeto ou nome do projeto

configurationId

number

ID da configuração da política

Devoluções

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Obtenha uma revisão específica de uma determinada política por ID.

function getPolicyConfigurationRevision(project: string, configurationId: number, revisionId: number): Promise<PolicyConfiguration>

Parâmetros

project

string

ID do Projeto ou nome do projeto

configurationId

number

O ID de configuração da política.

revisionId

number

O ID de revisão.

Devoluções

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Obter todas as revisões de uma determinada política.

function getPolicyConfigurationRevisions(project: string, configurationId: number, top?: number, skip?: number): Promise<PolicyConfiguration[]>

Parâmetros

project

string

ID do Projeto ou nome do projeto

configurationId

number

O ID de configuração da política.

top

number

O número de revisões a obter.

skip

number

O número de revisões a ignorar. Por exemplo, para obter resultados 101-150, defina a parte superior como 50 e avance para 100.

Devoluções

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Obtenha uma lista de configurações de políticas num projeto.

function getPolicyConfigurations(project: string, scope?: string, policyType?: string): Promise<PagedList<PolicyConfiguration>>

Parâmetros

project

string

ID do Projeto ou nome do projeto

scope

string

[Fornecido por motivos legados] O âmbito no qual é definido um subconjunto de políticas.

policyType

string

O filtro devolveu políticas apenas a este tipo

Devoluções

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Obtém o estado de avaliação atual de uma política.

function getPolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>

Parâmetros

project

string

ID do Projeto ou nome do projeto

evaluationId

string

ID da avaliação da política a obter.

Devoluções

Promise<PolicyEvaluationRecord>

getPolicyEvaluations(string, string, boolean, number, number)

Obtém uma lista de todos os estados de avaliação de políticas para um pedido Pull específico.

function getPolicyEvaluations(project: string, artifactId: string, includeNotApplicable?: boolean, top?: number, skip?: number): Promise<PolicyEvaluationRecord[]>

Parâmetros

project

string

ID do Projeto ou nome do projeto

artifactId

string

Uma cadeia que identifica exclusivamente o destino de uma avaliação de política.

includeNotApplicable

boolean

Algumas políticas podem determinar que não se aplicam a um pedido Pull específico. Definir este parâmetro como verdadeiro irá devolver registos de avaliação mesmo para políticas que não se aplicam a este pedido Pull.

top

number

O número de registos de avaliação de políticas a obter.

skip

number

O número de registos de avaliação de políticas a ignorar. Por exemplo, para obter resultados 101-150, defina a parte superior como 50 e avance para 100.

Devoluções

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Obter um tipo de política específico por ID.

function getPolicyType(project: string, typeId: string): Promise<PolicyType>

Parâmetros

project

string

ID do Projeto ou nome do projeto

typeId

string

O ID da política.

Devoluções

Promise<PolicyType>

getPolicyTypes(string)

Obtenha todos os tipos de política disponíveis.

function getPolicyTypes(project: string): Promise<PolicyType[]>

Parâmetros

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Reconsulte a avaliação da política.

function requeuePolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>

Parâmetros

project

string

ID do Projeto ou nome do projeto

evaluationId

string

ID da avaliação da política a obter.

Devoluções

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Atualize uma configuração de política pelo respetivo ID.

function updatePolicyConfiguration(configuration: PolicyConfiguration, project: string, configurationId: number): Promise<PolicyConfiguration>

Parâmetros

configuration

PolicyConfiguration

A configuração da política a atualizar.

project

string

ID do Projeto ou nome do projeto

configurationId

number

ID da configuração de política existente a atualizar.

Devoluções

Promise<PolicyConfiguration>