TaskAgentRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends: RestClientBase

Costruttori

TaskAgentRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addAgent(TaskAgent, number)	Aggiunge un agente a un pool. Probabilmente non si vuole chiamare questo endpoint direttamente. Configurare invece un agente usando il pacchetto di download dell'agente.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create un pool di agenti.
addAgentQueue(TaskAgentQueue, string, boolean)	Create una nuova coda agente per connettere un progetto a un pool di agenti.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create un gruppo di distribuzione.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registrare una destinazione di distribuzione in un gruppo di distribuzione. In genere viene chiamato dallo strumento di configurazione dell'agente.
addEnvironment(EnvironmentCreateParameter, string)	Create un ambiente.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create un gruppo di attività.
addVariableGroup(VariableGroupParameters)	Aggiungere un gruppo di variabili.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create un nuovo progetto team.
deleteAgent(number, number)	Eliminare un agente. Probabilmente non si vuole chiamare questo endpoint direttamente. Usare invece lo script di configurazione dell'agente per rimuovere un agente dall'organizzazione.
deleteAgentCloud(number)
deleteAgentPool(number)	Eliminare un pool di agenti.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Rimuove una coda di agenti da un progetto.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Eliminare un gruppo di distribuzione.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Eliminare una destinazione di distribuzione in un gruppo di distribuzione. In questo modo l'agente viene eliminato anche dal pool di distribuzione associato.
deleteEnvironment(string, number)	Eliminare l'ambiente specificato.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Eliminare un file sicuro
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Eliminare un gruppo di attività.
deleteVariableGroup(number, string[])	Eliminare un gruppo di variabili
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Scaricare un file sicuro in base all'ID
generateDeploymentGroupAccessToken(string, number)	OTTENERE un token PAT per la gestione (configurazione, rimozione, assegnazione di tag) alle destinazioni di distribuzione in un gruppo di distribuzione.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	OTTENERE un token PAT per la gestione (configurazione, rimozione, assegnazione di tag) agli agenti di distribuzione in un pool di distribuzione.
getAgent(number, number, boolean, boolean, boolean, string[])	Ottenere informazioni su un agente.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Ottenere i tipi di cloud dell'agente.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Ottenere informazioni su un pool di agenti.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Ottenere un elenco di pool di agenti.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Ottenere un elenco di pool di agenti.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Ottenere informazioni su una coda dell'agente.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Ottenere un elenco di code dell'agente.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Ottenere un elenco di code di agenti in base agli ID
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Ottenere un elenco di code di agenti in base ai nomi
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Ottenere un elenco di code agente in base agli ID del 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)	Ottenere le richieste dell'agente per una destinazione di distribuzione.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Ottenere le richieste dell'agente per le destinazioni di distribuzione di un elenco.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Ottenere un elenco di agenti.
getAzureManagementGroups()	Restituisce l'elenco delle sottoscrizioni di Azure
getAzureSubscriptions()	Restituisce l'elenco delle sottoscrizioni di Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Ottenere un gruppo di distribuzione in base al relativo ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Ottenere un elenco di gruppi di distribuzione in base al nome o agli ID.
getDeploymentGroupsMetrics(string, string, string, number)	Ottenere un elenco delle metriche del gruppo di distribuzione.
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[])	Ottenere un elenco di riepiloghi del pool di distribuzione.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Ottenere una destinazione di distribuzione in base al relativo ID in un gruppo di distribuzione
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Ottenere un elenco di destinazioni di distribuzione in un gruppo di distribuzione.
getEnvironmentById(string, number, EnvironmentExpands)	Ottenere un ambiente in base all'ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Ottenere la cronologia di esecuzione della distribuzione dell'ambiente
getEnvironments(string, string, string, number)	Ottenere tutti gli ambienti.
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)	Ottenere un file sicuro
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Ottenere file sicuri
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Ottenere file sicuri
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Ottenere file sicuri
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Ottenere il gruppo di attività.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Elencare i gruppi di attività.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Ottenere un gruppo di variabili.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Ottenere gruppi di variabili.
getVariableGroupsById(string, number[], boolean)	Ottenere gruppi di variabili in base agli ID.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	GET lo schema Yaml usato per la convalida dei file Yaml.
hasPoolPermissions(number, number)	Verifica se l'identità corrente ha passato le autorizzazioni in un pool.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy per una richiesta GET definita da un 'endpoint'. La richiesta è autorizzata usando una connessione al servizio. La risposta viene filtrata usando un selettore basato su XPath/Json.
querySecureFilesByProperties(string, string, string)	Eseguire query su file sicuri usando un modello di nome e una condizione sulle proprietà del file.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Aggiornare le destinazioni di distribuzione in un gruppo di distribuzione.
replaceAgent(TaskAgent, number, number)	Sostituire un agente. Probabilmente non si vuole chiamare direttamente questo endpoint. Usare invece lo script di configurazione dell'agente per rimuovere e riconfigurare un agente dall'organizzazione.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Sostituire una destinazione di distribuzione in un gruppo di distribuzione. In genere questo viene chiamato dallo strumento di configurazione dell'agente.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Aggiungere un gruppo di variabili.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Aggiorna i dettagli dell'agente.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aggiornare le proprietà in un pool di agenti
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)	Aggiornare un gruppo di distribuzione.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Aggiornare una destinazione di distribuzione e le relative proprietà dell'agente in un gruppo di distribuzione. In genere questo viene chiamato dallo strumento di configurazione dell'agente.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Aggiornare i tag di un elenco di destinazioni di distribuzione in un gruppo di distribuzione.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Aggiornare l'ambiente specificato.
updateSecureFile(SecureFile, string, string)	Aggiornare il nome o le proprietà di un file sicuro esistente
updateSecureFiles(SecureFile[], string)	Aggiornare le proprietà e/o i nomi di un set di file protetti. I file vengono identificati dai relativi ID. Le proprietà fornite eseguono l'override di quella esistente, ovvero non vengono unite.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Aggiornare un gruppo di attività.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Aggiornare un gruppo di variabili.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Caricare un file sicuro, includere il flusso di file nel corpo della richiesta
validateInputs(InputValidationRequest)

