TaskAgentRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends: RestClientBase

Construtores

TaskAgentRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addAgent(TaskAgent, number)	Adiciona um agente a um pool. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, configure um agente usando o pacote de download do agente.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create um pool de agentes.
addAgentQueue(TaskAgentQueue, string, boolean)	Create uma nova fila de agentes para conectar um projeto a um pool de agentes.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create um grupo de implantação.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registre um destino de implantação em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.
addEnvironment(EnvironmentCreateParameter, string)	Criar um ambiente.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create um grupo de tarefas.
addVariableGroup(VariableGroupParameters)	Adicione um grupo de variáveis.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create um novo projeto de equipe.
deleteAgent(number, number)	Exclua um agente. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, use o script de configuração do agente para remover um agente da sua organização.
deleteAgentCloud(number)
deleteAgentPool(number)	Excluir um pool de agentes.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Remove uma fila de agentes de um projeto.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Excluir um grupo de implantação.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Exclua um destino de implantação em um grupo de implantação. Isso também exclui o agente do pool de implantação associado.
deleteEnvironment(string, number)	Exclua o ambiente especificado.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Excluir um arquivo seguro
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Excluir um grupo de tarefas.
deleteVariableGroup(number, string[])	Excluir um grupo de variáveis
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Baixar um arquivo seguro por ID
generateDeploymentGroupAccessToken(string, number)	OBTENHA um token PAT para gerenciar destinos de implantação (configuração, remoção, marcação) em um grupo de implantação.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	OBTENHA um token PAT para gerenciar (configurar, remover, marcar) agentes de implantação em um pool de implantação.
getAgent(number, number, boolean, boolean, boolean, string[])	Obter informações sobre um agente.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Obter tipos de nuvem do agente.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Obter informações sobre um pool de agentes.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Obtenha uma lista de pools de agentes.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Obtenha uma lista de pools de agentes.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Obter informações sobre uma fila de agentes.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Obtenha uma lista de filas de agentes.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Obter uma lista de filas de agentes por suas IDs
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Obter uma lista de filas de agentes por seus nomes
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Obter uma lista de filas de agentes por IDs de pool
getAgentRequest(number, number, boolean)
getAgentRequests(number, number, string)
getAgentRequestsForAgent(number, number, number)
getAgentRequestsForAgents(number, number[], number)
getAgentRequestsForDeploymentMachine(string, number, number, number)
getAgentRequestsForDeploymentMachines(string, number, number[], number)
getAgentRequestsForDeploymentTarget(string, number, number, number)	Obtenha solicitações de agente para um destino de implantação.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Obtenha solicitações de agente para uma lista de destinos de implantação.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Obtenha uma lista de agentes.
getAzureManagementGroups()	Retorna a lista de assinaturas do Azure
getAzureSubscriptions()	Retorna a lista de assinaturas do Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Obtenha um grupo de implantação por sua ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Obtenha uma lista de grupos de implantação por nome ou IDs.
getDeploymentGroupsMetrics(string, string, string, number)	Obtenha uma lista de métricas do grupo de implantação.
getDeploymentMachine(string, number, number, DeploymentMachineExpands)
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
getDeploymentMachineGroupMachines(string, number, string[])
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])	Obtenha uma lista de resumos do pool de implantação.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Obter um destino de implantação por sua ID em um grupo de implantação
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Obtenha uma lista de destinos de implantação em um grupo de implantação.
getEnvironmentById(string, number, EnvironmentExpands)	Obtenha um ambiente por sua ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Obter histórico de execução de implantação de ambiente
getEnvironments(string, string, string, number)	Obter todos os ambientes.
getKubernetesResource(string, number, number)
getMessage(number, string, number)
getPackage(string, string, string)
getPackages(string, string, number)
getResourceLimits()
getResourceUsage(string, boolean, boolean)
getSecureFile(string, string, boolean, SecureFileActionFilter)	Obter um arquivo seguro
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Obter arquivos seguros
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Obter arquivos seguros
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Obter arquivos seguros
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Obter grupo de tarefas.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Listar grupos de tarefas.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Obter um grupo de variáveis.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Obter grupos de variáveis.
getVariableGroupsById(string, number[], boolean)	Obter grupos de variáveis por IDs.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	OBTER o esquema Yaml usado para validação de arquivo Yaml.
hasPoolPermissions(number, number)	Verifica se a identidade atual passou permissões em um pool.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy para uma solicitação GET definida por um 'ponto de extremidade'. A solicitação é autorizada usando uma conexão de serviço. A resposta é filtrada usando um seletor baseado em XPath/Json.
querySecureFilesByProperties(string, string, string)	Consulte arquivos seguros usando um padrão de nome e uma condição nas propriedades do arquivo.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Atualize os destinos de implantação em um grupo de implantação.
replaceAgent(TaskAgent, number, number)	Substitua um agente. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, use o script de configuração do agente para remover e reconfigurar um agente da sua organização.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Substitua um destino de implantação em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Adicione um grupo de variáveis.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Atualizar detalhes do agente.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Atualizar propriedades em um pool de agentes
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)
updateAgentUpdateState(number, number, string)
updateAgentUserCapabilities({[key: string]: string}, number, number)
updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)	Atualizar um grupo de implantação.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Atualize um destino de implantação e suas propriedades de agente em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Atualizar marcas de uma lista de destinos de implantação em um grupo de implantação.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Atualize o ambiente especificado.
updateSecureFile(SecureFile, string, string)	Atualizar o nome ou as propriedades de um arquivo seguro existente
updateSecureFiles(SecureFile[], string)	Atualizar propriedades e/ou nomes de um conjunto de arquivos seguros. Os arquivos são identificados por suas IDs. As propriedades fornecidas substituem totalmente a existente, ou seja, não mesclam.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Atualizar um grupo de tarefas.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Atualizar um grupo de variáveis.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Carregar um arquivo seguro, incluir o fluxo de arquivos no corpo da solicitação
validateInputs(InputValidationRequest)

