PolicyRestClient 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

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)	Exclua uma configuração de política por sua ID.
getPolicyConfiguration(string, number)	Obtenha uma configuração de política pelo seu ID.
getPolicyConfigurationRevision(string, number, number)	Recupere uma revisão específica de uma determinada política por ID.
getPolicyConfigurationRevisions(string, number, number, number)	Recupere todas as revisões de uma determinada política.
getPolicyConfigurations(string, string, string)	Obtenha uma lista de configurações de política em um projeto.
getPolicyEvaluation(string, string)	Obtém o estado atual da avaliação de uma política.
getPolicyEvaluations(string, string, boolean, number, number)	Recupera uma lista de todos os status de avaliação de política para uma solicitação pull específica.
getPolicyType(string, string)	Recupere um tipo de política específico por ID.
getPolicyTypes(string)	Recupere todos os tipos de política disponíveis.
requeuePolicyEvaluation(string, string)	Recoloque a avaliação da política na fila novamente.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Atualize uma configuração de política por sua 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 de política a ser criada.

project

string

ID do projeto ou nome do projeto

Devoluções

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Exclua uma configuração de política por sua 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 ser excluída.

Devoluções

Promise<void>

getPolicyConfiguration(string, number)

Obtenha uma configuração de política pelo seu 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)

Recupere 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 da revisão.

Devoluções

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

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

skip

number

O número de revisões a serem ignoradas. Por exemplo, para recuperar os resultados 101-150, defina como 50 e pule para 100.

Devoluções

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Obtenha uma lista de configurações de política em um 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 razões legadas] O âmbito em que é definido um subconjunto de políticas.

policyType

string

Filtrar políticas retornadas apenas para este tipo

Devoluções

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Obtém o estado atual da avaliação 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 ser recuperada.

Devoluções

Promise<PolicyEvaluationRecord>

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

Recupera uma lista de todos os status de avaliação de política para uma solicitação pull específica.

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 de caracteres que identifica exclusivamente o alvo de uma avaliação de política.

includeNotApplicable

boolean

Algumas políticas podem determinar que elas não se aplicam a uma solicitação pull específica. Definir esse parâmetro como true retornará registros de avaliação mesmo para políticas que não se aplicam a essa solicitação pull.

top

number

O número de registros de avaliação de política a serem recuperados.

skip

number

O número de registros de avaliação de política a serem ignorados. Por exemplo, para recuperar os resultados 101-150, defina como 50 e pule para 100.

Devoluções

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

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

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

Recoloque a avaliação da política na fila novamente.

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

Devoluções

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Atualize uma configuração de política por sua ID.

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

Parâmetros

configuration

PolicyConfiguration

A configuração da política a ser atualizada.

project

string

ID do projeto ou nome do projeto

configurationId

number

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

Devoluções

Promise<PolicyConfiguration>