Dettagli costruttore

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addAgent(TaskAgent, number)

Aggiunge un agente a un pool. Probabilmente non si vuole chiamare questo endpoint direttamente. Configurare invece un agente usando il pacchetto di download dell'agente.

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

Parametri

agent: TaskAgent

Dettagli sull'agente da aggiungere

poolId: number

Pool di agenti in cui aggiungere l'agente

Restituisce

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parametri

agentCloud: TaskAgentCloud

Restituisce

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create un pool di agenti.

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

Parametri

pool: TaskAgentPool

Dettagli sul nuovo pool di agenti

Restituisce

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create una nuova coda agente per connettere un progetto a un pool di agenti.

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

Parametri

queue: TaskAgentQueue

Dettagli sulla coda da creare

project: string

ID progetto o nome del progetto

authorizePipelines: boolean

Autorizzare automaticamente questa coda quando si usa YAML

Restituisce

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create un gruppo di distribuzione.

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

Parametri

deploymentGroup: DeploymentGroupCreateParameter

Gruppo di distribuzione da creare.

project: string

ID progetto o nome del progetto

Restituisce

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parametri

machine: DeploymentMachine

project: string

ID progetto o nome del progetto

deploymentGroupId: number

Restituisce

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parametri

machineGroup: DeploymentMachineGroup

project: string

ID progetto o nome del progetto

Restituisce

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registrare una destinazione di distribuzione in un gruppo di distribuzione. In genere viene chiamato dallo strumento di configurazione dell'agente.

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

Parametri

machine: DeploymentMachine

Destinazione di distribuzione da registrare.

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui è registrata la destinazione di distribuzione.

Restituisce

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Create un ambiente.

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

Parametri

environmentCreateParameter: EnvironmentCreateParameter

Ambiente da creare.

project: string

ID progetto o nome del progetto

Restituisce

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parametri

createParameters: KubernetesResourceCreateParameters

project: string

ID progetto o nome del progetto

environmentId: number

Restituisce

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create un gruppo di attività.

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

Parametri

taskGroup: TaskGroupCreateParameter

Oggetto gruppo di attività da creare.

project: string

ID progetto o nome del progetto

Restituisce

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Aggiungere un gruppo di variabili.

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

Parametri

variableGroupParameters: VariableGroupParameters

Restituisce

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parametri

createParameters: VirtualMachineGroupCreateParameters

project: string

ID progetto o nome del progetto

environmentId: number

Restituisce

Promise<VirtualMachineGroup>

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

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

Parametri

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Restituisce

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parametri

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Restituisce

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parametri

session: TaskAgentSession

poolId: number

Restituisce

Promise<TaskAgentSession>

createTeamProject(string)

Create un nuovo progetto team.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<void>

deleteAgent(number, number)

Eliminare un agente. Probabilmente non si vuole chiamare questo endpoint direttamente. Usare invece lo script di configurazione dell'agente per rimuovere un agente dall'organizzazione.

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

Parametri

poolId: number

ID pool da cui rimuovere l'agente

agentId: number

ID agente da rimuovere

Restituisce

Promise<void>

deleteAgentCloud(number)

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

Parametri

agentCloudId: number

Restituisce

Promise<TaskAgentCloud>

deleteAgentPool(number)

Eliminare un pool di agenti.

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

Parametri

poolId: number

ID del pool di agenti da eliminare

Restituisce

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parametri

