PolicyRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Policy |
Propiedades
| RESOURCE_AREA_ID |
Métodos
| create |
Cree una configuración de directiva de un tipo de directiva determinado. |
| delete |
Elimine una configuración de directiva por su identificador. |
| get |
Obtenga una configuración de directiva por su identificador. |
| get |
Recupere una revisión específica de una directiva determinada por identificador. |
| get |
Recupere todas las revisiones de una directiva determinada. |
| get |
Obtenga una lista de configuraciones de directiva en un proyecto. |
| get |
Obtiene el estado de evaluación actual de una directiva. |
| get |
Recupera una lista de todos los estados de evaluación de directivas para una solicitud de incorporación de cambios específica. |
| get |
Recupere un tipo de directiva específico por identificador. |
| get |
Recupere todos los tipos de directiva disponibles. |
| requeue |
Vuelva a poner en cola la evaluación de la directiva. |
| update |
Actualice una configuración de directiva por su identificador. |
Detalles del constructor
PolicyRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
createPolicyConfiguration(PolicyConfiguration, string)
Cree una configuración de directiva de un tipo de directiva determinado.
function createPolicyConfiguration(configuration: PolicyConfiguration, project: string): Promise<PolicyConfiguration>Parámetros
- configuration
- PolicyConfiguration
Configuración de directiva que se va a crear.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<PolicyConfiguration>
deletePolicyConfiguration(string, number)
Elimine una configuración de directiva por su identificador.
function deletePolicyConfiguration(project: string, configurationId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- configurationId
-
number
Identificador de la configuración de directiva que se va a eliminar.
Devoluciones
Promise<void>
getPolicyConfiguration(string, number)
Obtenga una configuración de directiva por su identificador.
function getPolicyConfiguration(project: string, configurationId: number): Promise<PolicyConfiguration>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- configurationId
-
number
Identificador de la configuración de directiva
Devoluciones
Promise<PolicyConfiguration>
getPolicyConfigurationRevision(string, number, number)
Recupere una revisión específica de una directiva determinada por identificador.
function getPolicyConfigurationRevision(project: string, configurationId: number, revisionId: number): Promise<PolicyConfiguration>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- configurationId
-
number
Identificador de configuración de directiva.
- revisionId
-
number
Identificador de revisión.
Devoluciones
Promise<PolicyConfiguration>
getPolicyConfigurationRevisions(string, number, number, number)
Recupere todas las revisiones de una directiva determinada.
function getPolicyConfigurationRevisions(project: string, configurationId: number, top?: number, skip?: number): Promise<PolicyConfiguration[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- configurationId
-
number
Identificador de configuración de directiva.
- top
-
number
Número de revisiones que se van a recuperar.
- skip
-
number
Número de revisiones que se van a omitir. Por ejemplo, para recuperar los resultados 101-150, establezca top en 50 y vaya a 100.
Devoluciones
Promise<PolicyConfiguration[]>
getPolicyConfigurations(string, string, string)
Obtenga una lista de configuraciones de directiva en un proyecto.
function getPolicyConfigurations(project: string, scope?: string, policyType?: string): Promise<PagedList<PolicyConfiguration>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- scope
-
string
[Se proporciona por motivos heredados] Ámbito en el que se define un subconjunto de directivas.
- policyType
-
string
Filtrar directivas devueltas solo a este tipo
Devoluciones
Promise<PagedList<PolicyConfiguration>>
getPolicyEvaluation(string, string)
Obtiene el estado de evaluación actual de una directiva.
function getPolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- evaluationId
-
string
Identificador de la evaluación de directiva que se va a recuperar.
Devoluciones
Promise<PolicyEvaluationRecord>
getPolicyEvaluations(string, string, boolean, number, number)
Recupera una lista de todos los estados de evaluación de directivas para una solicitud de incorporación de cambios específica.
function getPolicyEvaluations(project: string, artifactId: string, includeNotApplicable?: boolean, top?: number, skip?: number): Promise<PolicyEvaluationRecord[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- artifactId
-
string
Cadena que identifica de forma única el destino de una evaluación de directiva.
- includeNotApplicable
-
boolean
Algunas directivas pueden determinar que no se aplican a una solicitud de incorporación de cambios específica. Si se establece este parámetro en true, se devolverán registros de evaluación incluso para las directivas que no se aplican a esta solicitud de incorporación de cambios.
- top
-
number
Número de registros de evaluación de directivas que se van a recuperar.
- skip
-
number
Número de registros de evaluación de directivas que se van a omitir. Por ejemplo, para recuperar los resultados 101-150, establezca top en 50 y vaya a 100.
Devoluciones
Promise<PolicyEvaluationRecord[]>
getPolicyType(string, string)
Recupere un tipo de directiva específico por identificador.
function getPolicyType(project: string, typeId: string): Promise<PolicyType>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- typeId
-
string
Identificador de directiva.
Devoluciones
Promise<PolicyType>
getPolicyTypes(string)
Recupere todos los tipos de directiva disponibles.
function getPolicyTypes(project: string): Promise<PolicyType[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<PolicyType[]>
requeuePolicyEvaluation(string, string)
Vuelva a poner en cola la evaluación de la directiva.
function requeuePolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- evaluationId
-
string
Identificador de la evaluación de directiva que se va a recuperar.
Devoluciones
Promise<PolicyEvaluationRecord>
updatePolicyConfiguration(PolicyConfiguration, string, number)
Actualice una configuración de directiva por su identificador.
function updatePolicyConfiguration(configuration: PolicyConfiguration, project: string, configurationId: number): Promise<PolicyConfiguration>Parámetros
- configuration
- PolicyConfiguration
Configuración de directiva que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- configurationId
-
number
Identificador de la configuración de directiva existente que se va a actualizar.
Devoluciones
Promise<PolicyConfiguration>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de