TaskAgentRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends: RestClientBase

Konstruktorer

TaskAgentRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addAgent(TaskAgent, number)	Lägger till en agent i en pool. Du vill förmodligen inte anropa den här slutpunkten direkt. Konfigurera i stället en agent med hjälp av agentnedladdningspaketet.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Skapa en agentpool.
addAgentQueue(TaskAgentQueue, string, boolean)	Skapa en ny agentkö för att ansluta ett projekt till en agentpool.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Skapa en distributionsgrupp.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registrera ett distributionsmål för en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.
addEnvironment(EnvironmentCreateParameter, string)	Skapa en miljö.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Skapa en aktivitetsgrupp.
addVariableGroup(VariableGroupParameters)	Lägg till en variabelgrupp.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Skapa ett nytt teamprojekt.
deleteAgent(number, number)	Ta bort en agent. Du vill förmodligen inte anropa den här slutpunkten direkt. Använd i stället agentkonfigurationsskriptet för att ta bort en agent från din organisation.
deleteAgentCloud(number)
deleteAgentPool(number)	Ta bort en agentpool.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Tar bort en agentkö från ett projekt.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Ta bort en distributionsgrupp.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Ta bort ett distributionsmål i en distributionsgrupp. Detta tar även bort agenten från den associerade distributionspoolen.
deleteEnvironment(string, number)	Ta bort den angivna miljön.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Ta bort en säker fil
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Ta bort en aktivitetsgrupp.
deleteVariableGroup(number, string[])	Ta bort en variabelgrupp
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Ladda ned en säker fil med ID
generateDeploymentGroupAccessToken(string, number)	HÄMTA en PAT-token för att hantera (konfigurera, ta bort, tagga) distributionsmål i en distributionsgrupp.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	HÄMTA en PAT-token för att hantera (konfigurera, ta bort, tagga) distributionsagenter i en distributionspool.
getAgent(number, number, boolean, boolean, boolean, string[])	Hämta information om en agent.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Hämta molntyper för agenten.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Hämta information om en agentpool.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Hämta en lista över agentpooler.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Hämta en lista över agentpooler.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Hämta information om en agentkö.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Hämta en lista över agentköer.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Hämta en lista över agentköer efter deras ID:t
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Hämta en lista över agentköer efter deras namn
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Hämta en lista över agentköer efter pool-ID:t
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)	Hämta agentbegäranden för ett distributionsmål.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Hämta agentbegäranden för en lista över distributionsmål.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Hämta en lista över agenter.
getAzureManagementGroups()	Returnerar listan över Azure-prenumerationer
getAzureSubscriptions()	Returnerar listan över Azure-prenumerationer
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Hämta en distributionsgrupp efter dess ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Hämta en lista över distributionsgrupper efter namn eller ID:t.
getDeploymentGroupsMetrics(string, string, string, number)	Hämta en lista över mått för distributionsgrupper.
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[])	Hämta en lista över sammanfattningar för distributionspooler.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Hämta ett distributionsmål efter dess ID i en distributionsgrupp
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Hämta en lista över distributionsmål i en distributionsgrupp.
getEnvironmentById(string, number, EnvironmentExpands)	Hämta en miljö efter dess ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Hämta körningshistorik för miljödistribution
getEnvironments(string, string, string, number)	Hämta alla miljöer.
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)	Hämta en säker fil
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Hämta säkra filer
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Hämta säkra filer
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Hämta säkra filer
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Hämta aktivitetsgrupp.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Lista aktivitetsgrupper.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Hämta en variabelgrupp.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Hämta variabelgrupper.
getVariableGroupsById(string, number[], boolean)	Hämta variabelgrupper efter ID:t.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	HÄMTA Yaml-schemat som används för Yaml-filvalidering.
hasPoolPermissions(number, number)	Kontrollerar om den aktuella identiteten har godkänt behörigheter för en pool.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy för en GET-begäran som definierats av en "slutpunkt". Begäran auktoriseras med hjälp av en tjänstanslutning. Svaret filtreras med en XPath/Json-baserad väljare.
querySecureFilesByProperties(string, string, string)	Fråga säkra filer med hjälp av ett namnmönster och ett villkor för filegenskaper.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Uppgradera distributionsmålen i en distributionsgrupp.
replaceAgent(TaskAgent, number, number)	Ersätt en agent. Du vill förmodligen inte anropa den här slutpunkten direkt. Använd i stället agentkonfigurationsskriptet för att ta bort och konfigurera om en agent från din organisation.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Ersätt ett distributionsmål i en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Lägg till en variabelgrupp.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Uppdatera agentinformation.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Uppdatera egenskaper i en agentpool
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)	Uppdatera en distributionsgrupp.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Uppdatera ett distributionsmål och dess agentegenskaper i en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Uppdatera taggar för en lista över distributionsmål i en distributionsgrupp.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Uppdatera den angivna miljön.
updateSecureFile(SecureFile, string, string)	Uppdatera namnet eller egenskaperna för en befintlig säker fil
updateSecureFiles(SecureFile[], string)	Uppdatera egenskaper och/eller namn för en uppsättning säkra filer. Filerna identifieras med sina ID:t. Egenskaper som tillhandahålls åsidosätter den befintliga helt och hållet, d.v.s. sammanfogar inte.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Uppdatera en aktivitetsgrupp.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Uppdatera en variabelgrupp.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Ladda upp en säker fil, inkludera filströmmen i begärandetexten
validateInputs(InputValidationRequest)