poolId: number

definitionId: number

Restituisce

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parametri

poolId: number

jobId: number

Restituisce

Promise<void>

deleteAgentQueue(number, string)

Rimuove una coda di agenti da un progetto.

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

Parametri

queueId: number

Coda dell'agente da rimuovere

project: string

ID progetto o nome del progetto

Restituisce

Promise<void>

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

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

Parametri

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Restituisce

Promise<void>

deleteAgentSession(number, string)

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

Parametri

poolId: number

sessionId: string

Restituisce

Promise<void>

deleteDeploymentGroup(string, number)

Eliminare un gruppo di distribuzione.

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione da eliminare.

Restituisce

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

machineId: number

Restituisce

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parametri

project: string

ID progetto o nome del progetto

machineGroupId: number

Restituisce

Promise<void>

deleteDeploymentTarget(string, number, number)

Eliminare una destinazione di distribuzione in un gruppo di distribuzione. In questo modo l'agente viene eliminato anche dal pool di distribuzione associato.

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui viene eliminata la destinazione di distribuzione.

targetId: number

ID della destinazione di distribuzione da eliminare.

Restituisce

Promise<void>

deleteEnvironment(string, number)

Eliminare l'ambiente specificato.

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

Parametri

project: string

ID progetto o nome del progetto

environmentId: number

ID dell'ambiente.

Restituisce

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parametri

project: string

ID progetto o nome del progetto

environmentId: number

resourceId: number

Restituisce

Promise<void>

deleteMessage(number, number, string)

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

Parametri

poolId: number

messageId: number

sessionId: string

Restituisce

Promise<void>

deleteSecureFile(string, string)

Eliminare un file sicuro

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

Parametri

project: string

ID progetto o nome del progetto

secureFileId: string

ID file sicuro univoco

Restituisce

Promise<void>

deleteTaskDefinition(string)

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

Parametri

taskId: string

Restituisce

Promise<void>

deleteTaskGroup(string, string, string)

Eliminare un gruppo di attività.

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

Parametri

project: string

ID progetto o nome del progetto

taskGroupId: string

ID del gruppo di attività da eliminare.

comment: string

Commenti da eliminare.

Restituisce

Promise<void>

deleteVariableGroup(number, string[])

Eliminare un gruppo di variabili

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

Parametri

groupId: number

ID del gruppo di variabili.

projectIds: string[]

Restituisce

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parametri

project: string

ID progetto o nome del progetto

environmentId: number

resourceId: number

Restituisce

Promise<void>

downloadSecureFile(string, string, string, boolean)

Scaricare un file sicuro in base all'ID

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

Parametri

project: string

ID progetto o nome del progetto

secureFileId: string

ID file sicuro univoco

ticket: string

Un ticket di download valido

download: boolean

Se il download è true, il file viene inviato come allegato nel corpo della risposta. Se download è false, il corpo della risposta contiene il flusso di file.

Restituisce

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

OTTENERE un token PAT per la gestione (configurazione, rimozione, assegnazione di tag) alle destinazioni di distribuzione in un gruppo di distribuzione.

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui vengono gestite le destinazioni di distribuzione.

Restituisce

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parametri

project: string

ID progetto o nome del progetto

machineGroupId: number

Restituisce

Promise<string>

generateDeploymentPoolAccessToken(number)

OTTENERE un token PAT per la gestione (configurazione, rimozione, assegnazione di tag) agli agenti di distribuzione in un pool di distribuzione.

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

Parametri

poolId: number

ID del pool di distribuzione in cui vengono gestiti gli agenti di distribuzione.

Restituisce

Promise<string>

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

Ottenere informazioni su un agente.

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

Parametri

poolId: number

Pool di agenti contenente l'agente

agentId: number

ID agente per ottenere informazioni su

includeCapabilities: boolean

Indica se includere le funzionalità dell'agente nella risposta

includeAssignedRequest: boolean

Indica se includere i dettagli sul lavoro corrente dell'agente

includeLastCompletedRequest: boolean

Indica se includere i dettagli sul lavoro più recente completato degli agenti

propertyFilters: string[]

Filtrare le proprietà personalizzate che verranno restituite

Restituisce

Promise<TaskAgent>

getAgentCloud(number)

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

Parametri

agentCloudId: number

Restituisce

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parametri

agentCloudId: number

Restituisce

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Restituisce

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Ottenere i tipi di cloud dell'agente.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Restituisce

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Ottenere informazioni su un pool di agenti.

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

Parametri

poolId: number

ID pool di agenti

properties: string[]

Proprietà del pool di agenti (delimitate da virgole)

actionFilter: TaskAgentPoolActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parametri

poolId: number

definitionId: number

Restituisce

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parametri

poolId: number

Restituisce

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parametri

poolId: number

jobId: number