Detalhes do construtor

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

addAgent(TaskAgent, number)

Adiciona um agente a um pool. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, configure um agente usando o pacote de download do agente.

function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>

Parâmetros

agent: TaskAgent

Detalhes sobre o agente que está sendo adicionado

poolId: number

O pool de agentes no qual adicionar o agente

Retornos

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>

Parâmetros

agentCloud: TaskAgentCloud

Retornos

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create um pool de agentes.

function addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>

Parâmetros

pool: TaskAgentPool

Detalhes sobre o novo pool de agentes

Retornos

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create uma nova fila de agentes para conectar um projeto a um pool de agentes.

function addAgentQueue(queue: TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentQueue>

Parâmetros

queue: TaskAgentQueue

Detalhes sobre a fila a ser criada

project: string

ID do projeto ou nome do projeto

authorizePipelines: boolean

Autorizar automaticamente essa fila ao usar YAML

Retornos

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create um grupo de implantação.

function addDeploymentGroup(deploymentGroup: DeploymentGroupCreateParameter, project: string): Promise<DeploymentGroup>

Parâmetros

deploymentGroup: DeploymentGroupCreateParameter

Grupo de implantação a ser criado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

function addDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

Retornos

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>

Parâmetros

machineGroup: DeploymentMachineGroup

project: string

ID do projeto ou nome do projeto

Retornos

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registre um destino de implantação em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.

function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

Destino de implantação a ser registrado.

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual o destino de implantação está registrado.

Retornos

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Criar um ambiente.

function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>

Parâmetros

environmentCreateParameter: EnvironmentCreateParameter

Ambiente a ser criado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

function addKubernetesResource(createParameters: KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<KubernetesResource>

Parâmetros

createParameters: KubernetesResourceCreateParameters

project: string

ID do projeto ou nome do projeto

environmentId: number

Retornos

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create um grupo de tarefas.

function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>

Parâmetros

taskGroup: TaskGroupCreateParameter

Objeto de grupo de tarefas a ser criado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Adicione um grupo de variáveis.

function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>

Parâmetros

variableGroupParameters: VariableGroupParameters

Retornos

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

function addVirtualMachineGroup(createParameters: VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<VirtualMachineGroup>

Parâmetros

createParameters: VirtualMachineGroupCreateParameters

project: string

ID do projeto ou nome do projeto

environmentId: number

Retornos

Promise<VirtualMachineGroup>

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

Parâmetros

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Retornos

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parâmetros

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Retornos

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>

Parâmetros

session: TaskAgentSession

poolId: number

Retornos

Promise<TaskAgentSession>

createTeamProject(string)

Create um novo projeto de equipe.

function createTeamProject(project?: string): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteAgent(number, number)

Exclua um agente. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, use o script de configuração do agente para remover um agente da sua organização.

function deleteAgent(poolId: number, agentId: number): Promise<void>

Parâmetros

poolId: number

A ID do pool da qual remover o agente

agentId: number

A ID do agente a ser removida

Retornos

Promise<void>

deleteAgentCloud(number)

function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>

Parâmetros

agentCloudId: number

Retornos

Promise<TaskAgentCloud>

deleteAgentPool(number)

Excluir um pool de agentes.

function deleteAgentPool(poolId: number): Promise<void>

Parâmetros

poolId: number

ID do pool de agentes a ser excluído

Retornos

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>

Parâmetros

poolId: number

definitionId: number

Retornos

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>

Parâmetros

poolId: number

jobId: number

Retornos

Promise<void>

deleteAgentQueue(number, string)

Remove uma fila de agentes de um projeto.

function deleteAgentQueue(queueId: number, project?: string): Promise<void>

Parâmetros

queueId: number

A fila do agente a ser removida

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteAgentRequest(number, number, string, TaskResult, boolean)

function deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskResult, agentShuttingDown?: boolean): Promise<void>

Parâmetros

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Retornos

Promise<void>

deleteAgentSession(number, string)

function deleteAgentSession(poolId: number, sessionId: string): Promise<void>

Parâmetros

poolId: number

sessionId: string

Retornos

Promise<void>

deleteDeploymentGroup(string, number)

Excluir um grupo de implantação.

function deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação a ser excluído.

Retornos

Promise<void>

deleteDeploymentMachine(string, number, number)

function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineId: number

Retornos

Promise<void>

deleteDeploymentMachineGroup(string, number)

function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

machineGroupId: number

Retornos

Promise<void>

deleteDeploymentTarget(string, number, number)

Exclua um destino de implantação em um grupo de implantação. Isso também exclui o agente do pool de implantação associado.

function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual o destino de implantação é excluído.

targetId: number

ID do destino de implantação a ser excluído.

Retornos

Promise<void>

deleteEnvironment(string, number)

Exclua o ambiente especificado.

function deleteEnvironment(project: string, environmentId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

ID do ambiente.

Retornos

Promise<void>

deleteKubernetesResource(string, number, number)

function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

Retornos

Promise<void>

deleteMessage(number, number, string)

function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>

Parâmetros

poolId: number

messageId: number

sessionId: string

Retornos

Promise<void>

deleteSecureFile(string, string)

Excluir um arquivo seguro

function deleteSecureFile(project: string, secureFileId: string): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

secureFileId: string

A ID de arquivo seguro exclusiva

Retornos

Promise<void>

deleteTaskDefinition(string)

function deleteTaskDefinition(taskId: string): Promise<void>

Parâmetros

taskId: string

Retornos

Promise<void>

deleteTaskGroup(string, string, string)

Excluir um grupo de tarefas.

function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

taskGroupId: string

ID do grupo de tarefas a ser excluído.

comment: string

Comentários a serem excluídos.

Retornos

Promise<void>

deleteVariableGroup(number, string[])

Excluir um grupo de variáveis

function deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>

Parâmetros

groupId: number

ID do grupo de variáveis.

projectIds: string[]

Retornos

Promise<void>

deleteVirtualMachineGroup(string, number, number)

function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

Retornos

Promise<void>

downloadSecureFile(string, string, string, boolean)

Baixar um arquivo seguro por ID

function downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<ArrayBuffer>

Parâmetros

project: string

ID do projeto ou nome do projeto

secureFileId: string

A ID de arquivo seguro exclusiva

ticket: string

Um tíquete de download válido

download: boolean

Se o download for true, o arquivo será enviado como anexação no corpo da resposta. Se o download for false, o corpo da resposta conterá o fluxo de arquivos.

Retornos

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

OBTENHA um token PAT para gerenciar destinos de implantação (configuração, remoção, marcação) em um grupo de implantação.

function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual os destinos de implantação são gerenciados.

Retornos

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>

Parâmetros

project: string

ID do projeto ou nome do projeto

machineGroupId: number

Retornos

Promise<string>

generateDeploymentPoolAccessToken(number)

OBTENHA um token PAT para gerenciar (configurar, remover, marcar) agentes de implantação em um pool de implantação.

function generateDeploymentPoolAccessToken(poolId: number): Promise<string>

Parâmetros

poolId: number

ID do pool de implantação no qual os agentes de implantação são gerenciados.

Retornos

Promise<string>

getAgent(number, number, boolean, boolean, boolean, string[])

Obter informações sobre um agente.

function getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgent>

Parâmetros

poolId: number

O pool de agentes que contém o agente

agentId: number

A ID do agente sobre a qual obter informações

includeCapabilities: boolean

Se os recursos do agente devem ser incluídos na resposta

includeAssignedRequest: boolean

Se deve incluir detalhes sobre o trabalho atual do agente

includeLastCompletedRequest: boolean

Se deve incluir detalhes sobre o trabalho concluído mais recente dos agentes

propertyFilters: string[]

Filtrar quais propriedades personalizadas serão retornadas

Retornos

Promise<TaskAgent>

getAgentCloud(number)

function getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>

Parâmetros

agentCloudId: number

Retornos

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>

Parâmetros

agentCloudId: number

Retornos

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Retornos

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Obter tipos de nuvem do agente.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Retornos

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Obter informações sobre um pool de agentes.

function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>

Parâmetros

poolId: number

Uma ID do pool de agentes

properties: string[]

Propriedades do pool de agentes (separadas por vírgula)

actionFilter: TaskAgentPoolActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parâmetros

poolId: number

definitionId: number

Retornos

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>

Parâmetros

poolId: number

Retornos

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

Parâmetros

poolId: number

jobId: number

Retornos

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>

Parâmetros

poolId: number

jobId: number

Retornos

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>

Parâmetros

poolId: number

definitionId: number

Retornos

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

function getAgentPoolMetadata(poolId: number): Promise<string>

Parâmetros

poolId: number

Retornos

Promise<string>

getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)

Obtenha uma lista de pools de agentes.

function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

Parâmetros

poolName: string

Filtrar por nome

properties: string[]

Filtrar por propriedades do pool de agentes (separadas por vírgula)

poolType: TaskAgentPoolType

Filtrar por tipo de pool

actionFilter: TaskAgentPoolActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Obtenha uma lista de pools de agentes.

function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

Parâmetros

poolIds: number[]

IDs do pool a serem buscadas

actionFilter: TaskAgentPoolActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Obter informações sobre uma fila de agentes.

function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>

Parâmetros

queueId: number

A fila do agente para obter informações sobre

project: string

ID do projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Obtenha uma lista de filas de agentes.

function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

queueName: string

Filtrar o nome da fila do agente

actionFilter: TaskAgentQueueActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes por suas IDs

function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

Parâmetros

queueIds: number[]

Uma lista separada por vírgulas de IDs de fila do agente a serem recuperadas

project: string

ID do projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes por seus nomes

function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

Parâmetros

queueNames: string[]

Uma lista separada por vírgulas de nomes de agente a serem recuperados

project: string

ID do projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes por IDs de pool

function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

Parâmetros

poolIds: number[]

Uma lista separada por vírgulas de IDs de pool para obter as filas correspondentes para

project: string

ID do projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar se o usuário que está chamando tem permissões de uso ou gerenciamento

Retornos

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>

Parâmetros

poolId: number

requestId: number

includeStatus: boolean

Retornos

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

Parâmetros

poolId: number

top: number

continuationToken: string

Retornos

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

poolId: number

agentId: number

completedRequestCount: number

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

poolId: number

agentIds: number[]

completedRequestCount: number

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

function getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineId: number

completedRequestCount: number

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachines(string, number, number[], number)

function getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Obtenha solicitações de agente para um destino de implantação.

function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação ao qual o destino pertence.

targetId: number

ID do destino de implantação.

completedRequestCount: number

Número máximo de solicitações concluídas a serem retornadas. O padrão é 50

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)

Obtenha solicitações de agente para uma lista de destinos de implantação.

function getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação ao qual os destinos pertencem.

targetIds: number[]

Lista separada por vírgulas de IDs dos destinos de implantação.

ownerId: number

ID do proprietário da solicitação de trabalho do agente.

completedOn: Date

Datetime para retornar a solicitação após esse horário.

completedRequestCount: number

Número máximo de solicitações concluídas a serem retornadas para cada destino. O padrão é 50

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>

Parâmetros

poolId: number

planId: string

jobId: string

Retornos

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

function getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

Parâmetros

project: string

ID do projeto ou nome do projeto

queueId: number

top: number

continuationToken: string

Retornos

Promise<PagedList<TaskAgentJobRequest>>

getAgents(number, string, boolean, boolean, boolean, string[], string[])

Obtenha uma lista de agentes.

function getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgent[]>

Parâmetros

poolId: number

O pool de agentes que contém os agentes

agentName: string

Filtrar o nome do agente

includeCapabilities: boolean

Se os recursos dos agentes devem ser incluídos na resposta

includeAssignedRequest: boolean

Se deve incluir detalhes sobre o trabalho atual dos agentes

includeLastCompletedRequest: boolean

Se deve incluir detalhes sobre o trabalho concluído mais recente dos agentes

propertyFilters: string[]

Filtrar quais propriedades personalizadas serão retornadas

demands: string[]

Filtrar por demandas que os agentes podem atender

Retornos

Promise<TaskAgent[]>

getAzureManagementGroups()

Retorna a lista de assinaturas do Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Retornos

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Retorna a lista de assinaturas do Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Retornos

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Obtenha um grupo de implantação por sua ID.

function getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands): Promise<DeploymentGroup>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação.