Konstruktorinformation

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addAgent(TaskAgent, number)

Lägger till en agent i en pool. Du vill förmodligen inte anropa den här slutpunkten direkt. Konfigurera i stället en agent med hjälp av agentnedladdningspaketet.

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

Parametrar

agent: TaskAgent

Information om agenten som läggs till

poolId: number

Agentpoolen där agenten ska läggas till

Returer

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parametrar

agentCloud: TaskAgentCloud

Returer

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Skapa en agentpool.

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

Parametrar

pool: TaskAgentPool

Information om den nya agentpoolen

Returer

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Skapa en ny agentkö för att ansluta ett projekt till en agentpool.

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

Parametrar

queue: TaskAgentQueue

Information om kön som ska skapas

project: string

Projekt-ID eller projektnamn

authorizePipelines: boolean

Auktorisera den här kön automatiskt när du använder YAML

Returer

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Skapa en distributionsgrupp.

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

Parametrar

deploymentGroup: DeploymentGroupCreateParameter

Distributionsgrupp som ska skapas.

project: string

Projekt-ID eller projektnamn

Returer

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parametrar

machine: DeploymentMachine

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

Returer

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parametrar

machineGroup: DeploymentMachineGroup

project: string

Projekt-ID eller projektnamn

Returer

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registrera ett distributionsmål för en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.

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

Parametrar

machine: DeploymentMachine

Distributionsmål att registrera.

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen som distributionsmålet är registrerat för.

Returer

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Skapa en miljö.

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

Parametrar

environmentCreateParameter: EnvironmentCreateParameter

Miljö att skapa.

project: string

Projekt-ID eller projektnamn

Returer

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parametrar

createParameters: KubernetesResourceCreateParameters

project: string

Projekt-ID eller projektnamn

environmentId: number

Returer

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Skapa en aktivitetsgrupp.

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

Parametrar

taskGroup: TaskGroupCreateParameter

Uppgiftsgruppsobjekt som ska skapas.

project: string

Projekt-ID eller projektnamn

Returer

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Lägg till en variabelgrupp.

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

Parametrar

variableGroupParameters: VariableGroupParameters

Returer

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parametrar

createParameters: VirtualMachineGroupCreateParameters

project: string

Projekt-ID eller projektnamn

environmentId: number

Returer

Promise<VirtualMachineGroup>

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

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

Parametrar

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Returer

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parametrar

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Returer

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parametrar

session: TaskAgentSession

poolId: number

Returer

Promise<TaskAgentSession>

createTeamProject(string)

Skapa ett nytt teamprojekt.

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deleteAgent(number, number)

Ta bort en agent. Du vill förmodligen inte anropa den här slutpunkten direkt. Använd i stället agentkonfigurationsskriptet för att ta bort en agent från din organisation.

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

Parametrar

poolId: number

Pool-ID:t som agenten ska tas bort från

agentId: number

Agent-ID:t som ska tas bort

Returer

Promise<void>

deleteAgentCloud(number)

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

Parametrar

agentCloudId: number

Returer

Promise<TaskAgentCloud>

deleteAgentPool(number)

Ta bort en agentpool.

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

Parametrar

poolId: number

ID för agentpoolen som ska tas bort