Restituisce

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parametri

poolId: number

jobId: number

Restituisce

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parametri

poolId: number

definitionId: number

Restituisce

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parametri

poolId: number

Restituisce

Promise<string>

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

Ottenere un elenco di pool di agenti.

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

Parametri

poolName: string

Filtrare per nome

properties: string[]

Filtrare in base alle proprietà del pool di agenti (delimitate da virgole)

poolType: TaskAgentPoolType

Filtrare in base al tipo di pool

actionFilter: TaskAgentPoolActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Ottenere un elenco di pool di agenti.

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

Parametri

poolIds: number[]

ID pool da recuperare

actionFilter: TaskAgentPoolActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Ottenere informazioni su una coda dell'agente.

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

Parametri

queueId: number

Coda dell'agente per ottenere informazioni su

project: string

ID progetto o nome del progetto

actionFilter: TaskAgentQueueActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Ottenere un elenco di code dell'agente.

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

Parametri

project: string

ID progetto o nome del progetto

queueName: string

Filtrare in base al nome della coda dell'agente

actionFilter: TaskAgentQueueActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Ottenere un elenco di code di agenti in base agli ID

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

Parametri

queueIds: number[]

Elenco delimitato da virgole di ID coda agente da recuperare

project: string

ID progetto o nome del progetto

actionFilter: TaskAgentQueueActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Ottenere un elenco di code di agenti in base ai nomi

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

Parametri

queueNames: string[]

Elenco delimitato da virgole di nomi di agenti da recuperare

project: string

ID progetto o nome del progetto

actionFilter: TaskAgentQueueActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Ottenere un elenco di code agente in base agli ID del pool

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

Parametri

poolIds: number[]

Elenco delimitato da virgole di ID pool per ottenere le code corrispondenti per

project: string

ID progetto o nome del progetto

actionFilter: TaskAgentQueueActionFilter

Filtrare in base al fatto che l'utente chiamante disponga di autorizzazioni di utilizzo o gestione

Restituisce

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parametri

poolId: number

requestId: number

includeStatus: boolean

Restituisce

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parametri

poolId: number

top: number

continuationToken: string

Restituisce

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parametri

poolId: number

agentId: number

completedRequestCount: number

Restituisce

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parametri

poolId: number

agentIds: number[]

completedRequestCount: number

Restituisce

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

machineId: number

completedRequestCount: number

Restituisce

Promise<TaskAgentJobRequest[]>

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

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Restituisce

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Ottenere le richieste dell'agente per una destinazione di distribuzione.

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

Parametri

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione a cui appartiene la destinazione.

targetId: number

ID della destinazione di distribuzione.

completedRequestCount: number

Numero massimo di richieste completate da restituire. Il valore predefinito è 50

Restituisce

Promise<TaskAgentJobRequest[]>

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

Ottenere le richieste dell'agente per le destinazioni di distribuzione di un elenco.

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione a cui appartengono le destinazioni.

targetIds: number[]

Elenco delimitato da virgole degli ID delle destinazioni di distribuzione.

ownerId: number

ID del proprietario della richiesta di processo dell'agente.

completedOn: Date

Datetime per restituire la richiesta dopo questa volta.

completedRequestCount: number

Numero massimo di richieste completate da restituire per ogni destinazione. Il valore predefinito è 50

Restituisce

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parametri

poolId: number

planId: string

jobId: string

Restituisce

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parametri

project: string

ID progetto o nome progetto

queueId: number

top: number

continuationToken: string

Restituisce

Promise<PagedList<TaskAgentJobRequest>>

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

Ottenere un elenco di agenti.

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

Parametri

poolId: number

Pool di agenti contenente gli agenti

agentName: string

Filtro sul nome dell'agente

includeCapabilities: boolean

Se includere le funzionalità degli agenti nella risposta

includeAssignedRequest: boolean

Indica se includere dettagli sul lavoro corrente degli agenti

includeLastCompletedRequest: boolean

Indica se includere i dettagli sul lavoro più recente completato degli agenti

propertyFilters: string[]

Filtrare le proprietà personalizzate restituite

demands: string[]

Filtra in base alle richieste che gli agenti possono soddisfare

Restituisce

Promise<TaskAgent[]>

getAzureManagementGroups()

Restituisce l'elenco delle sottoscrizioni di Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Restituisce

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Restituisce l'elenco delle sottoscrizioni di Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Restituisce

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Ottenere un gruppo di distribuzione in base al relativo ID.

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione.

actionFilter: DeploymentGroupActionFilter

Ottenere il gruppo di distribuzione solo se questa azione può essere eseguita.

expand: DeploymentGroupExpands

Includere questi dettagli aggiuntivi nell'oggetto restituito.

Restituisce

Promise<DeploymentGroup>

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

