TaskAgentRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends: RestClientBase

Construtores

TaskAgentRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addAgent(TaskAgent, number)	Adiciona um agente a um conjunto. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, configure um agente com o pacote de transferência do agente.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create um conjunto de agentes.
addAgentQueue(TaskAgentQueue, string, boolean)	Create uma nova fila de agentes para ligar um projeto a um conjunto de agentes.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create um grupo de implementação.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registar um destino de implementação num grupo de implementação. Geralmente, isto é chamado pela ferramenta de configuração do agente.
addEnvironment(EnvironmentCreateParameter, string)	Create um ambiente.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create um grupo de tarefas.
addVariableGroup(VariableGroupParameters)	Adicionar 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 equipa.
deleteAgent(number, number)	Eliminar um agente. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, utilize o script de configuração do agente para remover um agente da sua organização.
deleteAgentCloud(number)
deleteAgentPool(number)	Eliminar um conjunto de agentes.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Remove uma fila de agente de um projeto.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Eliminar um grupo de implementação.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Eliminar um destino de implementação num grupo de implementação. Esta ação também elimina o agente do conjunto de implementação associado.
deleteEnvironment(string, number)	Elimine o ambiente especificado.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Eliminar um ficheiro seguro
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Eliminar um grupo de tarefas.
deleteVariableGroup(number, string[])	Eliminar um grupo de variáveis
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Transferir um ficheiro seguro por ID
generateDeploymentGroupAccessToken(string, number)	OBTER um token PAT para gerir (configurar, remover, etiquetar) destinos de implementação num grupo de implementação.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	OBTER um token PAT para gerir (configurar, remover, etiquetar) agentes de implementação num conjunto de implementação.
getAgent(number, number, boolean, boolean, boolean, string[])	Obtenha informações sobre um agente.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Obter tipos de cloud de agente.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Obtenha informações sobre um conjunto 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 conjuntos de agentes.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Obtenha uma lista de conjuntos de agentes.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Obtenha 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 pelos respetivos IDs
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Obter uma lista de filas de agentes pelos respetivos nomes
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Obter uma lista de filas de agentes por IDs de conjunto
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)	Obter pedidos de agente para um destino de implementação.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Obtenha pedidos de agente para uma lista de destinos de implementação.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Obtenha uma lista de agentes.
getAzureManagementGroups()	Devolve a lista de subscrições do Azure
getAzureSubscriptions()	Devolve a lista de subscrições do Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Obtenha um grupo de implementação pelo respetivo ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Obtenha uma lista de grupos de implementação por nome ou IDs.
getDeploymentGroupsMetrics(string, string, string, number)	Obtenha uma lista de métricas do grupo de implementaçã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 conjunto de implementação.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Obter um destino de implementação pelo respetivo ID num grupo de implementação
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Obtenha uma lista de destinos de implementação num grupo de implementação.
getEnvironmentById(string, number, EnvironmentExpands)	Obtenha um ambiente pelo respetivo ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Obter o histórico de execuções de implementação do ambiente
getEnvironments(string, string, string, number)	Obtenha 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 ficheiro seguro
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Obter ficheiros seguros
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Obter ficheiros seguros
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Obter ficheiros 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)	OBTENHA o esquema Yaml utilizado para a validação de ficheiros do Yaml.
hasPoolPermissions(number, number)	Verifica se a identidade atual passou permissões num conjunto.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy para um pedido GET definido por um "ponto final". O pedido é autorizado através de uma ligação de serviço. A resposta é filtrada com um seletor baseado em XPath/Json.
querySecureFilesByProperties(string, string, string)	Consultar ficheiros seguros com um padrão de nome e uma condição nas propriedades do ficheiro.
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 implementação num grupo de implementação.
replaceAgent(TaskAgent, number, number)	Substitua um agente. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, utilize 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 implementação num grupo de implementação. Geralmente, isto é chamado pela ferramenta de configuração do agente.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Adicionar um grupo de variáveis.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Atualize os detalhes do agente.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Atualizar propriedades num conjunto 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 implementaçã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 implementação e as respetivas propriedades de agente num grupo de implementação. Geralmente, isto é chamado pela ferramenta de configuração do agente.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Atualizar etiquetas de uma lista de destinos de implementação num grupo de implementação.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Atualize o ambiente especificado.
updateSecureFile(SecureFile, string, string)	Atualizar o nome ou propriedades de um ficheiro seguro existente
updateSecureFiles(SecureFile[], string)	Atualize as propriedades e/ou os nomes de um conjunto de ficheiros seguros. Os ficheiros são identificados pelos respetivos IDs. As propriedades fornecidas substituem totalmente a existente, ou seja, não intercalar.
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 ficheiro seguro, incluir o fluxo de ficheiros no corpo do pedido
validateInputs(InputValidationRequest)