actionFilter: DeploymentGroupActionFilter

Obtenha o grupo de implantação somente se essa ação puder ser executada nele.

expand: DeploymentGroupExpands

Inclua esses detalhes adicionais no objeto retornado.

Retornos

Promise<DeploymentGroup>

getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])

Obtenha uma lista de grupos de implantação por nome ou IDs.

function getDeploymentGroups(project: string, name?: string, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<PagedList<DeploymentGroup>>

Parâmetros

project: string

ID do projeto ou nome do projeto

name: string

Nome do grupo de implantação.

actionFilter: DeploymentGroupActionFilter

Obtenha apenas grupos de implantação nos quais essa ação pode ser executada.

expand: DeploymentGroupExpands

Inclua esses detalhes adicionais nos objetos retornados.

continuationToken: string

Obtenha grupos de implantação com nomes maiores que este continuationToken lexicograficamente.

top: number

Número máximo de grupos de implantação a serem retornados. O padrão é 1000.

ids: number[]

Lista separada por vírgulas de IDs dos grupos de implantação.

Retornos

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Obtenha uma lista de métricas do grupo de implantação.

function getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<PagedList<DeploymentGroupMetrics>>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupName: string

Nome do grupo de implantação.

continuationToken: string

Obtenha métricas para grupos de implantação com nomes maiores que essa continuaçãoToken lexicograficamente.

top: number

Número máximo de métricas de grupo de implantação a serem retornadas. O padrão é 50.

Retornos

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

function getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: DeploymentMachineExpands): Promise<DeploymentMachine>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Retornos

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

function getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup>

Parâmetros

project: string

ID do projeto ou nome do projeto

machineGroupId: number

actionFilter: MachineGroupActionFilter

Retornos

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

function getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<DeploymentMachine[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

machineGroupId: number

tagFilters: string[]

Retornos

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

function getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

machineGroupName: string

actionFilter: MachineGroupActionFilter

Retornos

Promise<DeploymentMachineGroup[]>

getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)

function getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: DeploymentMachineExpands): Promise<DeploymentMachine[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Retornos

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Obtenha uma lista de resumos do pool de implantação.

function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>

Parâmetros

poolName: string

Nome do pool de implantação.

expands: DeploymentPoolSummaryExpands

Inclua esses detalhes adicionais nos objetos retornados.

poolIds: number[]

Lista de IDs do pool de implantação.

Retornos

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Obter um destino de implantação por sua ID em um grupo de implantação

function getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: DeploymentTargetExpands): Promise<DeploymentMachine>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação ao qual o destino de implantação pertence.

targetId: number

ID do destino de implantação a ser retornado.

expand: DeploymentTargetExpands

Inclua esses detalhes adicionais nos objetos retornados.

Retornos

Promise<DeploymentMachine>

getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])

Obtenha uma lista de destinos de implantação em um grupo de implantação.