Ottenere un elenco di gruppi di distribuzione in base al nome o agli ID.

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

Parametri

project: string

ID progetto o nome progetto

name: string

Nome del gruppo di distribuzione.

actionFilter: DeploymentGroupActionFilter

Ottenere solo i gruppi di distribuzione in cui è possibile eseguire questa azione.

expand: DeploymentGroupExpands

Includere questi dettagli aggiuntivi negli oggetti restituiti.

continuationToken: string

Ottenere gruppi di distribuzione con nomi maggiori di questa continuazioneToken lexicograficamente.

top: number

Numero massimo di gruppi di distribuzione da restituire. Il valore predefinito è 1000.

ids: number[]

Elenco delimitato da virgole di ID dei gruppi di distribuzione.

Restituisce

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Ottenere un elenco delle metriche del gruppo di distribuzione.

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupName: string

Nome del gruppo di distribuzione.

continuationToken: string

Ottenere le metriche per i gruppi di distribuzione con nomi maggiori di questa continuazioneToken lexicograficamente.

top: number

Numero massimo di metriche del gruppo di distribuzione da restituire. Il valore predefinito è 50.

Restituisce

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Restituisce

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parametri

project: string

ID progetto o nome progetto

machineGroupId: number

actionFilter: MachineGroupActionFilter

Restituisce

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parametri

project: string

ID progetto o nome progetto

machineGroupId: number

tagFilters: string[]

Restituisce

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parametri

project: string

ID progetto o nome progetto

machineGroupName: string

actionFilter: MachineGroupActionFilter

Restituisce

Promise<DeploymentMachineGroup[]>

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

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Restituisce

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Ottenere un elenco di riepiloghi del pool di distribuzione.

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

Parametri

poolName: string

Nome del pool di distribuzione.

expands: DeploymentPoolSummaryExpands

Includere questi dettagli aggiuntivi negli oggetti restituiti.

poolIds: number[]

Elenco degli ID pool di distribuzione.

Restituisce

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Ottenere una destinazione di distribuzione in base al relativo ID in un gruppo di distribuzione

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione a cui appartiene la destinazione di distribuzione.

targetId: number

ID della destinazione di distribuzione da restituire.

expand: DeploymentTargetExpands

Includere questi dettagli aggiuntivi negli oggetti restituiti.

Restituisce

Promise<DeploymentMachine>

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

Ottenere un elenco di destinazioni di distribuzione in un gruppo di distribuzione.

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione.

tags: string[]

Ottenere solo le destinazioni di distribuzione che contengono tutti questi elenchi di tag partiati da virgole.

name: string

Modello di nome delle destinazioni di distribuzione da restituire.

partialNameMatch: boolean

Se impostato su true, considera il nome come modello. Else lo considera come corrispondenza assoluta. Il valore predefinito è false.

expand: DeploymentTargetExpands

Includere questi dettagli aggiuntivi negli oggetti restituiti.

agentStatus: TaskAgentStatusFilter

Ottenere solo le destinazioni di distribuzione con questo stato.

agentJobResult: TaskAgentJobResultFilter

Ottenere solo le destinazioni di distribuzione con questo ultimo risultato del processo.

continuationToken: string

Ottenere le destinazioni di distribuzione con nomi maggiori di questa continuazioneToken lexicograficamente.

top: number

Numero massimo di destinazioni di distribuzione da restituire. Il valore predefinito è 1000.

enabled: boolean

Ottenere solo destinazioni di distribuzione abilitate o disabilitate. Il valore predefinito è "Null" che restituisce tutte le destinazioni.

propertyFilters: string[]

Restituisce

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Ottenere un ambiente in base all'ID.

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

Parametri

project: string

ID progetto o nome progetto

environmentId: number

ID dell'ambiente.

expands: EnvironmentExpands

Includere questi dettagli aggiuntivi negli oggetti restituiti.

Restituisce

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Ottenere la cronologia di esecuzione della distribuzione dell'ambiente

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

Parametri

project: string

ID progetto o nome progetto

environmentId: number

continuationToken: string

top: number

Restituisce

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Ottenere tutti gli ambienti.

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

Parametri

project: string

ID progetto o nome progetto

name: string

continuationToken: string

top: number

Restituisce

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parametri

project: string

ID progetto o nome progetto

environmentId: number

resourceId: number

Restituisce

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parametri

poolId: number

sessionId: string

lastMessageId: number

Restituisce

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parametri

packageType: string

platform: string

version: string

Restituisce

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parametri

packageType: string

platform: string

top: number

Restituisce

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Restituisce

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parametri

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Restituisce

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Ottenere un file sicuro

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

Parametri

project: string

ID progetto o nome progetto

secureFileId: string

ID file sicuro univoco

includeDownloadTicket: boolean

