PolicyRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

PolicyRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createPolicyConfiguration(PolicyConfiguration, string)	Créez une configuration de stratégie d’un type de stratégie donné.
deletePolicyConfiguration(string, number)	Supprimez une configuration de stratégie par son ID.
getPolicyConfiguration(string, number)	Obtenez une configuration de stratégie à l’aide de son ID.
getPolicyConfigurationRevision(string, number, number)	Récupérer une révision spécifique d’une politique donnée par ID.
getPolicyConfigurationRevisions(string, number, number, number)	Récupérez toutes les révisions d’une politique donnée.
getPolicyConfigurations(string, string, string)	Obtenez la liste des configurations de stratégie d’un projet.
getPolicyEvaluation(string, string)	Obtient l’état d’évaluation actuel d’une stratégie.
getPolicyEvaluations(string, string, boolean, number, number)	Récupère une liste de tous les statuts d’évaluation de politique pour une demande de tirage spécifique.
getPolicyType(string, string)	Récupérez un type de stratégie spécifique par ID.
getPolicyTypes(string)	Récupérez tous les types de stratégies disponibles.
requeuePolicyEvaluation(string, string)	Remettez en file d’attente l’évaluation de la stratégie.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Mettre à jour une configuration de stratégie à l’aide de son ID.

Détails du constructeur

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createPolicyConfiguration(PolicyConfiguration, string)

Créez une configuration de stratégie d’un type de stratégie donné.

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

Paramètres

configuration

PolicyConfiguration

Configuration de la stratégie à créer.

project

string

ID de projet ou nom du projet

Retours

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Supprimez une configuration de stratégie par son ID.

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

Paramètres

project

string

ID de projet ou nom du projet

configurationId

number

ID de la configuration de stratégie à supprimer.

Retours

Promise<void>

getPolicyConfiguration(string, number)

Obtenez une configuration de stratégie à l’aide de son ID.

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

Paramètres

project

string

ID de projet ou nom du projet

configurationId

number

ID de la configuration de la stratégie

Retours

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Récupérer une révision spécifique d’une politique donnée par ID.

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

Paramètres

project

string

ID de projet ou nom du projet

configurationId

number

ID de configuration de la stratégie.

revisionId

number

ID de révision.

Retours

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Récupérez toutes les révisions d’une politique donnée.

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

Paramètres

project

string

ID de projet ou nom du projet

configurationId

number

ID de configuration de la stratégie.

top

number

Le nombre de révisions à récupérer.

skip

number

Le nombre de révisions à ignorer. Par exemple, pour récupérer les résultats 101-150, définissez la valeur supérieure à 50 et passez à 100.

Retours

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Obtenez la liste des configurations de stratégie d’un projet.

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

Paramètres

project

string

ID de projet ou nom du projet

scope

string

[Fourni pour des raisons d’héritage] Étendue sur laquelle un sous-ensemble de stratégies est défini.

policyType

string

Filtrez les stratégies renvoyées pour n’afficher que ce type

Retours

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Obtient l’état d’évaluation actuel d’une stratégie.

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

Paramètres

project

string

ID de projet ou nom du projet

evaluationId

string

ID de l’évaluation de la politique à récupérer.

Retours

Promise<PolicyEvaluationRecord>

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

Récupère une liste de tous les statuts d’évaluation de politique pour une demande de tirage spécifique.

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

Paramètres

project

string

ID de projet ou nom du projet

artifactId

string

Chaîne qui identifie de manière unique la cible d’une évaluation de politique.

includeNotApplicable

boolean

Certaines stratégies peuvent déterminer qu’elles ne s’appliquent pas à une demande de tirage spécifique. La définition de ce paramètre sur true renverra des enregistrements d’évaluation, même pour les stratégies qui ne s’appliquent pas à cette demande de tirage.

top

number

Nombre d’enregistrements d’évaluation de stratégie à récupérer.

skip

number

Nombre d’enregistrements d’évaluation de politique à ignorer. Par exemple, pour récupérer les résultats 101-150, définissez la valeur supérieure à 50 et passez à 100.

Retours

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Récupérez un type de stratégie spécifique par ID.

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

Paramètres

project

string

ID de projet ou nom du projet

typeId

string

L’ID de la stratégie.

Retours

Promise<PolicyType>

getPolicyTypes(string)

Récupérez tous les types de stratégies disponibles.

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

Paramètres

project

string

ID de projet ou nom du projet

Retours

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Remettez en file d’attente l’évaluation de la stratégie.

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

Paramètres

project

string

ID de projet ou nom du projet

evaluationId

string

ID de l’évaluation de la politique à récupérer.

Retours

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Mettre à jour une configuration de stratégie à l’aide de son ID.

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

Paramètres

configuration

PolicyConfiguration

Configuration de la stratégie à mettre à jour.

project

string

ID de projet ou nom du projet

configurationId

number

ID de la configuration de stratégie existante à mettre à jour.

Retours

Promise<PolicyConfiguration>