Detalhes do Construtor

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addAgent(TaskAgent, number)

Adiciona um agente a um conjunto. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, configure um agente com o pacote de transferência do agente.

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

Parâmetros

agent: TaskAgent

Detalhes sobre a adição do agente

poolId: number

O conjunto de agentes no qual pretende adicionar o agente

Devoluções

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parâmetros

agentCloud: TaskAgentCloud

Devoluções

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create um conjunto de agentes.

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

Parâmetros

pool: TaskAgentPool

Detalhes sobre o novo conjunto de agentes

Devoluções

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create uma nova fila de agentes para ligar um projeto a um conjunto de agentes.

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

Parâmetros

queue: TaskAgentQueue

Detalhes sobre a fila a criar

project: string

ID do Projeto ou nome do projeto

authorizePipelines: boolean

Autorizar automaticamente esta fila ao utilizar o YAML

Devoluções

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create um grupo de implementação.

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

Parâmetros

deploymentGroup: DeploymentGroupCreateParameter

Grupo de implementação a criar.

project: string

ID do Projeto ou nome do projeto

Devoluções

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

Devoluções

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

Devoluções

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registar um destino de implementação num grupo de implementação. Geralmente, isto é chamado pela ferramenta de configuração do agente.

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

Parâmetros

machine: DeploymentMachine

Destino de implementação a registar.

project: string

ID do Projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implementação no qual o destino de implementação está registado.

Devoluções

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Create um ambiente.

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

Parâmetros

environmentCreateParameter: EnvironmentCreateParameter

Ambiente a criar.

project: string

ID do Projeto ou nome do projeto

Devoluções

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

Devoluções

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 criar.

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Adicionar um grupo de variáveis.

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

Parâmetros

variableGroupParameters: VariableGroupParameters

Devoluções

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

Devoluções

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

Devoluções

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parâmetros

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Devoluções

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parâmetros

session: TaskAgentSession

poolId: number

Devoluções

Promise<TaskAgentSession>

createTeamProject(string)

Create um novo projeto de equipa.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<void>

deleteAgent(number, number)

Eliminar um agente. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, utilize 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

O ID do conjunto para remover o agente de

agentId: number

O ID do agente a remover

Devoluções

Promise<void>

deleteAgentCloud(number)

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

Parâmetros

agentCloudId: number

Devoluções

Promise<TaskAgentCloud>

deleteAgentPool(number)

Eliminar um conjunto de agentes.

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

Parâmetros

poolId: number

ID do conjunto de agentes a eliminar

Devoluções

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parâmetros

poolId: number

definitionId: number

Devoluções

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parâmetros

poolId: number

jobId: number

Devoluções

Promise<void>

deleteAgentQueue(number, string)

Remove uma fila de agente de um projeto.

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

Parâmetros

queueId: number

A fila do agente a remover

project: string

ID do Projeto ou nome do projeto

Devoluções

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

Devoluções

Promise<void>

deleteAgentSession(number, string)

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

Parâmetros

poolId: number

sessionId: string

Devoluções

Promise<void>

deleteDeploymentGroup(string, number)