Se includeDownloadTicket è true e il chiamante dispone delle autorizzazioni, un ticket di download viene incluso nella risposta.

actionFilter: SecureFileActionFilter

Restituisce

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Ottenere file sicuri

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

Parametri

project: string

ID progetto o nome progetto

namePattern: string

Nome del file sicuro da corrispondere. Può includere caratteri jolly per corrispondere a più file.

includeDownloadTickets: boolean

Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, un ticket di download per ogni file sicuro viene incluso nella risposta.

actionFilter: SecureFileActionFilter

Filtrare in base alle autorizzazioni di file sicure per Visualizzare, Gestire o Usare l'azione . Impostazione predefinita per visualizzare.

Restituisce

Promise<SecureFile[]>

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

Ottenere file sicuri

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

Parametri

project: string

ID progetto o nome progetto

secureFileIds: string[]

Elenco di ID file sicuri

includeDownloadTickets: boolean

Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, un ticket di download per ogni file sicuro viene incluso nella risposta.

actionFilter: SecureFileActionFilter

Restituisce

Promise<SecureFile[]>

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

Ottenere file sicuri

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

Parametri

project: string

ID progetto o nome progetto

secureFileNames: string[]

Elenco di ID file sicuri

includeDownloadTickets: boolean

Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, un ticket di download per ogni file sicuro viene incluso nella risposta.

actionFilter: SecureFileActionFilter

Restituisce

Promise<SecureFile[]>

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

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

Parametri

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Restituisce

Promise<ArrayBuffer>

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

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

Parametri

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Restituisce

Promise<TaskDefinition>

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

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

Parametri

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Restituisce

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Ottenere il gruppo di attività.

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

Parametri

project: string

ID progetto o nome progetto

taskGroupId: string

ID del gruppo di attività.

versionSpec: string

specifica della versione del gruppo di attività. esempi: 1, 1,0.

expand: TaskGroupExpands

Proprietà che devono essere espanse. l'esempio $expand=Attività espanderà i gruppi di attività annidati.

Restituisce

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parametri

project: string

ID progetto o nome progetto

taskGroupId: string

Restituisce

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parametri

project: string

ID progetto o nome progetto

taskGroupId: string

revision: number

Restituisce

Promise<string>

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

Elencare i gruppi di attività.

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

Parametri

project: string

ID progetto o nome progetto

taskGroupId: string

ID del gruppo di attività.

expanded: boolean

'true' per espandere in modo ricorsivo i gruppi di attività. Il valore predefinito è 'false'.

taskIdFilter: string

Guid dell'oggetto taskId da filtrare.

deleted: boolean

'true'per includere gruppi di attività eliminati. Il valore predefinito è 'false'.

top: number

Numero di gruppi di attività da ottenere.

continuationToken: Date

Ottiene i gruppi di attività dopo il token di continuazione specificato.

queryOrder: TaskGroupQueryOrder

Ottiene i risultati nell'ordine definito. Il valore predefinito è 'CreateOnDescending'.

Restituisce

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parametri

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Restituisce

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Ottenere un gruppo di variabili.

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

Parametri

project: string

ID progetto o nome progetto

groupId: number

ID del gruppo di variabili.

Restituisce

Promise<VariableGroup>

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

Ottenere gruppi di variabili.

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

Parametri

project: string

ID progetto o nome progetto

groupName: string

Nome del gruppo di variabili.

actionFilter: VariableGroupActionFilter

Filtro azione per il gruppo di variabili. Specifica l'azione che può essere eseguita sui gruppi di variabili.

top: number

Numero di gruppi di variabili da ottenere.

continuationToken: number

Ottiene i gruppi di variabili dopo il token di continuazione specificato.

queryOrder: VariableGroupQueryOrder

Ottiene i risultati nell'ordine definito. Il valore predefinito è 'IdCrescente'.

Restituisce

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Ottenere gruppi di variabili in base agli ID.

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

Parametri

project: string

ID progetto o nome progetto

groupIds: number[]

Elenco delimitato da virgole di ID di gruppi di variabili.

loadSecrets: boolean

Flag che indica se i segreti all'interno dei gruppi di variabili devono essere caricati.

Restituisce

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parametri

project: string

ID progetto o nome progetto

environmentId: number

resourceId: number

Restituisce

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

Parametri

project: string

ID progetto o nome progetto

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Restituisce

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Restituisce

Promise<string>

getYamlSchema(boolean)

GET lo schema Yaml usato per la convalida dei file Yaml.

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

Parametri

validateTaskNames: boolean

Se lo schema deve verificare che le attività siano effettivamente installate (utili per gli strumenti offline in cui non si vuole convalidare).

Restituisce

Promise<any>

hasPoolPermissions(number, number)

Verifica se l'identità corrente ha passato le autorizzazioni in un pool.

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