Returer

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parametrar

poolId: number

definitionId: number

Returer

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parametrar

poolId: number

jobId: number

Returer

Promise<void>

deleteAgentQueue(number, string)

Tar bort en agentkö från ett projekt.

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

Parametrar

queueId: number

Agentkön som ska tas bort

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

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

Parametrar

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Returer

Promise<void>

deleteAgentSession(number, string)

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

Parametrar

poolId: number

sessionId: string

Returer

Promise<void>

deleteDeploymentGroup(string, number)

Ta bort en distributionsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen som ska tas bort.

Returer

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineId: number

Returer

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

machineGroupId: number

Returer

Promise<void>

deleteDeploymentTarget(string, number, number)

Ta bort ett distributionsmål i en distributionsgrupp. Detta tar även bort agenten från den associerade distributionspoolen.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen där distributionsmålet tas bort.

targetId: number

ID för distributionsmålet som ska tas bort.

Returer

Promise<void>

deleteEnvironment(string, number)

Ta bort den angivna miljön.

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

ID för miljön.

Returer

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

Returer

Promise<void>

deleteMessage(number, number, string)

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

Parametrar

poolId: number

messageId: number

sessionId: string

Returer

Promise<void>

deleteSecureFile(string, string)

Ta bort en säker fil

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

Parametrar

project: string

Projekt-ID eller projektnamn

secureFileId: string

Det unika säkra fil-ID:t

Returer

Promise<void>

deleteTaskDefinition(string)

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

Parametrar

taskId: string

Returer

Promise<void>

deleteTaskGroup(string, string, string)

Ta bort en aktivitetsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

ID för den aktivitetsgrupp som ska tas bort.

comment: string

Kommentarer att ta bort.

Returer

Promise<void>

deleteVariableGroup(number, string[])

Ta bort en variabelgrupp

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

Parametrar

groupId: number

ID för variabelgruppen.

projectIds: string[]

Returer

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

Returer

Promise<void>

downloadSecureFile(string, string, string, boolean)

Ladda ned en säker fil med ID

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

Parametrar

project: string

Projekt-ID eller projektnamn

secureFileId: string

Det unika säkra fil-ID:t

ticket: string

En giltig nedladdningsbiljett

download: boolean

Om nedladdningen är sann skickas filen som bifogad fil i svarstexten. Om nedladdningen är falsk innehåller svarstexten filströmmen.

Returer

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

HÄMTA en PAT-token för att hantera (konfigurera, ta bort, tagga) distributionsmål i en distributionsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen där distributionsmål hanteras.

Returer

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

machineGroupId: number

Returer

Promise<string>

generateDeploymentPoolAccessToken(number)

HÄMTA en PAT-token för att hantera (konfigurera, ta bort, tagga) distributionsagenter i en distributionspool.

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

Parametrar

poolId: number

ID för distributionspoolen där distributionsagenter hanteras.

Returer

Promise<string>

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

Hämta information om en agent.

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

Parametrar

poolId: number

Agentpoolen som innehåller agenten

agentId: number

Agent-ID:t för att få information om

includeCapabilities: boolean

Om agentens funktioner ska inkluderas i svaret

includeAssignedRequest: boolean

Om du vill inkludera information om agentens aktuella arbete

includeLastCompletedRequest: boolean

Om du vill inkludera information om agenternas senaste slutförda arbete

propertyFilters: string[]

Filtrera vilka anpassade egenskaper som ska returneras

Returer

Promise<TaskAgent>

getAgentCloud(number)

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

Parametrar

agentCloudId: number

Returer

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parametrar

agentCloudId: number

Returer

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Returer

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Hämta molntyper för agenten.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Returer

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Hämta information om en agentpool.

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

Parametrar

poolId: number

Ett agentpools-ID

properties: string[]

Egenskaper för agentpool (kommaavgränsade)

actionFilter: TaskAgentPoolActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parametrar

poolId: number

definitionId: number

Returer

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parametrar

poolId: number

Returer

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parametrar

poolId: number

jobId: number

Returer

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parametrar

poolId: number

jobId: number

Returer

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parametrar

poolId: number

definitionId: number

Returer

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parametrar

poolId: number

Returer

Promise<string>

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

Hämta en lista över agentpooler.

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

Parametrar

poolName: string

Filtrera efter namn

properties: string[]