Eliminar um grupo de implementaçã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 implementação a eliminar.

Devoluções

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

Devoluções

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

Devoluções

Promise<void>

deleteDeploymentTarget(string, number, number)

Eliminar um destino de implementação num grupo de implementação. Esta ação também elimina o agente do conjunto de implementaçã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 implementação no qual o destino da implementação é eliminado.

targetId: number

ID do destino de implementação a eliminar.

Devoluções

Promise<void>

deleteEnvironment(string, number)

Elimine 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.

Devoluções

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

Devoluções

Promise<void>

deleteMessage(number, number, string)

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

Parâmetros

poolId: number

messageId: number

sessionId: string

Devoluções

Promise<void>

deleteSecureFile(string, string)

Eliminar um ficheiro seguro

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

secureFileId: string

O ID de ficheiro seguro exclusivo

Devoluções

Promise<void>

deleteTaskDefinition(string)

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

Parâmetros

taskId: string

Devoluções

Promise<void>

deleteTaskGroup(string, string, string)

Eliminar 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 eliminar.

comment: string

Comentários a eliminar.

Devoluções

Promise<void>

deleteVariableGroup(number, string[])

Eliminar 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[]

Devoluções

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

Devoluções

Promise<void>

downloadSecureFile(string, string, string, boolean)

Transferir um ficheiro 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

O ID de ficheiro seguro exclusivo

ticket: string

Um pedido de transferência válido

download: boolean

Se a transferência for verdadeira, o ficheiro é enviado como anexação no corpo da resposta. Se a transferência for falsa, o corpo da resposta contém o fluxo de ficheiros.

Devoluções

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

OBTER um token PAT para gerir (configurar, remover, etiquetar) destinos de implementação num grupo de implementaçã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 implementação no qual os destinos de implementação são geridos.

Devoluções

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

Devoluções

Promise<string>

generateDeploymentPoolAccessToken(number)

OBTER um token PAT para gerir (configurar, remover, etiquetar) agentes de implementação num conjunto de implementação.

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

Parâmetros

poolId: number

ID do conjunto de implementação no qual os agentes de implementação são geridos.

Devoluções

Promise<string>

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

Obtenha 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 conjunto de agentes que contém o agente

agentId: number

O ID do agente para obter informações sobre

includeCapabilities: boolean

Se pretende incluir as capacidades do agente na resposta

includeAssignedRequest: boolean

Se pretende incluir detalhes sobre o trabalho atual do agente

includeLastCompletedRequest: boolean

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

propertyFilters: string[]

Filtrar as propriedades personalizadas que serão devolvidas

Devoluções

Promise<TaskAgent>

getAgentCloud(number)

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

Parâmetros

agentCloudId: number

Devoluções

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parâmetros

agentCloudId: number

Devoluções

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Devoluções

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Obter tipos de cloud de agente.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Devoluções

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Obtenha informações sobre um conjunto de agentes.

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

Parâmetros

poolId: number

Um ID do conjunto de agentes

properties: string[]

Propriedades do conjunto de agentes (separadas por vírgulas)

actionFilter: TaskAgentPoolActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parâmetros

poolId: number

definitionId: number

Devoluções

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parâmetros

poolId: number

Devoluções

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parâmetros

poolId: number

jobId: number

Devoluções

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parâmetros

poolId: number

jobId: number

Devoluções

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parâmetros

poolId: number

definitionId: number

Devoluções

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parâmetros

poolId: number

Devoluções

Promise<string>

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

Obtenha uma lista de conjuntos 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 conjunto de agentes (separadas por vírgulas)

poolType: TaskAgentPoolType

Filtrar por tipo de conjunto

actionFilter: TaskAgentPoolActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Obtenha uma lista de conjuntos de agentes.

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

Parâmetros

poolIds: number[]

IDs do conjunto a obter

actionFilter: TaskAgentPoolActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Obtenha 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 por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

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 no nome da fila do agente

