TaskAgentRestClient class
Classe di base da usare (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Task |
Proprietà
| RESOURCE_AREA_ID |
Metodi
Dettagli costruttore
TaskAgentRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd" = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"Valore della proprietà
"a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"
Dettagli metodo
addAgent(TaskAgent, number)
Aggiunge un agente a un pool. Probabilmente non si vuole chiamare direttamente questo endpoint. Al contrario, configurare un agente usando il pacchetto di download dell'agente.
function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>Parametri
- agent
- TaskAgent
Dettagli sull'aggiunta dell'agente
- poolId
-
number
Pool di agenti in cui aggiungere l'agente
Valori restituiti
Promise<TaskAgent>
addAgentCloud(TaskAgentCloud)
function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>Parametri
- agentCloud
- TaskAgentCloud
Valori restituiti
Promise<TaskAgentCloud>
addAgentPool(TaskAgentPool)
Crea un pool di agenti.
function addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>Parametri
- pool
- TaskAgentPool
Dettagli sul nuovo pool di agenti
Valori restituiti
Promise<TaskAgentPool>
addAgentQueue(TaskAgentQueue, string, boolean)
Crea una nuova coda di agenti per collegare 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 progetto
- authorizePipelines
-
boolean
Autorizza automaticamente questa coda quando usi YAML
Valori restituiti
Promise<TaskAgentQueue>
addDeploymentGroup(DeploymentGroupCreateParameter, string)
Creare 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 progetto
Valori restituiti
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 progetto
- deploymentGroupId
-
number
Valori restituiti
Promise<DeploymentMachine>
addDeploymentMachineGroup(DeploymentMachineGroup, string)
function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>Parametri
- machineGroup
- DeploymentMachineGroup
- project
-
string
ID progetto o nome progetto
Valori restituiti
Promise<DeploymentMachineGroup>
addDeploymentTarget(DeploymentMachine, string, number)
Registra un target di distribuzione su un gruppo di deployment. Generalmente questo viene chiamato dallo strumento di configurazione agente.
function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>Parametri
- machine
- DeploymentMachine
Target di dispiegamento da registrare.
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione a cui è registrato il target di distribuzione.
Valori restituiti
Promise<DeploymentMachine>
addEnvironment(EnvironmentCreateParameter, string)
Creare un ambiente.
function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>Parametri
- environmentCreateParameter
- EnvironmentCreateParameter
Ambiente da creare.
- project
-
string
ID progetto o nome progetto
Valori restituiti
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 progetto
- environmentId
-
number
Valori restituiti
Promise<KubernetesResource>
addTaskGroup(TaskGroupCreateParameter, string)
Crea un gruppo di lavoro.
function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>Parametri
- taskGroup
- TaskGroupCreateParameter
Oggetto del gruppo di lavoro da creare.
- project
-
string
ID progetto o nome progetto
Valori restituiti
Promise<TaskGroup>
addVariableGroup(VariableGroupParameters)
Aggiungi un gruppo variabile.
function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>Parametri
- variableGroupParameters
- VariableGroupParameters
Valori restituiti
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 progetto
- environmentId
-
number
Valori restituiti
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
Valori restituiti
Promise<string>
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parametri
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceDefinition>
createAgentSession(TaskAgentSession, number)
function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>Parametri
- session
- TaskAgentSession
- poolId
-
number
Valori restituiti
Promise<TaskAgentSession>
createTeamProject(string)
Crea un nuovo progetto di squadra.
function createTeamProject(project?: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
Valori restituiti
Promise<void>
deleteAgent(number, number)
Eliminare un agente. Probabilmente non si vuole chiamare direttamente questo endpoint. Invece, usa lo script di configurazione dell'agente per rimuovere un agente dalla tua organizzazione.
function deleteAgent(poolId: number, agentId: number): Promise<void>Parametri
- poolId
-
number
L'ID del pool da rimuovere l'agente
- agentId
-
number
L'ID dell'agente da rimuovere
Valori restituiti
Promise<void>
deleteAgentCloud(number)
function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>Parametri
- agentCloudId
-
number
Valori restituiti
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
Valori restituiti
Promise<void>
deleteAgentPoolMaintenanceDefinition(number, number)
function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>Parametri
- poolId
-
number
- definitionId
-
number
Valori restituiti
Promise<void>
deleteAgentPoolMaintenanceJob(number, number)
function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>Parametri
- poolId
-
number
- jobId
-
number
Valori restituiti
Promise<void>
deleteAgentQueue(number, string)
Rimuove una coda di agente da un progetto.
function deleteAgentQueue(queueId: number, project?: string): Promise<void>Parametri
- queueId
-
number
La coda degli agenti per rimuovere
- project
-
string
ID progetto o nome progetto
Valori restituiti
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
Valori restituiti
Promise<void>
deleteAgentSession(number, string)
function deleteAgentSession(poolId: number, sessionId: string): Promise<void>Parametri
- poolId
-
number
- sessionId
-
string
Valori restituiti
Promise<void>
deleteDeploymentGroup(string, number)
Elimina un gruppo di deployment.
function deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione da eliminare.
Valori restituiti
Promise<void>
deleteDeploymentMachine(string, number, number)
function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
- machineId
-
number
Valori restituiti
Promise<void>
deleteDeploymentMachineGroup(string, number)
function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- machineGroupId
-
number
Valori restituiti
Promise<void>
deleteDeploymentTarget(string, number, number)
Elimina un target di distribuzione in un gruppo di deployment. Questo elimina anche l'agente dal pool di distribuzione associato.
function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione in cui viene eliminato il target di distribuzione.
- targetId
-
number
ID del target di distribuzione da eliminare.
Valori restituiti
Promise<void>
deleteEnvironment(string, number)
Elimina l'ambiente specificato.
function deleteEnvironment(project: string, environmentId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- environmentId
-
number
ID dell'ambiente.
Valori restituiti
Promise<void>
deleteKubernetesResource(string, number, number)
function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- environmentId
-
number
- resourceId
-
number
Valori restituiti
Promise<void>
deleteMessage(number, number, string)
function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>Parametri
- poolId
-
number
- messageId
-
number
- sessionId
-
string
Valori restituiti
Promise<void>
deleteSecureFile(string, string)
Eliminare un file sicuro
function deleteSecureFile(project: string, secureFileId: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- secureFileId
-
string
ID file sicuro univoco
Valori restituiti
Promise<void>
deleteTaskDefinition(string)
function deleteTaskDefinition(taskId: string): Promise<void>Parametri
- taskId
-
string
Valori restituiti
Promise<void>
deleteTaskGroup(string, string, string)
Elimina un gruppo di lavoro.
function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- taskGroupId
-
string
ID del gruppo di lavoro da cancellare.
- comment
-
string
Commenti da eliminare.
Valori restituiti
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[]
Valori restituiti
Promise<void>
deleteVirtualMachineGroup(string, number, number)
function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- environmentId
-
number
- resourceId
-
number
Valori restituiti
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 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 il download è false, il corpo della risposta contiene il flusso di file.
Valori restituiti
Promise<ArrayBuffer>
generateDeploymentGroupAccessToken(string, number)
GET un token PAT per gestire (configurare, rimuovere, etichettare) i target di distribuzione in un gruppo di deployment.
function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione in cui sono gestiti i target di distribuzione.
Valori restituiti
Promise<string>
generateDeploymentMachineGroupAccessToken(string, number)
function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- machineGroupId
-
number
Valori restituiti
Promise<string>
generateDeploymentPoolAccessToken(number)
OTTIENI un token PAT per gestire (configurare, rimuovere, etichettare) gli agenti di distribuzione in un pool di distribuzione.
function generateDeploymentPoolAccessToken(poolId: number): Promise<string>Parametri
- poolId
-
number
ID del pool di distribuzione in cui sono gestiti gli agenti di distribuzione.
Valori restituiti
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 completato più recente degli agenti
- propertyFilters
-
string[]
Filtrare le proprietà personalizzate che verranno restituite
Valori restituiti
Promise<TaskAgent>
getAgentCloud(number)
function getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>Parametri
- agentCloudId
-
number
Valori restituiti
Promise<TaskAgentCloud>
getAgentCloudRequests(number)
function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>Parametri
- agentCloudId
-
number
Valori restituiti
Promise<TaskAgentCloudRequest[]>
getAgentClouds()
getAgentCloudTypes()
Prendi i tipi cloud degli agenti.
function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>Valori restituiti
Promise<TaskAgentCloudType[]>
getAgentPool(number, string[], TaskAgentPoolActionFilter)
Ottieni informazioni su un pool di agenti.
function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>Parametri
- poolId
-
number
Un ID pool di agenti
- properties
-
string[]
Proprietà del pool di agenti (separate tra virgole)
- actionFilter
- TaskAgentPoolActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentPool>
getAgentPoolMaintenanceDefinition(number, number)
function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parametri
- poolId
-
number
- definitionId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceDefinition>
getAgentPoolMaintenanceDefinitions(number)
function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>Parametri
- poolId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceDefinition[]>
getAgentPoolMaintenanceJob(number, number)
function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>Parametri
- poolId
-
number
- jobId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceJob>
getAgentPoolMaintenanceJobLogs(number, number)
function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>Parametri
- poolId
-
number
- jobId
-
number
Valori restituiti
Promise<ArrayBuffer>
getAgentPoolMaintenanceJobs(number, number)
function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>Parametri
- poolId
-
number
- definitionId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceJob[]>
getAgentPoolMetadata(number)
function getAgentPoolMetadata(poolId: number): Promise<string>Parametri
- poolId
-
number
Valori restituiti
Promise<string>
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)
Ottieni una lista dei pool di agenti.
function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>Parametri
- poolName
-
string
Filtrare per nome
- properties
-
string[]
Filtra per proprietà del pool di agenti (separato per virgole)
- poolType
- TaskAgentPoolType
Filtra per tipo di pool
- actionFilter
- TaskAgentPoolActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentPool[]>
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)
Ottieni una lista dei pool di agenti.
function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>Parametri
- poolIds
-
number[]
ID pool da recuperare
- actionFilter
- TaskAgentPoolActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentPool[]>
getAgentQueue(number, string, TaskAgentQueueActionFilter)
Ottieni informazioni sulla coda degli agenti.
function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>Parametri
- queueId
-
number
La coda degli agenti per ottenere informazioni su
- project
-
string
ID progetto o nome progetto
- actionFilter
- TaskAgentQueueActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentQueue>
getAgentQueues(string, string, TaskAgentQueueActionFilter)
Fai una lista delle code degli agenti.
function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parametri
- project
-
string
ID progetto o nome progetto
- queueName
-
string
Filtra sul nome della coda dell'agente
- actionFilter
- TaskAgentQueueActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentQueue[]>
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)
Ottieni una lista delle code degli agenti in base ai loro ID
function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parametri
- queueIds
-
number[]
Una lista separata da virgole di ID della coda degli agenti da recuperare
- project
-
string
ID progetto o nome progetto
- actionFilter
- TaskAgentQueueActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentQueue[]>
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)
Ottieni una lista delle code degli agenti con i loro nomi
function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parametri
- queueNames
-
string[]
Una lista separata da virgole di nomi di agenti da recuperare
- project
-
string
ID progetto o nome progetto
- actionFilter
- TaskAgentQueueActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentQueue[]>
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)
Ottieni una lista delle code degli agenti per ID del pool
function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parametri
- poolIds
-
number[]
Una lista separata da virgole di ID pool per ottenere le corrispondenti code per
- project
-
string
ID progetto o nome progetto
- actionFilter
- TaskAgentQueueActionFilter
Filtra in base al fatto che l'utente chiamante abbia permessi di utilizzo o di gestione
Valori restituiti
Promise<TaskAgentQueue[]>
getAgentRequest(number, number, boolean)
function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>Parametri
- poolId
-
number
- requestId
-
number
- includeStatus
-
boolean
Valori restituiti
Promise<TaskAgentJobRequest>
getAgentRequests(number, number, string)
function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>Parametri
- poolId
-
number
- top
-
number
- continuationToken
-
string
Valori restituiti
Promise<PagedList<TaskAgentJobRequest>>
getAgentRequestsForAgent(number, number, number)
function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parametri
- poolId
-
number
- agentId
-
number
- completedRequestCount
-
number
Valori restituiti
Promise<TaskAgentJobRequest[]>
getAgentRequestsForAgents(number, number[], number)
function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parametri
- poolId
-
number
- agentIds
-
number[]
- completedRequestCount
-
number
Valori restituiti
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 progetto
- deploymentGroupId
-
number
- machineId
-
number
- completedRequestCount
-
number
Valori restituiti
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 progetto
- deploymentGroupId
-
number
- machineIds
-
number[]
- completedRequestCount
-
number
Valori restituiti
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTarget(string, number, number, number)
Ricevi richieste degli agenti per un target di deployment.
function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione a cui appartiene il bersaglio.
- targetId
-
number
ID del target di dispiegamento.
- completedRequestCount
-
number
Numero massimo di richieste completate da restituire. Il valore predefinito è 50
Valori restituiti
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)
Ricevi richieste di agente per una lista di obiettivi di deployment.
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 i bersagli.
- targetIds
-
number[]
La virgola separava l'elenco degli ID dei target di dispiegamento.
- ownerId
-
number
ID del proprietario dell'agente richiedendo lavoro.
- completedOn
-
Date
Data per il ritorno, richiesta dopo questo orario.
- completedRequestCount
-
number
Numero massimo di richieste completate da restituire per ogni target. Il valore predefinito è 50
Valori restituiti
Promise<TaskAgentJobRequest[]>
getAgentRequestsForPlan(number, string, string)
function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>Parametri
- poolId
-
number
- planId
-
string
- jobId
-
string
Valori restituiti
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
Valori restituiti
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
Filtrare in base al nome dell'agente
- includeCapabilities
-
boolean
Indica se includere le funzionalità degli agenti nella risposta
- includeAssignedRequest
-
boolean
Indica se includere i dettagli sul lavoro corrente degli agenti
- includeLastCompletedRequest
-
boolean
Indica se includere i dettagli sul lavoro completato più recente degli agenti
- propertyFilters
-
string[]
Filtrare le proprietà personalizzate che verranno restituite
- demands
-
string[]
Filtrare in base alle richieste che gli agenti possono soddisfare
Valori restituiti
Promise<TaskAgent[]>
getAzureManagementGroups()
Elenco dei ritorni degli abbonamenti Azure
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Valori restituiti
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Elenco dei ritorni degli abbonamenti Azure
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Valori restituiti
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 su di essa.
- expand
- DeploymentGroupExpands
Includere questi dettagli aggiuntivi nell'oggetto restituito.
Valori restituiti
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 lessicograficamente.
- 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.
Valori restituiti
Promise<PagedList<DeploymentGroup>>
getDeploymentGroupsMetrics(string, string, string, number)
Ottieni una lista delle metriche dei gruppi di deployment.
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
Ottieni metriche per i gruppi di distribuzione con nomi maggiori di questo continuationToken lessicograficamente.
- top
-
number
Numero massimo di metriche di gruppo di distribuzione da restituire. Il valore predefinito è 50.
Valori restituiti
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
Valori restituiti
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
Valori restituiti
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[]
Valori restituiti
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
Valori restituiti
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
Valori restituiti
Promise<DeploymentMachine[]>
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])
Ottieni un elenco dei riassunti dei pool di deployment.
function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>Parametri
- poolName
-
string
Nome del pool di schieramento.
- expands
- DeploymentPoolSummaryExpands
Includere questi dettagli aggiuntivi negli oggetti restituiti.
- poolIds
-
number[]
Elenco degli ID del pool di deployment.
Valori restituiti
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.
Valori restituiti
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[]
Ottiene solo le destinazioni di distribuzione che contengono tutti questi elenchi di tag delimitati da virgole.
- name
-
string
Modello di nome delle destinazioni di distribuzione da restituire.
- partialNameMatch
-
boolean
Se impostato su true, considera nome come modello. Else lo considera come corrispondenza assoluta. Il valore predefinito è false.
- expand
- DeploymentTargetExpands
Includere questi dettagli aggiuntivi negli oggetti restituiti.
- agentStatus
- TaskAgentStatusFilter
Ottiene 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 lessicograficamente.
- top
-
number
Numero massimo di destinazioni di distribuzione da restituire. Il valore predefinito è 1000.
- enabled
-
boolean
Ottiene solo le destinazioni di distribuzione abilitate o disabilitate. Il valore predefinito è 'null' che restituisce tutte le destinazioni.
- propertyFilters
-
string[]
Valori restituiti
Promise<PagedList<DeploymentMachine>>
getEnvironmentById(string, number, EnvironmentExpands)
Prendi un ambiente tramite il suo 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.
Valori restituiti
Promise<EnvironmentInstance>
getEnvironmentDeploymentExecutionRecords(string, number, string, number)
Ottieni la cronologia delle esecuzioni della distribuzione in 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
Valori restituiti
getEnvironments(string, string, string, number)
Procurati 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
Valori restituiti
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
Valori restituiti
Promise<KubernetesResource>
getMessage(number, string, number)
function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>Parametri
- poolId
-
number
- sessionId
-
string
- lastMessageId
-
number
Valori restituiti
Promise<TaskAgentMessage>
getPackage(string, string, string)
function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>Parametri
- packageType
-
string
- platform
-
string
- version
-
string
Valori restituiti
Promise<PackageMetadata>
getPackages(string, string, number)
function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>Parametri
- packageType
-
string
- platform
-
string
- top
-
number
Valori restituiti
Promise<PackageMetadata[]>
getResourceLimits()
getResourceUsage(string, boolean, boolean)
function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>Parametri
- parallelismTag
-
string
- poolIsHosted
-
boolean
- includeRunningRequests
-
boolean
Valori restituiti
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, nella risposta viene incluso un ticket di download.
- actionFilter
- SecureFileActionFilter
Valori restituiti
Promise<SecureFile>
getSecureFiles(string, string, boolean, SecureFileActionFilter)
Ottenere file protetti
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 trovare. Può includere caratteri jolly in modo che corrispondano a più file.
- includeDownloadTickets
-
boolean
Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, nella risposta viene incluso un ticket di download per ogni file sicuro.
- actionFilter
- SecureFileActionFilter
Filtrare in base alle autorizzazioni dei file sicure per l'azione Visualizza, Gestisci o Usa. L'impostazione predefinita è Visualizza.
Valori restituiti
Promise<SecureFile[]>
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)
Ottenere file protetti
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 protetti
- includeDownloadTickets
-
boolean
Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, nella risposta viene incluso un ticket di download per ogni file sicuro.
- actionFilter
- SecureFileActionFilter
Valori restituiti
Promise<SecureFile[]>
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)
Ottenere file protetti
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 protetti
- includeDownloadTickets
-
boolean
Se includeDownloadTickets è true e il chiamante dispone delle autorizzazioni, nella risposta viene incluso un ticket di download per ogni file sicuro.
- actionFilter
- SecureFileActionFilter
Valori restituiti
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
Valori restituiti
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
Valori restituiti
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
Valori restituiti
Promise<TaskDefinition[]>
getTaskGroup(string, string, string, TaskGroupExpands)
Trova il gruppo di lavoro.
function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>Parametri
- project
-
string
ID progetto o nome progetto
- taskGroupId
-
string
Identificatore del gruppo di lavoro.
- versionSpec
-
string
Specifica della versione del gruppo di lavoro. Esempi: 1, 1.0.
- expand
- TaskGroupExpands
Le proprietà che dovrebbero essere ampliate. esempio $expand=I compiti espandono i gruppi di lavoro annidati.
Valori restituiti
Promise<TaskGroup>
getTaskGroupHistory(string, string)
function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>Parametri
- project
-
string
ID progetto o nome progetto
- taskGroupId
-
string
Valori restituiti
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
Valori restituiti
Promise<string>
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)
Elenca i gruppi di lavoro.
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
Identificatore del gruppo di lavoro.
- expanded
-
boolean
'vero' per espandere ricorsivamente i gruppi di lavoro. Il valore predefinito è 'false'.
- taskIdFilter
-
string
Guida del taskID da filtrare.
- deleted
-
boolean
'True' per includere i gruppi di attività eliminati. Il valore predefinito è 'false'.
- top
-
number
Numero di gruppi di lavoro da ottenere.
- continuationToken
-
Date
Ottiene i gruppi di lavoro dopo il token di continuazione fornito.
- queryOrder
- TaskGroupQueryOrder
Ottiene i risultati nell'ordine definito. Il predefinito è 'CreatedOnDescending'.
Valori restituiti
Promise<TaskGroup[]>
getTaskGroupsByIds({[key: string]: string[]}, string, boolean)
Organizza i gruppi di lavoro in base ai loro ID e specifiche di versione.
function getTaskGroupsByIds(groupsVersionsMap: {[key: string]: string[]}, project: string, expand?: boolean): Promise<{[key: string]: TaskAgent.TaskGroup[]}>Parametri
- groupsVersionsMap
-
{[key: string]: string[]}
Mappa ID di gruppo alle versioni.
- project
-
string
ID progetto o nome progetto
- expand
-
boolean
Le proprietà che dovrebbero essere ampliate. esempio $expand=I compiti espandono i gruppi di lavoro annidati.
Valori restituiti
Promise<{[key: string]: TaskGroup[]}>
getTaskHubLicenseDetails(string, boolean, boolean)
function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>Parametri
- hubName
-
string
- includeEnterpriseUsersCount
-
boolean
- includeHostedAgentMinutesCount
-
boolean
Valori restituiti
Promise<TaskHubLicenseDetails>
getVariableGroup(string, number)
Prendi un gruppo variabile.
function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>Parametri
- project
-
string
ID progetto o nome progetto
- groupId
-
number
ID del gruppo di variabili.
Valori restituiti
Promise<VariableGroup>
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)
Prendi gruppi 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 variabile.
- actionFilter
- VariableGroupActionFilter
Filtro delle azioni 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 fornito.
- queryOrder
- VariableGroupQueryOrder
Ottiene i risultati nell'ordine definito. Il predefinito è 'IdDescending'.
Valori restituiti
Promise<VariableGroup[]>
getVariableGroupsById(string, number[], boolean)
Ottieni i gruppi variabili per ID.
function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>Parametri
- project
-
string
ID progetto o nome progetto
- groupIds
-
number[]
Elenco separato da virgola degli ID dei gruppi di variabili.
- loadSecrets
-
boolean
Flag che indica se i segreti all'interno dei gruppi di variabili devono essere caricati.
Valori restituiti
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
Valori restituiti
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
Valori restituiti
Promise<PagedList<VirtualMachine>>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Valori restituiti
Promise<string>
getYamlSchema(boolean)
GET lo schema Yaml usato per la validazione dei file Yaml.
function getYamlSchema(validateTaskNames?: boolean): Promise<any>Parametri
- validateTaskNames
-
boolean
Se lo schema dovrebbe validare che i task sono effettivamente installati (utile per strumenti offline dove non si vuole validazione).
Valori restituiti
Promise<any>
hasPoolPermissions(number, number)
Controlla se l'identità attuale ha superato i permessi su un pool.
function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>Parametri
- poolId
-
number
Documento della piscina da controllare
- permissions
-
number
Permessi per controllare. Più permessi possono essere fusi in un unico valore usando l'operatore bit a bit OR (ad esempio AgentPoolPermissions.Manage | AgentPoolPermessi.Visualizza)
Valori restituiti
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
Valori restituiti
Promise<TaskGroup[]>
queryEndpoint(TaskDefinitionEndpoint)
Proxy per una richiesta GET definita da un 'endpoint'. La richiesta è autorizzata tramite una connessione di 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.
Valori restituiti
Promise<string[]>
querySecureFilesByProperties(string, string, string)
Eseguire query sui file protetti 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 protetto. 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 trovare. Può includere caratteri jolly in modo che corrispondano a più file.
Valori restituiti
Promise<SecureFile[]>
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>Parametri
- poolId
-
number
Valori restituiti
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
Valori restituiti
Promise<TaskAgentJobRequest>
queueAgentRequestByPool(TaskAgentJobRequest, number)
function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>Parametri
- request
- TaskAgentJobRequest
- poolId
-
number
Valori restituiti
Promise<TaskAgentJobRequest>
refreshAgent(number, number)
function refreshAgent(poolId: number, agentId: number): Promise<void>Parametri
- poolId
-
number
- agentId
-
number
Valori restituiti
Promise<void>
refreshAgents(number)
function refreshAgents(poolId: number): Promise<void>Parametri
- poolId
-
number
Valori restituiti
Promise<void>
refreshDeploymentMachines(string, number)
function refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
Valori restituiti
Promise<void>
refreshDeploymentTargets(string, number)
Aggiorna gli obiettivi di dispiegamento in un gruppo di dispiegamento.
function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione.
Valori restituiti
Promise<void>
replaceAgent(TaskAgent, number, number)
Sostituire un agente. Probabilmente non si vuole chiamare direttamente questo endpoint. Al contrario, usare 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 sostitutivo
- poolId
-
number
Pool di agenti da usare
- agentId
-
number
Agente da sostituire
Valori restituiti
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
Valori restituiti
Promise<DeploymentMachine>
replaceDeploymentTarget(DeploymentMachine, string, number, number)
Sostituisci un target di distribuzione in un gruppo di deployment. Generalmente questo viene chiamato dallo strumento di configurazione agente.
function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>Parametri
- machine
- DeploymentMachine
Nuovo obiettivo di dispiegamento.
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione in cui viene sostituito il target di distribuzione.
- targetId
-
number
ID del target di dispiegamento da sostituire.
Valori restituiti
Promise<DeploymentMachine>
sendMessage(TaskAgentMessage, number, number)
function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>Parametri
- message
- TaskAgentMessage
- poolId
-
number
- requestId
-
number
Valori restituiti
Promise<void>
setAgentPoolMetadata(any, number)
function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>Parametri
- agentPoolMetadata
-
any
- poolId
-
number
Valori restituiti
Promise<void>
shareVariableGroup(VariableGroupProjectReference[], number)
Aggiungi un gruppo variabile.
function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>Parametri
- variableGroupProjectReferences
- variableGroupId
-
number
Valori restituiti
Promise<void>
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)
updateAgentCloud(TaskAgentCloud, number)
function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>Parametri
- updatedCloud
- TaskAgentCloud
- agentCloudId
-
number
Valori restituiti
Promise<TaskAgentCloud>
updateAgentPool(TaskAgentPool, number)
Aggiorna le proprietà su un pool di agenti
function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>Parametri
- pool
- TaskAgentPool
Dettagli aggiornati del pool agenti
- poolId
-
number
Il pool di agenti da aggiornare
Valori restituiti
Promise<TaskAgentPool>
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parametri
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
- definitionId
-
number
Valori restituiti
Promise<TaskAgentPoolMaintenanceDefinition>
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>Parametri
- poolId
-
number
- jobId
-
number
Valori restituiti
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
Valori restituiti
Promise<TaskAgentJobRequest>
updateAgentUpdateState(number, number, string)
function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>Parametri
- poolId
-
number
- agentId
-
number
- currentState
-
string
Valori restituiti
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
Valori restituiti
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 per aggiornare.
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione.
Valori restituiti
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
Valori restituiti
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
Valori restituiti
Promise<DeploymentMachineGroup>
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>Parametri
- deploymentMachines
- project
-
string
ID progetto o nome progetto
- machineGroupId
-
number
Valori restituiti
Promise<DeploymentMachine[]>
updateDeploymentMachines(DeploymentMachine[], string, number)
function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>Parametri
- machines
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
Valori restituiti
Promise<DeploymentMachine[]>
updateDeploymentTarget(DeploymentMachine, string, number, number)
Aggiorna un target di distribuzione e le sue proprietà dell'agente in un gruppo di deployment. Generalmente questo viene chiamato dallo strumento di configurazione agente.
function updateDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>Parametri
- machine
- DeploymentMachine
Obiettivo di distribuzione da aggiornare.
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione in cui viene aggiornato il target di distribuzione.
- targetId
-
number
ID del target di distribuzione da aggiornare.
Valori restituiti
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
Destinazioni di distribuzione con tag da udpdate.
- project
-
string
ID progetto o nome progetto
- deploymentGroupId
-
number
ID del gruppo di distribuzione in cui vengono aggiornate le destinazioni di distribuzione.
Valori restituiti
Promise<DeploymentMachine[]>
updateEnvironment(EnvironmentUpdateParameter, string, number)
Aggiorna l'ambiente specificato.
function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>Parametri
- environmentUpdateParameter
- EnvironmentUpdateParameter
Dati ambientali da aggiornare.
- project
-
string
ID progetto o nome progetto
- environmentId
-
number
ID dell'ambiente.
Valori restituiti
Promise<EnvironmentInstance>
updateSecureFile(SecureFile, string, string)
Aggiornare il nome o le proprietà di un file protetto esistente
function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>Parametri
- secureFile
- SecureFile
Il file sicuro con nome e/o proprietà aggiornati
- project
-
string
ID progetto o nome progetto
- secureFileId
-
string
ID file sicuro univoco
Valori restituiti
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
Elenco di oggetti file protetti. Solo tre campi devono essere popolati con ID, Nome e Proprietà. Il resto dei campi nell'oggetto viene ignorato.
- project
-
string
ID progetto o nome progetto
Valori restituiti
Promise<SecureFile[]>
updateTaskGroup(TaskGroupUpdateParameter, string, string)
Aggiorna un gruppo di lavoro.
function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>Parametri
- taskGroup
- TaskGroupUpdateParameter
Gruppo di lavoro da aggiornare.
- project
-
string
ID progetto o nome progetto
- taskGroupId
-
string
ID del gruppo di lavoro da aggiornare.
Valori restituiti
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 progetto
- taskGroupId
-
string
- disablePriorVersions
-
boolean
Valori restituiti
Promise<TaskGroup[]>
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>Parametri
- taskHubLicenseDetails
- TaskHubLicenseDetails
- hubName
-
string
Valori restituiti
Promise<TaskHubLicenseDetails>
updateVariableGroup(VariableGroupParameters, number)
Aggiornare un gruppo di variabili.
function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>Parametri
- variableGroupParameters
- VariableGroupParameters
- groupId
-
number
Identificazione del gruppo variabile da aggiornare.
Valori restituiti
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 progetto
- environmentId
-
number
Valori restituiti
Promise<VirtualMachineGroup>
updateVirtualMachines(VirtualMachine[], string, number, number)
function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>Parametri
- machines
- project
-
string
ID progetto o nome progetto
- environmentId
-
number
- resourceId
-
number
Valori restituiti
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 progetto
- name
-
string
Nome del file da caricare
- authorizePipelines
-
boolean
Se authorizePipelines è true, il file sicuro è autorizzato per l'uso da parte di tutte le pipeline nel progetto.
Valori restituiti
Promise<SecureFile>
validateInputs(InputValidationRequest)
function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>Parametri
- inputValidationRequest
- InputValidationRequest
Valori restituiti
Promise<InputValidationRequest>