Filtrera efter egenskaper för agentpool (kommaavgränsade)

poolType: TaskAgentPoolType

Filtrera efter pooltyp

actionFilter: TaskAgentPoolActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Hämta en lista över agentpooler.

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

Parametrar

poolIds: number[]

pool-ID:t som ska hämtas

actionFilter: TaskAgentPoolActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Hämta information om en agentkö.

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

Parametrar

queueId: number

Agentkön för att få information om

project: string

Projekt-ID eller projektnamn

actionFilter: TaskAgentQueueActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Hämta en lista över agentköer.

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

Parametrar

project: string

Projekt-ID eller projektnamn

queueName: string

Filtrera på agentkönamnet

actionFilter: TaskAgentQueueActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Hämta en lista över agentköer efter deras ID:t

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

Parametrar

queueIds: number[]

En kommaavgränsad lista över agentkö-ID:t som ska hämtas

project: string

Projekt-ID eller projektnamn

actionFilter: TaskAgentQueueActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Hämta en lista över agentköer efter deras namn

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

Parametrar

queueNames: string[]

En kommaavgränsad lista över agentnamn som ska hämtas

project: string

Projekt-ID eller projektnamn

actionFilter: TaskAgentQueueActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Hämta en lista över agentköer efter pool-ID:t

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

Parametrar

poolIds: number[]

En kommaavgränsad lista över pool-ID:t för att hämta motsvarande köer för

project: string

Projekt-ID eller projektnamn

actionFilter: TaskAgentQueueActionFilter

Filtrera efter om den anropande användaren har behörighet att använda eller hantera

Returer

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parametrar

poolId: number

requestId: number

includeStatus: boolean

Returer

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parametrar

poolId: number

top: number

continuationToken: string

Returer

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parametrar

poolId: number

agentId: number

completedRequestCount: number

Returer

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parametrar

poolId: number

agentIds: number[]

completedRequestCount: number

Returer

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineId: number

completedRequestCount: number

Returer

Promise<TaskAgentJobRequest[]>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Returer

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Hämta agentbegäranden för ett distributionsmål.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för den distributionsgrupp som målet tillhör.

targetId: number

ID för distributionsmålet.

completedRequestCount: number

Maximalt antal slutförda begäranden som ska returneras. Standardvärdet är 50

Returer

Promise<TaskAgentJobRequest[]>

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

Hämta agentbegäranden för en lista över distributionsmål.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för den distributionsgrupp som målen tillhör.

targetIds: number[]

Kommaavgränsad lista över ID:t för distributionsmålen.

ownerId: number

ID för ägare av agentjobbbegäran.

completedOn: Date

Datetime för att returnera begäran efter den här tiden.

completedRequestCount: number

Maximalt antal slutförda begäranden som ska returneras för varje mål. Standardvärdet är 50

Returer

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parametrar

poolId: number

planId: string

jobId: string

Returer

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

queueId: number

top: number

continuationToken: string

Returer

Promise<PagedList<TaskAgentJobRequest>>

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

Hämta en lista över agenter.

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

Parametrar

poolId: number

Agentpoolen som innehåller agenterna

agentName: string

Filtrera efter agentnamn

includeCapabilities: boolean

Om agenternas funktioner ska inkluderas i svaret

includeAssignedRequest: boolean

Om du vill inkludera information om agenternas aktuella arbete

includeLastCompletedRequest: boolean

Om du vill inkludera information om agenternas senaste slutförda arbete

propertyFilters: string[]

Filtrera vilka anpassade egenskaper som ska returneras

demands: string[]

Filtrera efter krav som agenterna kan uppfylla

Returer

Promise<TaskAgent[]>

getAzureManagementGroups()

Returnerar listan över Azure-prenumerationer

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Returer

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Returnerar listan över Azure-prenumerationer

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Returer

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Hämta en distributionsgrupp efter dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen.

actionFilter: DeploymentGroupActionFilter

Hämta endast distributionsgruppen om den här åtgärden kan utföras på den.

expand: DeploymentGroupExpands

Inkludera den här ytterligare informationen i det returnerade objektet.

Returer

Promise<DeploymentGroup>

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

Hämta en lista över distributionsgrupper efter namn eller ID:t.

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

Parametrar

project: string

Projekt-ID eller projektnamn

name: string

Namnet på distributionsgruppen.