actionFilter: TaskAgentQueueActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes pelos respetivos 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 de agentes a obter

project: string

ID do Projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes pelos respetivos nomes

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

Parâmetros

queueNames: string[]

Uma lista separada por vírgulas de nomes de agentes a obter

project: string

ID do Projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Obter uma lista de filas de agentes por IDs de conjunto

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

Parâmetros

poolIds: number[]

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

project: string

ID do Projeto ou nome do projeto

actionFilter: TaskAgentQueueActionFilter

Filtrar por se o utilizador de chamadas tem permissões de utilização ou gestão

Devoluções

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parâmetros

poolId: number

requestId: number

includeStatus: boolean

Devoluções

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

Devoluções

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

Devoluções

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parâmetros

poolId: number

agentIds: number[]

completedRequestCount: number

Devoluções

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

Devoluções

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

Devoluções

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Obter pedidos de agente para um destino de implementaçã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 implementação ao qual o destino pertence.

targetId: number

ID do destino da implementação.

completedRequestCount: number

Número máximo de pedidos concluídos a devolver. A predefinição é 50

Devoluções

Promise<TaskAgentJobRequest[]>

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

Obtenha pedidos de agente para uma lista de destinos de implementaçã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 implementação ao qual os destinos pertencem.

targetIds: number[]

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

ownerId: number

ID do proprietário do pedido de emprego do agente.

completedOn: Date

Datetime para devolver o pedido após esta hora.

completedRequestCount: number

Número máximo de pedidos concluídos a devolver para cada destino. A predefinição é 50

Devoluções

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parâmetros

poolId: number

planId: string

jobId: string

Devoluções

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

Devoluções

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 conjunto de agentes que contém os agentes

agentName: string

Filtrar no nome do agente

includeCapabilities: boolean

Se pretende incluir as capacidades dos agentes na resposta

includeAssignedRequest: boolean

Se pretende incluir detalhes sobre o trabalho atual dos agentes

includeLastCompletedRequest: boolean

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

propertyFilters: string[]

Filtrar as propriedades personalizadas que serão devolvidas

demands: string[]

Filtrar por exigências que os agentes podem satisfazer

Devoluções

Promise<TaskAgent[]>

getAzureManagementGroups()

Devolve a lista de subscrições do Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Devoluções

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Devolve a lista de subscrições do Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Devoluções

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Obtenha um grupo de implementação pelo respetivo 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 implementação.

actionFilter: DeploymentGroupActionFilter

Obtenha o grupo de implementação apenas se esta ação puder ser executada no mesmo.

expand: DeploymentGroupExpands

Inclua estes detalhes adicionais no objeto devolvido.

Devoluções

Promise<DeploymentGroup>

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

Obtenha uma lista de grupos de implementaçã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 implementação.

actionFilter: DeploymentGroupActionFilter

Obtenha apenas grupos de implementação nos quais esta ação pode ser executada.

expand: DeploymentGroupExpands

Inclua estes detalhes adicionais nos objetos devolvidos.

continuationToken: string

Obtenha grupos de implementação com nomes maiores do que este continuationToken lexicographicamente.

top: number

Número máximo de grupos de implementação a devolver. A predefinição é 1000.

ids: number[]

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

Devoluções

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Obtenha uma lista de métricas do grupo de implementaçã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 implementação.

continuationToken: string

Obtenha métricas para grupos de implementação com nomes maiores do que este continuationToken lexicographicamente.

top: number

Número máximo de métricas do grupo de implementação a devolver. A predefinição é 50.

Devoluções

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

Devoluções

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

Devoluções

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[]

Devoluções

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

Devoluções

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

Devoluções

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Obtenha uma lista de resumos do conjunto de implementação.

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

Parâmetros

poolName: string

Nome do conjunto de implementação.

expands: DeploymentPoolSummaryExpands

Inclua estes detalhes adicionais nos objetos devolvidos.

poolIds: number[]

Lista de IDs do conjunto de implementação.

