Interface IPolicyApi

interface IPolicyApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createPolicyConfiguration(
        configuration: PolicyConfiguration,
        project: string,
    ): Promise<PolicyConfiguration>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deletePolicyConfiguration(
        project: string,
        configurationId: number,
    ): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getPolicyConfiguration(
        project: string,
        configurationId: number,
    ): Promise<PolicyConfiguration>;
    getPolicyConfigurationRevision(
        project: string,
        configurationId: number,
        revisionId: number,
    ): Promise<PolicyConfiguration>;
    getPolicyConfigurationRevisions(
        project: string,
        configurationId: number,
        top?: number,
        skip?: number,
    ): Promise<PolicyConfiguration[]>;
    getPolicyConfigurations(
        project: string,
        scope?: string,
        policyType?: string,
    ): Promise<PagedList<PolicyConfiguration>>;
    getPolicyEvaluation(
        project: string,
        evaluationId: string,
    ): Promise<PolicyEvaluationRecord>;
    getPolicyEvaluations(
        project: string,
        artifactId: string,
        includeNotApplicable?: boolean,
        top?: number,
        skip?: number,
    ): Promise<PolicyEvaluationRecord[]>;
    getPolicyType(project: string, typeId: string): Promise<PolicyType>;
    getPolicyTypes(project: string): Promise<PolicyType[]>;
    requeuePolicyEvaluation(
        project: string,
        evaluationId: string,
    ): Promise<PolicyEvaluationRecord>;
    updatePolicyConfiguration(
        configuration: PolicyConfiguration,
        project: string,
        configurationId: number,
    ): Promise<PolicyConfiguration>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createPolicyConfiguration createRequestOptions deletePolicyConfiguration formatResponse getPolicyConfiguration getPolicyConfigurationRevision getPolicyConfigurationRevisions getPolicyConfigurations getPolicyEvaluation getPolicyEvaluations getPolicyType getPolicyTypes requeuePolicyEvaluation updatePolicyConfiguration

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createPolicyConfiguration

createRequestOptions

deletePolicyConfiguration

formatResponse

getPolicyConfiguration

getPolicyConfigurationRevision

getPolicyConfigurationRevisions

getPolicyConfigurations

getPolicyEvaluation

getPolicyEvaluations

getPolicyType

getPolicyTypes

requeuePolicyEvaluation

updatePolicyConfiguration

Settings

Member Visibility

On This Page

Properties
Methods