actionFilter: DeploymentGroupActionFilter

Hämta endast distributionsgrupper där den här åtgärden kan utföras.

expand: DeploymentGroupExpands

Inkludera den här ytterligare informationen i de returnerade objekten.

continuationToken: string

Hämta distributionsgrupper med namn som är större än den här fortsättningenToken lexicographically.

top: number

Maximalt antal distributionsgrupper som ska returneras. Standardvärdet är 1 000.

ids: number[]

Kommaavgränsad lista över ID:t för distributionsgrupperna.

Returer

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Hämta en lista över mått för distributionsgrupper.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupName: string

Namnet på distributionsgruppen.

continuationToken: string

Hämta mått för distributionsgrupper med namn som är större än den här fortsättningenToken lexicographically.

top: number

Maximalt antal mått för distributionsgrupper som ska returneras. Standardvärdet är 50.

Returer

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Returer

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parametrar

project: string

Projekt-ID eller projektnamn

machineGroupId: number

actionFilter: MachineGroupActionFilter

Returer

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parametrar

project: string

Projekt-ID eller projektnamn

machineGroupId: number

tagFilters: string[]

Returer

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parametrar

project: string

Projekt-ID eller projektnamn

machineGroupName: string

actionFilter: MachineGroupActionFilter

Returer

Promise<DeploymentMachineGroup[]>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Returer

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Hämta en lista över sammanfattningar för distributionspooler.

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

Parametrar

poolName: string

Namnet på distributionspoolen.

expands: DeploymentPoolSummaryExpands

Inkludera den här ytterligare informationen i de returnerade objekten.

poolIds: number[]

Lista över distributionspool-ID:t.

Returer

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Hämta ett distributionsmål efter dess ID i en distributionsgrupp

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för den distributionsgrupp som distributionsmålet tillhör.

targetId: number

ID för distributionsmålet som ska returneras.

expand: DeploymentTargetExpands

Inkludera den här ytterligare informationen i de returnerade objekten.

Returer

Promise<DeploymentMachine>

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

Hämta en lista över distributionsmål i en distributionsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen.

tags: string[]

Hämta endast de distributionsmål som innehåller alla dessa kommaavgränsade taggar.

name: string

Namnmönster för distributionsmålen som ska returneras.

partialNameMatch: boolean

När värdet är true behandlar namn som mönster. Annars behandlas det som absolut matchning. Standardvärdet är falskt.

expand: DeploymentTargetExpands

Inkludera den här ytterligare informationen i de returnerade objekten.

agentStatus: TaskAgentStatusFilter

Hämta endast distributionsmål som har den här statusen.

agentJobResult: TaskAgentJobResultFilter

Hämta endast distributionsmål som har det senaste jobbresultatet.

continuationToken: string

Hämta distributionsmål med namn som är större än den här fortsättningenToken lexicographically.

top: number

Maximalt antal distributionsmål som ska returneras. Standardvärdet är 1 000.

enabled: boolean

Hämta endast distributionsmål som är aktiverade eller inaktiverade. Standardvärdet är null, vilket returnerar alla mål.

propertyFilters: string[]

Returer

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Hämta en miljö efter dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

ID för miljön.

expands: EnvironmentExpands

Inkludera den här ytterligare informationen i de returnerade objekten.

Returer

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Hämta körningshistorik för miljödistribution

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

continuationToken: string

top: number

Returer

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Hämta alla miljöer.

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

Parametrar

project: string

Projekt-ID eller projektnamn

name: string

continuationToken: string

top: number

Returer

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

Returer

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parametrar

poolId: number

sessionId: string

lastMessageId: number

Returer

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parametrar

packageType: string

platform: string

version: string

Returer

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parametrar

packageType: string

platform: string

top: number

Returer

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Returer

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parametrar

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Returer

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Hämta en säker fil

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

Parametrar

project: string

Projekt-ID eller projektnamn

secureFileId: string

Det unika säkra fil-ID:t

includeDownloadTicket: boolean

Om includeDownloadTicket är sant och anroparen har behörighet ingår en nedladdningsbiljett i svaret.

actionFilter: SecureFileActionFilter

Returer

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Hämta säkra filer

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

Parametrar

project: string

Projekt-ID eller projektnamn

namePattern: string

Namnet på den säkra fil som ska matchas. Kan innehålla jokertecken som matchar flera filer.