function getDeploymentTargets(project: string, deploymentGroupId: number, tags?: string[], name?: string, partialNameMatch?: boolean, expand?: DeploymentTargetExpands, agentStatus?: TaskAgentStatusFilter, agentJobResult?: TaskAgentJobResultFilter, continuationToken?: string, top?: number, enabled?: boolean, propertyFilters?: string[]): Promise<PagedList<DeploymentMachine>>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação.

tags: string[]

Obtenha apenas os destinos de implantação que contêm todas essas listas de marcas separadas por vírgulas.

name: string

Padrão de nome dos destinos de implantação a serem retornados.

partialNameMatch: boolean

Quando definido como true, trata o nome como padrão. Caso contrário, trata-o como correspondência absoluta. O padrão é false.

expand: DeploymentTargetExpands

Inclua esses detalhes adicionais nos objetos retornados.

agentStatus: TaskAgentStatusFilter

Obtenha apenas os destinos de implantação que têm esse status.

agentJobResult: TaskAgentJobResultFilter

Obtenha apenas os destinos de implantação que têm esse último resultado de trabalho.

continuationToken: string

Obtenha destinos de implantação com nomes maiores que este continuationToken lexicograficamente.

top: number

Número máximo de destinos de implantação a serem retornados. O padrão é 1000.

enabled: boolean

Obtenha somente destinos de implantação habilitados ou desabilitados. O padrão é 'null', que retorna todos os destinos.

propertyFilters: string[]

Retornos

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Obtenha um ambiente por sua ID.

function getEnvironmentById(project: string, environmentId: number, expands?: EnvironmentExpands): Promise<EnvironmentInstance>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

ID do ambiente.

expands: EnvironmentExpands

Inclua esses detalhes adicionais nos objetos retornados.

Retornos

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Obter histórico de execução de implantação de ambiente

function getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

continuationToken: string

top: number

Retornos

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Obter todos os ambientes.

function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>

Parâmetros

project: string

ID do projeto ou nome do projeto

name: string

continuationToken: string

top: number

Retornos

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

function getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<KubernetesResource>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

Retornos

Promise<KubernetesResource>

getMessage(number, string, number)

function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>

Parâmetros

poolId: number

sessionId: string

lastMessageId: number

Retornos

Promise<TaskAgentMessage>

getPackage(string, string, string)

function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>

Parâmetros

packageType: string

platform: string

version: string

Retornos

Promise<PackageMetadata>

getPackages(string, string, number)

function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>

Parâmetros

packageType: string

platform: string

top: number

Retornos

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Retornos

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>

Parâmetros

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Retornos

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Obter um arquivo seguro

function getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile>

Parâmetros

project: string

ID do projeto ou nome do projeto

secureFileId: string

A ID de arquivo seguro exclusiva

includeDownloadTicket: boolean

Se includeDownloadTicket for true e o chamador tiver permissões, um tíquete de download será incluído na resposta.

actionFilter: SecureFileActionFilter

Retornos

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Obter arquivos seguros

function getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

namePattern: string

Nome do arquivo seguro a ser correspondido. Pode incluir curingas para corresponder a vários arquivos.

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o chamador tiver permissões, um tíquete de download para cada arquivo seguro será incluído na resposta.

actionFilter: SecureFileActionFilter

Filtre por permissões de arquivo seguro para a ação Exibir, Gerenciar ou Usar. O padrão é Exibir.

Retornos