Devoluções

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Obter um destino de implementação pelo respetivo ID num grupo de implementaçã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 implementação ao qual o destino de implementação pertence.

targetId: number

ID do destino de implementação a devolver.

expand: DeploymentTargetExpands

Inclua estes detalhes adicionais nos objetos devolvidos.

Devoluções

Promise<DeploymentMachine>

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

Obtenha uma lista de destinos de implementação num grupo de implementaçã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 implementação.

tags: string[]

Obtenha apenas os destinos de implementação que contêm todas estas etiquetas com vírgulas.

name: string

Padrão de nome dos destinos de implementação a devolver.

partialNameMatch: boolean

Quando definido como verdadeiro, trata o nome como padrão. Senão trata-o como uma correspondência absoluta. A predefinição é falsa.

expand: DeploymentTargetExpands

Inclua estes detalhes adicionais nos objetos devolvidos.

agentStatus: TaskAgentStatusFilter

Obtenha apenas destinos de implementação que tenham este estado.

agentJobResult: TaskAgentJobResultFilter

Obtenha apenas destinos de implementação que tenham este último resultado de tarefa.

continuationToken: string

Obtenha destinos de implementação com nomes maiores do que este continuationToken lexicographicamente.

top: number

Número máximo de destinos de implementação a devolver. A predefinição é 1000.

enabled: boolean

Obtenha apenas destinos de implementação ativados ou desativados. A predefinição é "nula" que devolve todos os destinos.

propertyFilters: string[]

Devoluções

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Obtenha um ambiente pelo respetivo 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 estes detalhes adicionais nos objetos devolvidos.

Devoluções

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Obter o histórico de execuções de implementação do 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

Devoluções

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Obtenha 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

Devoluções

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

Devoluções

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parâmetros

poolId: number

sessionId: string

lastMessageId: number

Devoluções

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parâmetros

packageType: string

platform: string

version: string

Devoluções

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parâmetros

packageType: string

platform: string

top: number

Devoluções

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Devoluções

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parâmetros

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Devoluções

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Obter um ficheiro 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

O ID de ficheiro seguro exclusivo

includeDownloadTicket: boolean

Se includeDownloadTicket for true e o autor da chamada tiver permissões, será incluído um pedido de transferência na resposta.

actionFilter: SecureFileActionFilter

Devoluções

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Obter ficheiros 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 ficheiro seguro a corresponder. Pode incluir carateres universais para corresponder a vários ficheiros.

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o autor da chamada tiver permissões, será incluído um pedido de transferência para cada ficheiro seguro na resposta.

actionFilter: SecureFileActionFilter

Filtre por permissões de ficheiro seguras para Ver, Gerir ou Utilizar a ação. Predefinições para Ver.

Devoluções

Promise<SecureFile[]>

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

Obter ficheiros 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 ficheiro seguros

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o autor da chamada tiver permissões, será incluído um pedido de transferência para cada ficheiro seguro na resposta.

actionFilter: SecureFileActionFilter

Devoluções

Promise<SecureFile[]>

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

Obter ficheiros 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 ficheiro seguros

includeDownloadTickets: boolean

Se includeDownloadTickets for true e o autor da chamada tiver permissões, será incluído um pedido de transferência para cada ficheiro seguro na resposta.

actionFilter: SecureFileActionFilter

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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 da versão do grupo de tarefas. exemplos: 1, 1.0.

expand: TaskGroupExpands

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

Devoluções

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

Devoluções

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

Devoluções

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

"verdadeiro" para expandir recursivamente grupos de tarefas. A predefinição é "falso".

taskIdFilter: string

Guid do taskId a filtrar.

deleted: boolean

"true" para incluir grupos de tarefas eliminados. A predefinição é "falso".

top: number

Número de grupos de tarefas a obter.

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. A predefinição é "CreatedOnDescending".

Devoluções

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parâmetros

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Devoluções

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.

Devoluções

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. Especifica a ação que pode ser executada nos grupos de variáveis.

top: number