Parametri

poolId: number

ID del pool da controllare

permissions: number

Autorizzazioni da controllare. È possibile unire più autorizzazioni in un singolo valore usando l'operatore OR bit per bit (ad esempio AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Restituisce

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parametri

taskGroupMetadata: PublishTaskGroupMetadata

project: string

ID progetto o nome progetto

parentTaskGroupId: string

Restituisce

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy per una richiesta GET definita da un 'endpoint'. La richiesta è autorizzata usando una connessione al servizio. La risposta viene filtrata usando un selettore basato su XPath/Json.

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

Parametri

endpoint: TaskDefinitionEndpoint

Descrive l'URL da recuperare.

Restituisce

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Eseguire query su file sicuri usando un modello di nome e una condizione sulle proprietà del file.

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

Parametri

condition: string

La sintassi della condizione principale è descritta qui. Utilizzare la funzione property('property-name') per accedere al valore della proprietà specificata di un file sicuro. Restituisce Null se la proprietà non è impostata. Ad esempio and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

ID progetto o nome progetto

namePattern: string

Nome del file sicuro da corrispondere. Può includere caratteri jolly per corrispondere a più file.

Restituisce

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parametri

job: TaskAgentPoolMaintenanceJob

poolId: number

Restituisce

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parametri

request: TaskAgentJobRequest

project: string

ID progetto o nome progetto

queueId: number

Restituisce

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parametri

request: TaskAgentJobRequest

poolId: number

Restituisce

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parametri

poolId: number

agentId: number

Restituisce

Promise<void>

refreshAgents(number)

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

Parametri

poolId: number

Restituisce

Promise<void>

refreshDeploymentMachines(string, number)

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

Restituisce

Promise<void>

refreshDeploymentTargets(string, number)

Aggiornare le destinazioni di distribuzione in un gruppo di distribuzione.

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

Parametri

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione.

Restituisce

Promise<void>

replaceAgent(TaskAgent, number, number)

Sostituire un agente. Probabilmente non si vuole chiamare direttamente questo endpoint. Usare invece lo script di configurazione dell'agente per rimuovere e riconfigurare un agente dall'organizzazione.

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

Parametri

agent: TaskAgent

Dettagli aggiornati sull'agente di sostituzione

poolId: number

Pool di agenti da usare

agentId: number

Agente da sostituire

Restituisce

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametri

machine: DeploymentMachine

project: string

ID progetto o nome progetto

deploymentGroupId: number

machineId: number

Restituisce

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Sostituire una destinazione di distribuzione in un gruppo di distribuzione. In genere questo viene chiamato dallo strumento di configurazione dell'agente.

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

Parametri

machine: DeploymentMachine

Nuova destinazione di distribuzione.

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui viene sostituita la destinazione di distribuzione.

targetId: number

ID della destinazione di distribuzione da sostituire.

Restituisce

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parametri

message: TaskAgentMessage

poolId: number

requestId: number

Restituisce

Promise<void>

setAgentPoolMetadata(any, number)

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

Parametri

agentPoolMetadata: any

poolId: number

Restituisce

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Aggiungere un gruppo di variabili.

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

Parametri

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Restituisce

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parametri

taskGroup: TaskGroup

project: string

ID progetto o nome progetto

Restituisce

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Aggiorna i dettagli dell'agente.

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

Parametri

agent: TaskAgent

Dettagli aggiornati sull'agente

poolId: number

Pool di agenti da usare

agentId: number

Agente da aggiornare

Restituisce

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parametri

updatedCloud: TaskAgentCloud

agentCloudId: number

Restituisce

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Aggiornare le proprietà in un pool di agenti

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

Parametri

pool: TaskAgentPool

Dettagli del pool di agenti aggiornati

poolId: number

Pool di agenti da aggiornare

Restituisce

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parametri

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Restituisce

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parametri

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Restituisce

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parametri

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Restituisce

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parametri

poolId: number

agentId: number

currentState: string

Restituisce

Promise<TaskAgent>

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

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

Parametri

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Restituisce

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Aggiornare un gruppo di distribuzione.

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

Parametri

deploymentGroup: DeploymentGroupUpdateParameter

Gruppo di distribuzione da aggiornare.

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione.

Restituisce

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametri

machine: DeploymentMachine

project: string

ID progetto o nome progetto

deploymentGroupId: number

machineId: number

Restituisce

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parametri

machineGroup: DeploymentMachineGroup

project: string

ID progetto o nome progetto

machineGroupId: number

Restituisce

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parametri

deploymentMachines: DeploymentMachine[]

project: string

ID progetto o nome progetto

machineGroupId: number

Restituisce

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parametri

machines: DeploymentMachine[]

project: string

ID progetto o nome progetto

deploymentGroupId: number