Promise<SecureFile[]>

getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)

Obter arquivos seguros

function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

secureFileIds: string[]

Uma lista de IDs de arquivo seguro

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o chamador tiver permissões, um tíquete de download para cada arquivo seguro será incluído na resposta.

actionFilter: SecureFileActionFilter

Retornos

Promise<SecureFile[]>

getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)

Obter arquivos seguros

function getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

secureFileNames: string[]

Uma lista de IDs de arquivo seguro

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o chamador tiver permissões, um tíquete de download para cada arquivo seguro será incluído na resposta.

actionFilter: SecureFileActionFilter

Retornos

Promise<SecureFile[]>

getTaskContentZip(string, string, string[], boolean)

function getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<ArrayBuffer>

Parâmetros

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retornos

Promise<ArrayBuffer>

getTaskDefinition(string, string, string[], boolean)

function getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskDefinition>

Parâmetros

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retornos

Promise<TaskDefinition>

getTaskDefinitions(string, string[], boolean, boolean)

function getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskDefinition[]>

Parâmetros

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Retornos

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Obter grupo de tarefas.

function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>

Parâmetros

project: string

ID do projeto ou nome do projeto

taskGroupId: string

Id do grupo de tarefas.

versionSpec: string

especificação de versão do grupo de tarefas. exemplos: 1, 1.0.

expand: TaskGroupExpands

As propriedades que devem ser expandidas. exemplo $expand=Tarefas expandirá grupos de tarefas aninhados.

Retornos

Promise<TaskGroup>

getTaskGroupHistory(string, string)

function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

taskGroupId: string

Retornos

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

function getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<string>

Parâmetros

project: string

ID do projeto ou nome do projeto

taskGroupId: string

revision: number

Retornos

Promise<string>

getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)

Listar grupos de tarefas.

function getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskGroupQueryOrder): Promise<TaskGroup[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

taskGroupId: string

Id do grupo de tarefas.

expanded: boolean

'true' para expandir recursivamente grupos de tarefas. O padrão é 'false'.

taskIdFilter: string

Guid da taskId a ser filtrada.

deleted: boolean

'true', para incluir grupos de tarefas excluídos. O padrão é 'false'.

top: number

Número de grupos de tarefas a serem obtidos.

continuationToken: Date

Obtém os grupos de tarefas após o token de continuação fornecido.

queryOrder: TaskGroupQueryOrder

Obtém os resultados na ordem definida. O padrão é 'CreatedOnDescending'.

Retornos

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>

Parâmetros

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Retornos

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Obter um grupo de variáveis.

function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>

Parâmetros

project: string

ID do projeto ou nome do projeto

groupId: number

Id do grupo de variáveis.

Retornos

Promise<VariableGroup>

getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)

Obter grupos de variáveis.