includeDownloadTickets: boolean

Om includeDownloadTickets är sant och anroparen har behörighet, ingår en nedladdningsbiljett för varje säker fil i svaret.

actionFilter: SecureFileActionFilter

Filtrera efter säkra filbehörigheter för åtgärden Visa, Hantera eller Använd. Standardvärdet är Visa.

Returer

Promise<SecureFile[]>

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

Hämta säkra filer

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

Parametrar

project: string

Projekt-ID eller projektnamn

secureFileIds: string[]

En lista över säkra fil-ID:t

includeDownloadTickets: boolean

Om includeDownloadTickets är sant och anroparen har behörighet, ingår en nedladdningsbiljett för varje säker fil i svaret.

actionFilter: SecureFileActionFilter

Returer

Promise<SecureFile[]>

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

Hämta säkra filer

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

Parametrar

project: string

Projekt-ID eller projektnamn

secureFileNames: string[]

En lista över säkra fil-ID:t

includeDownloadTickets: boolean

Om includeDownloadTickets är sant och anroparen har behörighet, ingår en nedladdningsbiljett för varje säker fil i svaret.

actionFilter: SecureFileActionFilter

Returer

Promise<SecureFile[]>

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

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

Parametrar

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Returer

Promise<ArrayBuffer>

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

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

Parametrar

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Returer

Promise<TaskDefinition>

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

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

Parametrar

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Returer

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Hämta aktivitetsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

ID för aktivitetsgruppen.

versionSpec: string

versionsspecifikation för aktivitetsgruppen. exempel: 1, 1.0.

expand: TaskGroupExpands

De egenskaper som ska utökas. exempel $expand=Aktiviteter expanderar kapslade aktivitetsgrupper.

Returer

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

Returer

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

revision: number

Returer

Promise<string>

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

Lista aktivitetsgrupper.

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

ID för aktivitetsgruppen.

expanded: boolean

"sant" för att rekursivt expandera aktivitetsgrupper. Standardvärdet är "false".

taskIdFilter: string

Guid för taskId som ska filtreras.

deleted: boolean

"true" för att inkludera borttagna aktivitetsgrupper. Standardvärdet är "false".

top: number

Antal aktivitetsgrupper som ska hämtas.

continuationToken: Date

Hämtar aktivitetsgrupperna efter den angivna fortsättningstoken.

queryOrder: TaskGroupQueryOrder

Hämtar resultaten i den definierade ordningen. Standardvärdet är "CreatedOnDescending".

Returer

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parametrar

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Returer

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Hämta en variabelgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

groupId: number

ID för variabelgruppen.

Returer

Promise<VariableGroup>

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

Hämta variabelgrupper.

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

Parametrar

project: string

Projekt-ID eller projektnamn

groupName: string

Namn på variabelgrupp.

actionFilter: VariableGroupActionFilter

Åtgärdsfilter för variabelgruppen. Den anger vilken åtgärd som kan utföras på variabelgrupperna.

top: number

Antal variabelgrupper som ska hämtas.

continuationToken: number

Hämtar variabelgrupperna efter den angivna fortsättningstoken.

queryOrder: VariableGroupQueryOrder

Hämtar resultaten i den definierade ordningen. Standardvärdet är "IdDescending".

Returer

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Hämta variabelgrupper efter ID:t.

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

Parametrar

project: string

Projekt-ID eller projektnamn

groupIds: number[]

Kommaavgränsad lista över ID:t för variabelgrupper.

loadSecrets: boolean

Flagga som anger om hemligheterna i variabelgrupper ska läsas in.

Returer

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

Returer

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

Parametrar

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Returer

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Returer

Promise<string>

getYamlSchema(boolean)

HÄMTA Yaml-schemat som används för Yaml-filvalidering.

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

Parametrar

validateTaskNames: boolean

Om schemat ska verifiera att aktiviteter faktiskt är installerade (användbart för offlineverktyg där du inte vill ha verifiering).

Returer

Promise<any>

hasPoolPermissions(number, number)

Kontrollerar om den aktuella identiteten har godkänt behörigheter för en pool.

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

Parametrar

poolId: number

ID för poolen som ska kontrolleras

permissions: number