Número de grupos variáveis a obter.

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. A predefinição é "IdDescending".

Devoluções

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 variáveis.

loadSecrets: boolean

Sinalizador a indicar se os segredos dentro de grupos de variáveis devem ser carregados.

Devoluções

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

Devoluções

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

Devoluções

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Devoluções

Promise<string>

getYamlSchema(boolean)

OBTENHA o esquema Yaml utilizado para a validação de ficheiros do Yaml.

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

Parâmetros

validateTaskNames: boolean

Se o esquema deve validar que as tarefas estão realmente instaladas (útil para ferramentas offline onde não quer validação).

Devoluções

Promise<any>

hasPoolPermissions(number, number)

Verifica se a identidade atual passou permissões num conjunto.

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

Parâmetros

poolId: number

ID do conjunto a verificar

permissions: number

Permissões para verificar. Várias permissões podem ser intercaladas num único valor através do operador BIT OR (por exemplo, AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Devoluções

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

Devoluções

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy para um pedido GET definido por um "ponto final". O pedido é autorizado através de uma ligação de serviço. A resposta é filtrada com um seletor baseado em XPath/Json.

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

Parâmetros

endpoint: TaskDefinitionEndpoint

Descreve o URL a obter.

Devoluções

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Consultar ficheiros seguros com um padrão de nome e uma condição nas propriedades do ficheiro.

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

Parâmetros

condition: string

A sintaxe da condição principal é descrita aqui. Utilize a função property('property-name') para aceder ao valor da propriedade especificada de um ficheiro seguro. Devolve 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 ficheiro seguro a corresponder. Pode incluir carateres universais para corresponder a vários ficheiros.

Devoluções

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parâmetros

job: TaskAgentPoolMaintenanceJob

poolId: number

Devoluções

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

Devoluções

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parâmetros

request: TaskAgentJobRequest

poolId: number

Devoluções

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parâmetros

poolId: number

agentId: number

Devoluções

Promise<void>

refreshAgents(number)

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

Parâmetros

poolId: number

Devoluções

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

Devoluções

Promise<void>

refreshDeploymentTargets(string, number)

Atualize os destinos de implementação num grupo de implementaçã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 implementação.

Devoluções

Promise<void>

replaceAgent(TaskAgent, number, number)

Substitua um agente. Provavelmente não quer chamar este ponto final diretamente. Em vez disso, utilize 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 conjunto de agentes a utilizar

agentId: number

O agente a substituir

Devoluções

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

Devoluções

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Substitua um destino de implementação num grupo de implementação. Geralmente, isto é 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 implementação.

project: string

ID do Projeto ou nome do projeto

deploymentGroupId: number

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

targetId: number

ID do destino de implementação a substituir.

Devoluções

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parâmetros

message: TaskAgentMessage

poolId: number

requestId: number

Devoluções

Promise<void>

setAgentPoolMetadata(any, number)

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

Parâmetros

agentPoolMetadata: any

poolId: number

Devoluções

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Adicionar um grupo de variáveis.

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

Parâmetros

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Devoluções

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

Devoluções

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Atualize os 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 conjunto de agentes a utilizar

agentId: number

O agente a atualizar

Devoluções

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parâmetros

updatedCloud: TaskAgentCloud

agentCloudId: number

Devoluções

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Atualizar propriedades num conjunto de agentes

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

Parâmetros

pool: TaskAgentPool

Detalhes atualizados do conjunto de agentes

poolId: number

O conjunto de agentes a atualizar

Devoluções

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parâmetros

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Devoluções

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parâmetros

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Devoluções

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

Devoluções

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parâmetros

poolId: number

agentId: number

currentState: string

Devoluções

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

Devoluções

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Atualizar um grupo de implementação.

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

Parâmetros

deploymentGroup: DeploymentGroupUpdateParameter

Grupo de implementação a atualizar.

project: string

ID do Projeto ou nome do projeto

deploymentGroupId: number

ID do grupo de implementação.

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Atualize um destino de implementação e as respetivas propriedades de agente num grupo de implementação. Geralmente, isto é 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 implementação a atualizar.

project: string

ID do Projeto ou nome do projeto

deploymentGroupId: number

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

targetId: number

ID do destino de implementação a atualizar.

Devoluções

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Atualizar etiquetas de uma lista de destinos de implementação num grupo de implementação.

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

Parâmetros

machines: DeploymentTargetUpdateParameter[]

Destinos de implementação com etiquetas para udpdate.

project: string

ID do Projeto ou nome do projeto

deploymentGroupId: number

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

Devoluções

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 do ambiente a atualizar.

project: string

ID do Projeto ou nome do projeto

environmentId: number

ID do ambiente.

Devoluções

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Atualizar o nome ou propriedades de um ficheiro seguro existente

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

Parâmetros

secureFile: SecureFile

O ficheiro seguro com o nome e/ou propriedades atualizados

project: string

ID do Projeto ou nome do projeto

secureFileId: string

O ID de ficheiro seguro exclusivo

Devoluções

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Atualize as propriedades e/ou os nomes de um conjunto de ficheiros seguros. Os ficheiros são identificados pelos respetivos IDs. As propriedades fornecidas substituem totalmente a existente, ou seja, não intercalar.

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

Parâmetros

secureFiles: SecureFile[]

Uma lista de objetos de ficheiro seguros. Apenas três campos têm de ser preenchidos ID, Nome e Propriedades. Os restantes campos no objeto são ignorados.

project: string

ID do Projeto ou nome do projeto

Devoluções

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 atualizar.

project: string

ID do Projeto ou nome do projeto

taskGroupId: string

ID do grupo de tarefas a atualizar.

Devoluções

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

Devoluções

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parâmetros

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Devoluções

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 atualizar.

Devoluções

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

Devoluções

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

Devoluções

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Carregar um ficheiro seguro, incluir o fluxo de ficheiros no corpo do pedido

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

Parâmetros

content: any

Conteúdo a carregar

project: string

ID do Projeto ou nome do projeto

name: string

Nome do ficheiro a carregar

authorizePipelines: boolean

Se authorizePipelines for verdadeiro, o ficheiro seguro será autorizado a ser utilizado por todos os pipelines no projeto.

Devoluções

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parâmetros

inputValidationRequest: InputValidationRequest

Devoluções

Promise<InputValidationRequest>

Partilhar via

TaskAgentRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

TaskAgentRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

addAgent(TaskAgent, number)

Parâmetros

Devoluções

addAgentCloud(TaskAgentCloud)

Parâmetros

Devoluções

addAgentPool(TaskAgentPool)

Parâmetros

Devoluções

addAgentQueue(TaskAgentQueue, string, boolean)

Parâmetros

Devoluções

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parâmetros

Devoluções

addDeploymentMachine(DeploymentMachine, string, number)

Parâmetros

Devoluções

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parâmetros

Devoluções

addDeploymentTarget(DeploymentMachine, string, number)

Parâmetros

Devoluções

addEnvironment(EnvironmentCreateParameter, string)

Parâmetros

Devoluções

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parâmetros

Devoluções

addTaskGroup(TaskGroupCreateParameter, string)

Parâmetros

Devoluções

addVariableGroup(VariableGroupParameters)

Parâmetros

Devoluções

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parâmetros

Devoluções

createAgentSession(TaskAgentSession, number)

Parâmetros

Devoluções

createTeamProject(string)

Parâmetros

Devoluções

deleteAgent(number, number)

Parâmetros

Devoluções

deleteAgentCloud(number)

Parâmetros

Devoluções

deleteAgentPool(number)

Parâmetros

Devoluções

deleteAgentPoolMaintenanceDefinition(number, number)

Parâmetros

Devoluções

deleteAgentPoolMaintenanceJob(number, number)

Parâmetros

Devoluções

deleteAgentQueue(number, string)

Parâmetros