Restituisce

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Aggiornare una destinazione di distribuzione e le relative proprietà dell'agente in un gruppo di distribuzione. In genere questo viene chiamato dallo strumento di configurazione dell'agente.

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

Parametri

machine: DeploymentMachine

Destinazione di distribuzione da aggiornare.

project: string

ID progetto o nome progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui viene aggiornata la destinazione di distribuzione.

targetId: number

ID della destinazione di distribuzione da aggiornare.

Restituisce

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Aggiornare i tag di un elenco di destinazioni di distribuzione in un gruppo di distribuzione.

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

Parametri

machines: DeploymentTargetUpdateParameter[]

Destinazioni di distribuzione con tag da udpdate.

project: string

ID progetto o nome del progetto

deploymentGroupId: number

ID del gruppo di distribuzione in cui vengono aggiornate le destinazioni di distribuzione.

Restituisce

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Aggiornare l'ambiente specificato.

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

Parametri

environmentUpdateParameter: EnvironmentUpdateParameter

Dati dell'ambiente da aggiornare.

project: string

ID progetto o nome del progetto

environmentId: number

ID dell'ambiente.

Restituisce

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Aggiornare il nome o le proprietà di un file sicuro esistente

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

Parametri

secureFile: SecureFile

File sicuro con nome e/o proprietà aggiornati

project: string

ID progetto o nome del progetto

secureFileId: string

ID file sicuro univoco

Restituisce

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Aggiornare le proprietà e/o i nomi di un set di file protetti. I file vengono identificati dai relativi ID. Le proprietà fornite eseguono l'override di quella esistente, ovvero non vengono unite.

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

Parametri

secureFiles: SecureFile[]

Elenco di oggetti file protetti. Solo tre campi devono essere popolati id, nome e proprietà. Il resto dei campi nell'oggetto viene ignorato.

project: string

ID progetto o nome del progetto

Restituisce

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Aggiornare un gruppo di attività.

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

Parametri

taskGroup: TaskGroupUpdateParameter

Gruppo di attività da aggiornare.

project: string

ID progetto o nome del progetto

taskGroupId: string

ID del gruppo di attività da aggiornare.

Restituisce

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parametri

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

ID progetto o nome del progetto

taskGroupId: string

disablePriorVersions: boolean

Restituisce

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parametri

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Restituisce

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Aggiornare un gruppo di variabili.

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

Parametri

variableGroupParameters: VariableGroupParameters

groupId: number

ID del gruppo di variabili da aggiornare.

Restituisce

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parametri

resource: VirtualMachineGroup

project: string

ID progetto o nome del progetto

environmentId: number

Restituisce

Promise<VirtualMachineGroup>

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

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

Parametri

machines: VirtualMachine[]

project: string

ID progetto o nome del progetto

environmentId: number

resourceId: number

Restituisce

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Caricare un file sicuro, includere il flusso di file nel corpo della richiesta

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

Parametri

content: any

Contenuto da caricare

project: string

ID progetto o nome del progetto

name: string

Nome del file da caricare

authorizePipelines: boolean

Se authorizePipelines è true, il file sicuro viene autorizzato per l'uso da parte di tutte le pipeline nel progetto.

Restituisce

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parametri

inputValidationRequest: InputValidationRequest

Restituisce

Promise<InputValidationRequest>

Condividi tramite

TaskAgentRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

TaskAgentRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

addAgent(TaskAgent, number)

Parametri

Restituisce

addAgentCloud(TaskAgentCloud)

Parametri

Restituisce

addAgentPool(TaskAgentPool)

Parametri

Restituisce

addAgentQueue(TaskAgentQueue, string, boolean)

Parametri

Restituisce

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parametri

Restituisce

addDeploymentMachine(DeploymentMachine, string, number)

Parametri

Restituisce

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parametri

Restituisce

addDeploymentTarget(DeploymentMachine, string, number)

Parametri

Restituisce

addEnvironment(EnvironmentCreateParameter, string)

Parametri

Restituisce

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parametri

Restituisce

addTaskGroup(TaskGroupCreateParameter, string)

Parametri

Restituisce

addVariableGroup(VariableGroupParameters)

Parametri

Restituisce

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parametri

Restituisce

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

Parametri

Restituisce

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parametri

Restituisce

createAgentSession(TaskAgentSession, number)

Parametri

Restituisce

createTeamProject(string)

Parametri

Restituisce

deleteAgent(number, number)

Parametri

Restituisce

deleteAgentCloud(number)

Parametri

Restituisce

deleteAgentPool(number)

Parametri

Restituisce

deleteAgentPoolMaintenanceDefinition(number, number)

Parametri

Restituisce

deleteAgentPoolMaintenanceJob(number, number)

Parametri

Restituisce

deleteAgentQueue(number, string)

Parametri