Behörigheter att kontrollera. Flera behörigheter kan sammanfogas till ett enda värde med hjälp av en bitvis ELLER-operator (t.ex. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Returer

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parametrar

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Projekt-ID eller projektnamn

parentTaskGroupId: string

Returer

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy för en GET-begäran som definierats av en "slutpunkt". Begäran auktoriseras med hjälp av en tjänstanslutning. Svaret filtreras med en XPath/Json-baserad väljare.

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

Parametrar

endpoint: TaskDefinitionEndpoint

Beskriver url:en som ska hämtas.

Returer

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Fråga säkra filer med hjälp av ett namnmönster och ett villkor för filegenskaper.

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

Parametrar

condition: string

Huvudvillkorssyntaxen beskrivs här. Använd funktionen property('property-name') för att komma åt värdet för den angivna egenskapen för en säker fil. Den returnerar null om egenskapen inte har angetts. E.g. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Projekt-ID eller projektnamn

namePattern: string

Namnet på den säkra fil som ska matchas. Kan innehålla jokertecken som matchar flera filer.

Returer

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parametrar

job: TaskAgentPoolMaintenanceJob

poolId: number

Returer

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parametrar

request: TaskAgentJobRequest

project: string

Projekt-ID eller projektnamn

queueId: number

Returer

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parametrar

request: TaskAgentJobRequest

poolId: number

Returer

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parametrar

poolId: number

agentId: number

Returer

Promise<void>

refreshAgents(number)

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

Parametrar

poolId: number

Returer

Promise<void>

refreshDeploymentMachines(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

Returer

Promise<void>

refreshDeploymentTargets(string, number)

Uppgradera distributionsmålen i en distributionsgrupp.

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

Parametrar

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen.

Returer

Promise<void>

replaceAgent(TaskAgent, number, number)

Ersätt en agent. Du vill förmodligen inte anropa den här slutpunkten direkt. Använd i stället agentkonfigurationsskriptet för att ta bort och konfigurera om en agent från din organisation.

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

Parametrar

agent: TaskAgent

Uppdaterad information om ersättningsagenten

poolId: number

Agentpoolen som ska användas

agentId: number

Agenten som ska ersättas

Returer

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametrar

machine: DeploymentMachine

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineId: number

Returer

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Ersätt ett distributionsmål i en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.

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

Parametrar

machine: DeploymentMachine

Nytt distributionsmål.

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen där distributionsmålet ersätts.

targetId: number

ID för distributionsmålet som ska ersättas.

Returer

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parametrar

message: TaskAgentMessage

poolId: number

requestId: number

Returer

Promise<void>

setAgentPoolMetadata(any, number)

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

Parametrar

agentPoolMetadata: any

poolId: number

Returer

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Lägg till en variabelgrupp.

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

Parametrar

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Returer

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parametrar

taskGroup: TaskGroup

project: string

Projekt-ID eller projektnamn

Returer

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Uppdatera agentinformation.

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

Parametrar

agent: TaskAgent

Uppdaterad information om agenten

poolId: number

Agentpoolen som ska användas

agentId: number

Agenten som ska uppdateras

Returer

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parametrar

updatedCloud: TaskAgentCloud

agentCloudId: number

Returer

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Uppdatera egenskaper i en agentpool

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

Parametrar

pool: TaskAgentPool

Uppdaterad information om agentpool

poolId: number

Agentpoolen som ska uppdateras

Returer

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parametrar

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Returer

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parametrar

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Returer

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parametrar

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Returer

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parametrar

poolId: number

agentId: number

currentState: string

Returer

Promise<TaskAgent>

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

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

Parametrar

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Returer

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Uppdatera en distributionsgrupp.

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

Parametrar

deploymentGroup: DeploymentGroupUpdateParameter

Distributionsgrupp som ska uppdateras.

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen.

Returer

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametrar

machine: DeploymentMachine

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

machineId: number

Returer

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parametrar

machineGroup: DeploymentMachineGroup

project: string

Projekt-ID eller projektnamn

machineGroupId: number

Returer

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parametrar

deploymentMachines: DeploymentMachine[]

project: string

Projekt-ID eller projektnamn

machineGroupId: number

Returer

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parametrar

machines: DeploymentMachine[]

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

Returer

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Uppdatera ett distributionsmål och dess agentegenskaper i en distributionsgrupp. Detta anropas vanligtvis av agentkonfigurationsverktyget.

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

Parametrar

machine: DeploymentMachine

Distributionsmål som ska uppdateras.

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen där distributionsmålet uppdateras.

targetId: number

ID för distributionsmålet som ska uppdateras.

Returer

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Uppdatera taggar för en lista över distributionsmål i en distributionsgrupp.

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

Parametrar

machines: DeploymentTargetUpdateParameter[]

Distributionsmål med taggar som ska udpdate.

project: string

Projekt-ID eller projektnamn

deploymentGroupId: number

ID för distributionsgruppen där distributionsmålen uppdateras.

Returer

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Uppdatera den angivna miljön.

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

Parametrar

environmentUpdateParameter: EnvironmentUpdateParameter

Miljödata som ska uppdateras.

project: string

Projekt-ID eller projektnamn

environmentId: number

ID för miljön.

Returer

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Uppdatera namnet eller egenskaperna för en befintlig säker fil

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

Parametrar

secureFile: SecureFile

Den säkra filen med uppdaterat namn och/eller egenskaper

project: string

Projekt-ID eller projektnamn

secureFileId: string

Det unika säkra fil-ID:t

Returer

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Uppdatera egenskaper och/eller namn för en uppsättning säkra filer. Filerna identifieras med sina ID:t. Egenskaper som tillhandahålls åsidosätter den befintliga helt och hållet, d.v.s. sammanfogar inte.

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

Parametrar

secureFiles: SecureFile[]

En lista över säkra filobjekt. Endast tre fält måste vara ifyllda ID, Namn och Egenskaper. Resten av fälten i objektet ignoreras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Uppdatera en aktivitetsgrupp.

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

Parametrar

taskGroup: TaskGroupUpdateParameter

Uppgiftsgrupp som ska uppdateras.

project: string

Projekt-ID eller projektnamn

taskGroupId: string

ID för aktivitetsgruppen som ska uppdateras.

Returer

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parametrar

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Projekt-ID eller projektnamn

taskGroupId: string

disablePriorVersions: boolean

Returer

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parametrar

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Returer

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Uppdatera en variabelgrupp.

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

Parametrar

variableGroupParameters: VariableGroupParameters

groupId: number

ID för variabelgruppen som ska uppdateras.

Returer

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parametrar

resource: VirtualMachineGroup

project: string

Projekt-ID eller projektnamn

environmentId: number

Returer

Promise<VirtualMachineGroup>

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

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

Parametrar

machines: VirtualMachine[]

project: string

Projekt-ID eller projektnamn

environmentId: number

resourceId: number

Returer

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Ladda upp en säker fil, inkludera filströmmen i begärandetexten

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

Parametrar

content: any

Innehåll som ska laddas upp

project: string

Projekt-ID eller projektnamn

name: string

Namnet på filen som ska laddas upp

authorizePipelines: boolean

Om authorizePipelines är sant godkänns den säkra filen för användning av alla pipelines i projektet.

Returer

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parametrar

inputValidationRequest: InputValidationRequest

Returer

Promise<InputValidationRequest>

Dela via

TaskAgentRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

TaskAgentRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

addAgent(TaskAgent, number)

Parametrar

Returer

addAgentCloud(TaskAgentCloud)

Parametrar

Returer

addAgentPool(TaskAgentPool)

Parametrar

Returer

addAgentQueue(TaskAgentQueue, string, boolean)

Parametrar

Returer

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parametrar

Returer

addDeploymentMachine(DeploymentMachine, string, number)

Parametrar

Returer

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parametrar

Returer

addDeploymentTarget(DeploymentMachine, string, number)

Parametrar

Returer

addEnvironment(EnvironmentCreateParameter, string)

Parametrar

Returer

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parametrar

Returer

addTaskGroup(TaskGroupCreateParameter, string)

Parametrar

Returer

addVariableGroup(VariableGroupParameters)

Parametrar

Returer

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parametrar

Returer

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

Parametrar

Returer

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parametrar

Returer

createAgentSession(TaskAgentSession, number)

Parametrar

Returer

createTeamProject(string)

Parametrar

Returer

deleteAgent(number, number)

Parametrar

Returer

deleteAgentCloud(number)

Parametrar

Returer

deleteAgentPool(number)

Parametrar

Returer

deleteAgentPoolMaintenanceDefinition(number, number)

Parametrar

Returer

deleteAgentPoolMaintenanceJob(number, number)

Parametrar

Returer

deleteAgentQueue(number, string)

Parametrar