function getVariableGroups(project: string, groupName?: string, actionFilter?: VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: VariableGroupQueryOrder): Promise<VariableGroup[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

groupName: string

Nome do grupo de variáveis.

actionFilter: VariableGroupActionFilter

Filtro de ação para o grupo de variáveis. Ele especifica a ação que pode ser executada nos grupos de variáveis.

top: number

Número de grupos de variáveis a serem obtidos.

continuationToken: number

Obtém os grupos de variáveis após o token de continuação fornecido.

queryOrder: VariableGroupQueryOrder

Obtém os resultados na ordem definida. O padrão é 'IdDescending'.

Retornos

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Obter grupos de variáveis por IDs.

function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

groupIds: number[]

Lista separada por vírgulas de IDs de grupos de variáveis.

loadSecrets: boolean

Sinalizador que indica se os segredos dentro de grupos de variáveis devem ser carregados.

Retornos

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

function getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<VirtualMachineGroup>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

Retornos

Promise<VirtualMachineGroup>

getVirtualMachines(string, number, number, string, string, boolean, string[], number)

function getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise<PagedList<VirtualMachine>>

Parâmetros

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Retornos

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Retornos

Promise<string>

getYamlSchema(boolean)

OBTER o esquema Yaml usado para validação de arquivo Yaml.

function getYamlSchema(validateTaskNames?: boolean): Promise<any>

Parâmetros

validateTaskNames: boolean

Se o esquema deve validar se as tarefas estão realmente instaladas (útil para ferramentas offline em que você não deseja validação).

Retornos

Promise<any>

hasPoolPermissions(number, number)

Verifica se a identidade atual passou permissões em um pool.

function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>

Parâmetros

poolId: number

Id do pool para marcar

permissions: number

Permissões para marcar. Várias permissões podem ser mescladas em um único valor usando o operador OR bit a bit (por exemplo, AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Retornos

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

function publishTaskGroup(taskGroupMetadata: PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskGroup[]>

Parâmetros

taskGroupMetadata: PublishTaskGroupMetadata

project: string

ID do projeto ou nome do projeto

parentTaskGroupId: string

Retornos

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy para uma solicitação GET definida por um 'ponto de extremidade'. A solicitação é autorizada usando uma conexão de serviço. A resposta é filtrada usando um seletor baseado em XPath/Json.

function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>

Parâmetros

endpoint: TaskDefinitionEndpoint

Descreve a URL a ser buscada.

Retornos

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Consulte arquivos seguros usando um padrão de nome e uma condição nas propriedades do arquivo.

function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>

Parâmetros

condition: string

A sintaxe main condição é descrita aqui. Use a função property('property-name') para acessar o valor da propriedade especificada de um arquivo seguro. Ele retornará nulo se a propriedade não estiver definida. Por exemplo, and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

ID do projeto ou nome do projeto

namePattern: string

Nome do arquivo seguro a ser correspondido. Pode incluir curingas para corresponder a vários arquivos.

Retornos

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>

Parâmetros

job: TaskAgentPoolMaintenanceJob

poolId: number

Retornos

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>

Parâmetros

request: TaskAgentJobRequest

project: string

ID do projeto ou nome do projeto

queueId: number

Retornos

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>

Parâmetros

request: TaskAgentJobRequest

poolId: number

Retornos

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

function refreshAgent(poolId: number, agentId: number): Promise<void>

Parâmetros

poolId: number

agentId: number

Retornos

Promise<void>

refreshAgents(number)

function refreshAgents(poolId: number): Promise<void>

Parâmetros

poolId: number

Retornos

Promise<void>

refreshDeploymentMachines(string, number)

function refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

Retornos

Promise<void>

refreshDeploymentTargets(string, number)

Atualize os destinos de implantação em um grupo de implantação.

function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação.

Retornos

Promise<void>

replaceAgent(TaskAgent, number, number)

Substitua um agente. Você provavelmente não deseja chamar esse ponto de extremidade diretamente. Em vez disso, use o script de configuração do agente para remover e reconfigurar um agente da sua organização.

function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

Parâmetros

agent: TaskAgent

Detalhes atualizados sobre o agente de substituição

poolId: number

O pool de agentes a ser usado

agentId: number

O agente a ser substituído

Retornos

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

function replaceDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineId: number

Retornos

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Substitua um destino de implantação em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.

function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

Novo destino de implantação.

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual o destino de implantação é substituído.

targetId: number

ID do destino de implantação a ser substituído.

Retornos

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>

Parâmetros

message: TaskAgentMessage

poolId: number

requestId: number

Retornos

Promise<void>

setAgentPoolMetadata(any, number)

function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>

Parâmetros

agentPoolMetadata: any

poolId: number

Retornos

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Adicione um grupo de variáveis.

function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>

Parâmetros

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Retornos

Promise<void>

undeleteTaskGroup(TaskGroup, string)

function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>

Parâmetros

taskGroup: TaskGroup

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Atualizar detalhes do agente.

function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

Parâmetros

agent: TaskAgent

Detalhes atualizados sobre o agente

poolId: number

O pool de agentes a ser usado

agentId: number

O agente a ser atualizado

Retornos

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>

Parâmetros

updatedCloud: TaskAgentCloud

agentCloudId: number

Retornos

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Atualizar propriedades em um pool de agentes

function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>

Parâmetros

pool: TaskAgentPool

Detalhes atualizados do pool de agentes

poolId: number

O pool de agentes a ser atualizado

Retornos

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parâmetros

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Retornos

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

Parâmetros

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Retornos

Promise<TaskAgentPoolMaintenanceJob>

updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)

function updateAgentRequest(request: TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentRequestUpdateOptions): Promise<TaskAgentJobRequest>

Parâmetros

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Retornos

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>

Parâmetros

poolId: number

agentId: number

currentState: string

Retornos

Promise<TaskAgent>

updateAgentUserCapabilities({[key: string]: string}, number, number)

function updateAgentUserCapabilities(userCapabilities: {[key: string]: string}, poolId: number, agentId: number): Promise<TaskAgent>

Parâmetros

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Retornos

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Atualizar um grupo de implantação.

function updateDeploymentGroup(deploymentGroup: DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<DeploymentGroup>

Parâmetros

deploymentGroup: DeploymentGroupUpdateParameter

Grupo de implantação a ser atualizado.

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação.

Retornos

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

function updateDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

machineId: number

Retornos

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

function updateDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string, machineGroupId: number): Promise<DeploymentMachineGroup>

Parâmetros

machineGroup: DeploymentMachineGroup

project: string

ID do projeto ou nome do projeto

machineGroupId: number

Retornos

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>

Parâmetros

deploymentMachines: DeploymentMachine[]

project: string

ID do projeto ou nome do projeto

machineGroupId: number

Retornos

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>

Parâmetros

machines: DeploymentMachine[]

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

Retornos

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Atualize um destino de implantação e suas propriedades de agente em um grupo de implantação. Geralmente, isso é chamado pela ferramenta de configuração do agente.

function updateDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>

Parâmetros

machine: DeploymentMachine

Destino de implantação a ser atualizado.

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual o destino de implantação é atualizado.

targetId: number

ID do destino de implantação a ser atualizado.

Retornos

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Atualizar marcas de uma lista de destinos de implantação em um grupo de implantação.

function updateDeploymentTargets(machines: DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>

Parâmetros

machines: DeploymentTargetUpdateParameter[]

Destinos de implantação com marcas para udpdate.

project: string

ID do projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implantação no qual os destinos de implantação são atualizados.

Retornos

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Atualize o ambiente especificado.

function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>

Parâmetros

environmentUpdateParameter: EnvironmentUpdateParameter

Dados de ambiente a serem atualizados.

project: string

ID do projeto ou nome do projeto

environmentId: number

ID do ambiente.

Retornos

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Atualizar o nome ou as propriedades de um arquivo seguro existente

function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>

Parâmetros

secureFile: SecureFile

O arquivo seguro com nome e/ou propriedades atualizados

project: string

ID do projeto ou nome do projeto

secureFileId: string

A ID de arquivo seguro exclusiva

Retornos

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Atualizar propriedades e/ou nomes de um conjunto de arquivos seguros. Os arquivos são identificados por suas IDs. As propriedades fornecidas substituem totalmente a existente, ou seja, não mesclam.

function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>

Parâmetros

secureFiles: SecureFile[]

Uma lista de objetos de arquivo seguros. Somente três campos devem ser preenchidos ID, Nome e Propriedades. O restante dos campos no objeto são ignorados.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Atualizar um grupo de tarefas.

function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>

Parâmetros

taskGroup: TaskGroupUpdateParameter

Grupo de tarefas a ser atualizado.

project: string

ID do projeto ou nome do projeto

taskGroupId: string

Id do grupo de tarefas a ser atualizado.

Retornos

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

function updateTaskGroupProperties(taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskGroup[]>

Parâmetros

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

ID do projeto ou nome do projeto

taskGroupId: string

disablePriorVersions: boolean

Retornos

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>

Parâmetros

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Retornos

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Atualizar um grupo de variáveis.

function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>

Parâmetros

variableGroupParameters: VariableGroupParameters

groupId: number

Id do grupo de variáveis a ser atualizado.

Retornos

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

function updateVirtualMachineGroup(resource: VirtualMachineGroup, project: string, environmentId: number): Promise<VirtualMachineGroup>

Parâmetros

resource: VirtualMachineGroup

project: string

ID do projeto ou nome do projeto

environmentId: number

Retornos

Promise<VirtualMachineGroup>

updateVirtualMachines(VirtualMachine[], string, number, number)

function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>

Parâmetros

machines: VirtualMachine[]

project: string

ID do projeto ou nome do projeto

environmentId: number

resourceId: number

Retornos

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Carregar um arquivo seguro, incluir o fluxo de arquivos no corpo da solicitação

function uploadSecureFile(content: any, project: string, name: string, authorizePipelines?: boolean): Promise<SecureFile>

Parâmetros

content: any

Conteúdo a ser carregado

project: string

ID do projeto ou nome do projeto

name: string

Nome do arquivo a ser carregado

authorizePipelines: boolean

Se authorizePipelines for true, o arquivo seguro será autorizado para uso por todos os pipelines no projeto.

Retornos

Promise<SecureFile>

validateInputs(InputValidationRequest)

function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>

Parâmetros

inputValidationRequest: InputValidationRequest

Retornos

Promise<InputValidationRequest>

Compartilhar via

TaskAgentRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

TaskAgentRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

addAgent(TaskAgent, number)

Parâmetros

Retornos

addAgentCloud(TaskAgentCloud)

Parâmetros

Retornos

addAgentPool(TaskAgentPool)

Parâmetros

Retornos

addAgentQueue(TaskAgentQueue, string, boolean)

Parâmetros

Retornos

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parâmetros

Retornos

addDeploymentMachine(DeploymentMachine, string, number)

Parâmetros

Retornos

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parâmetros

Retornos

addDeploymentTarget(DeploymentMachine, string, number)

Parâmetros

Retornos

addEnvironment(EnvironmentCreateParameter, string)

Parâmetros

Retornos

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parâmetros

Retornos

addTaskGroup(TaskGroupCreateParameter, string)

Parâmetros

Retornos

addVariableGroup(VariableGroupParameters)

Parâmetros

Retornos

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parâmetros

Retornos

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

Parâmetros

Retornos

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parâmetros

Retornos

createAgentSession(TaskAgentSession, number)

Parâmetros

Retornos

createTeamProject(string)

Parâmetros

Retornos

deleteAgent(number, number)

Parâmetros

Retornos

deleteAgentCloud(number)

Parâmetros

Retornos

deleteAgentPool(number)

Parâmetros

Retornos

deleteAgentPoolMaintenanceDefinition(number, number)

Parâmetros

Retornos

deleteAgentPoolMaintenanceJob(number, number)

Parâmetros

Retornos

deleteAgentQueue(number, string)

Parâmetros