PolicyRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS
- Extends
Costruttori
| Policy |
Proprietà
| RESOURCE_AREA_ID |
Metodi
| create |
Creare una configurazione dei criteri di un determinato tipo di criterio. |
| delete |
Eliminare una configurazione dei criteri in base al relativo ID. |
| get |
Ottenere una configurazione dei criteri in base all'ID. |
| get |
Recuperare una revisione specifica di un determinato criterio in base all'ID. |
| get |
Recuperare tutte le revisioni per un determinato criterio. |
| get |
Ottenere un elenco di configurazioni dei criteri in un progetto. |
| get |
Ottiene lo stato di valutazione corrente di un criterio. |
| get |
Recupera un elenco di tutti gli stati di valutazione dei criteri per una richiesta pull specifica. |
| get |
Recuperare un tipo di criterio specifico in base all'ID. |
| get |
Recuperare tutti i tipi di criteri disponibili. |
| requeue |
Ripetere la valutazione dei criteri. |
| update |
Aggiornare una configurazione dei criteri in base all'ID. |
Dettagli costruttore
PolicyRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValore della proprietà
string
Dettagli metodo
createPolicyConfiguration(PolicyConfiguration, string)
Creare una configurazione dei criteri di un determinato tipo di criterio.
function createPolicyConfiguration(configuration: PolicyConfiguration, project: string): Promise<PolicyConfiguration>Parametri
- configuration
- PolicyConfiguration
Configurazione dei criteri da creare.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<PolicyConfiguration>
deletePolicyConfiguration(string, number)
Eliminare una configurazione dei criteri in base al relativo ID.
function deletePolicyConfiguration(project: string, configurationId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- configurationId
-
number
ID della configurazione dei criteri da eliminare.
Restituisce
Promise<void>
getPolicyConfiguration(string, number)
Ottenere una configurazione dei criteri in base all'ID.
function getPolicyConfiguration(project: string, configurationId: number): Promise<PolicyConfiguration>Parametri
- project
-
string
ID progetto o nome progetto
- configurationId
-
number
ID della configurazione dei criteri
Restituisce
Promise<PolicyConfiguration>
getPolicyConfigurationRevision(string, number, number)
Recuperare una revisione specifica di un determinato criterio in base all'ID.
function getPolicyConfigurationRevision(project: string, configurationId: number, revisionId: number): Promise<PolicyConfiguration>Parametri
- project
-
string
ID progetto o nome progetto
- configurationId
-
number
ID di configurazione dei criteri.
- revisionId
-
number
ID revisione.
Restituisce
Promise<PolicyConfiguration>
getPolicyConfigurationRevisions(string, number, number, number)
Recuperare tutte le revisioni per un determinato criterio.
function getPolicyConfigurationRevisions(project: string, configurationId: number, top?: number, skip?: number): Promise<PolicyConfiguration[]>Parametri
- project
-
string
ID progetto o nome progetto
- configurationId
-
number
ID di configurazione dei criteri.
- top
-
number
Numero di revisioni da recuperare.
- skip
-
number
Numero di revisioni da ignorare. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.
Restituisce
Promise<PolicyConfiguration[]>
getPolicyConfigurations(string, string, string)
Ottenere un elenco di configurazioni dei criteri in un progetto.
function getPolicyConfigurations(project: string, scope?: string, policyType?: string): Promise<PagedList<PolicyConfiguration>>Parametri
- project
-
string
ID progetto o nome progetto
- scope
-
string
[Fornito per motivi legacy] Ambito in cui viene definito un subset di criteri.
- policyType
-
string
Filtrare i criteri restituiti solo per questo tipo
Restituisce
Promise<PagedList<PolicyConfiguration>>
getPolicyEvaluation(string, string)
Ottiene lo stato di valutazione corrente di un criterio.
function getPolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>Parametri
- project
-
string
ID progetto o nome progetto
- evaluationId
-
string
ID della valutazione dei criteri da recuperare.
Restituisce
Promise<PolicyEvaluationRecord>
getPolicyEvaluations(string, string, boolean, number, number)
Recupera un elenco di tutti gli stati di valutazione dei criteri per una richiesta pull specifica.
function getPolicyEvaluations(project: string, artifactId: string, includeNotApplicable?: boolean, top?: number, skip?: number): Promise<PolicyEvaluationRecord[]>Parametri
- project
-
string
ID progetto o nome progetto
- artifactId
-
string
Stringa che identifica in modo univoco la destinazione di una valutazione dei criteri.
- includeNotApplicable
-
boolean
Alcuni criteri potrebbero determinare che non si applicano a una richiesta pull specifica. L'impostazione di questo parametro su true restituirà i record di valutazione anche per i criteri che non si applicano a questa richiesta pull.
- top
-
number
Numero di record di valutazione dei criteri da recuperare.
- skip
-
number
Numero di record di valutazione dei criteri da ignorare. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.
Restituisce
Promise<PolicyEvaluationRecord[]>
getPolicyType(string, string)
Recuperare un tipo di criterio specifico in base all'ID.
function getPolicyType(project: string, typeId: string): Promise<PolicyType>Parametri
- project
-
string
ID progetto o nome progetto
- typeId
-
string
ID criterio.
Restituisce
Promise<PolicyType>
getPolicyTypes(string)
Recuperare tutti i tipi di criteri disponibili.
function getPolicyTypes(project: string): Promise<PolicyType[]>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<PolicyType[]>
requeuePolicyEvaluation(string, string)
Ripetere la valutazione dei criteri.
function requeuePolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>Parametri
- project
-
string
ID progetto o nome progetto
- evaluationId
-
string
ID della valutazione dei criteri da recuperare.
Restituisce
Promise<PolicyEvaluationRecord>
updatePolicyConfiguration(PolicyConfiguration, string, number)
Aggiornare una configurazione dei criteri in base all'ID.
function updatePolicyConfiguration(configuration: PolicyConfiguration, project: string, configurationId: number): Promise<PolicyConfiguration>Parametri
- configuration
- PolicyConfiguration
Configurazione dei criteri da aggiornare.
- project
-
string
ID progetto o nome progetto
- configurationId
-
number
ID della configurazione dei criteri esistente da aggiornare.
Restituisce
Promise<PolicyConfiguration>
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per