PolicyRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Policy |
Propriedades
| RESOURCE_AREA_ID |
Métodos
| create |
Crie uma configuração de política de um determinado tipo de política. |
| delete |
Exclua uma configuração de política por sua ID. |
| get |
Obtenha uma configuração de política por sua ID. |
| get |
Recupere uma revisão específica de uma determinada política por ID. |
| get |
Recupere todas as revisões de uma determinada política. |
| get |
Obtenha uma lista de configurações de política em um projeto. |
| get |
Obtém o estado de avaliação atual de uma política. |
| get |
Recupera uma lista de todos os status de avaliação de política para uma solicitação de pull específica. |
| get |
Recupere um tipo de política específico por ID. |
| get |
Recuperar todos os tipos de política disponíveis. |
| requeue |
Enfileirar novamente a avaliação da política. |
| update |
Atualize uma configuração de política por sua ID. |
Detalhes do construtor
PolicyRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do 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
Retornos
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 de política a ser excluída.
Retornos
Promise<void>
getPolicyConfiguration(string, number)
Obtenha uma configuração de política por sua 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
Retornos
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
A ID de configuração da política.
- revisionId
-
number
A ID de revisão.
Retornos
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
A ID de configuração da política.
- top
-
number
O número de revisões a serem recuperadas.
- skip
-
number
O número de revisões a serem ignoradas. Por exemplo, para recuperar os resultados de 101 a 150, defina a parte superior como 50 e pule para 100.
Retornos
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 motivos herdados] O escopo no qual um subconjunto de políticas é definido.
- policyType
-
string
Filtrar políticas retornadas apenas para esse tipo
Retornos
Promise<PagedList<PolicyConfiguration>>
getPolicyEvaluation(string, string)
Obtém o estado de avaliação atual 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.
Retornos
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 de 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 destino de uma avaliação de política.
- includeNotApplicable
-
boolean
Algumas políticas podem determinar que elas não se aplicam a uma solicitação de 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 de 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 de 101 a 150, defina a parte superior como 50 e pule para 100.
Retornos
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
A ID da política.
Retornos
Promise<PolicyType>
getPolicyTypes(string)
Recuperar 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
Retornos
Promise<PolicyType[]>
requeuePolicyEvaluation(string, string)
Enfileirar novamente a avaliação da política.
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.
Retornos
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 de 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.
Retornos
Promise<PolicyConfiguration>
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de