TaskAgentRestClient class

Referentie

Pakket:: azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends: RestClientBase

Constructors

TaskAgentRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

addAgent(TaskAgent, number)	Hiermee voegt u een agent toe aan een pool. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Configureer in plaats daarvan een agent met behulp van het agentdownloadpakket.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Creatie een agentgroep.
addAgentQueue(TaskAgentQueue, string, boolean)	Creatie een nieuwe agentwachtrij om een project te verbinden met een agentgroep.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Creatie een implementatiegroep.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Een implementatiedoel registreren bij een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.
addEnvironment(EnvironmentCreateParameter, string)	Creatie een omgeving.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Creatie een taakgroep.
addVariableGroup(VariableGroupParameters)	Voeg een variabelegroep toe.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Creatie een nieuw teamproject.
deleteAgent(number, number)	Een agent verwijderen. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Gebruik in plaats daarvan het agentconfiguratiescript om een agent uit uw organisatie te verwijderen.
deleteAgentCloud(number)
deleteAgentPool(number)	Een agentgroep verwijderen.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Hiermee verwijdert u een agentwachtrij uit een project.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Een implementatiegroep verwijderen.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Een implementatiedoel verwijderen in een implementatiegroep. Hiermee verwijdert u ook de agent uit de bijbehorende implementatiegroep.
deleteEnvironment(string, number)	Verwijder de opgegeven omgeving.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Een beveiligd bestand verwijderen
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Een taakgroep verwijderen.
deleteVariableGroup(number, string[])	Een variabelegroep verwijderen
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Een beveiligd bestand downloaden op id
generateDeploymentGroupAccessToken(string, number)	EEN PAT-token ophalen voor het beheren (configureren, verwijderen, taggen) van implementatiedoelen in een implementatiegroep.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	EEN PAT-token ophalen voor het beheren (configureren, verwijderen, taggen) van implementatieagents in een implementatiegroep.
getAgent(number, number, boolean, boolean, boolean, string[])	Informatie over een agent ophalen.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Cloudtypen voor agents ophalen.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Informatie ophalen over een agentpool.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Een lijst met agentgroepen ophalen.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Een lijst met agentgroepen ophalen.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Informatie ophalen over een agentwachtrij.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Een lijst met agentwachtrijen ophalen.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Een lijst met agentwachtrijen ophalen op hun id's
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Een lijst met agentwachtrijen ophalen op naam
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Een lijst met agentwachtrijen ophalen op pool-id's
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)	Agentaanvragen ophalen voor een implementatiedoel.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Agentaanvragen ophalen voor een lijst met implementatiedoelen.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Een lijst met agents ophalen.
getAzureManagementGroups()	Retourneert een lijst met Azure-abonnementen
getAzureSubscriptions()	Retourneert een lijst met Azure-abonnementen
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Haal een implementatiegroep op op basis van de id.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Een lijst met implementatiegroepen op naam of id's ophalen.
getDeploymentGroupsMetrics(string, string, string, number)	Een lijst met metrische gegevens van de implementatiegroep ophalen.
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[])	Een lijst met samenvattingen van implementatiegroepen ophalen.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Een implementatiedoel ophalen op basis van de id in een implementatiegroep
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Een lijst met implementatiedoelen in een implementatiegroep ophalen.
getEnvironmentById(string, number, EnvironmentExpands)	Een omgeving ophalen op basis van de id.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Uitvoeringsgeschiedenis van omgevingsimplementatie ophalen
getEnvironments(string, string, string, number)	Alle omgevingen ophalen.
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)	Een beveiligd bestand ophalen
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Beveiligde bestanden ophalen
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Beveiligde bestanden ophalen
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Beveiligde bestanden ophalen
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Taakgroep ophalen.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Taakgroepen weergeven.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Een variabelegroep ophalen.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Variabelegroepen ophalen.
getVariableGroupsById(string, number[], boolean)	Variabelegroepen ophalen op id's.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	HAAL het Yaml-schema op dat wordt gebruikt voor yaml-bestandsvalidatie.
hasPoolPermissions(number, number)	Controleert of de huidige identiteit machtigingen heeft doorgegeven voor een pool.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy voor een GET-aanvraag die is gedefinieerd door een 'eindpunt'. De aanvraag wordt geautoriseerd met behulp van een serviceverbinding. Het antwoord wordt gefilterd met behulp van een XPath/Json-selector.
querySecureFilesByProperties(string, string, string)	Beveilig bestanden met behulp van een naampatroon en een voorwaarde voor bestandseigenschappen.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Upgrade de implementatiedoelen in een implementatiegroep.
replaceAgent(TaskAgent, number, number)	Vervang een agent. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Gebruik in plaats daarvan het agentconfiguratiescript om een agent uit uw organisatie te verwijderen en opnieuw te configureren.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Vervang een implementatiedoel in een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Voeg een variabelegroep toe.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Agentgegevens bijwerken.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Eigenschappen van een agentpool bijwerken
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)	Een implementatiegroep bijwerken.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Werk een implementatiedoel en de bijbehorende agenteigenschappen bij in een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Tags bijwerken van een lijst met implementatiedoelen in een implementatiegroep.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Werk de opgegeven omgeving bij.
updateSecureFile(SecureFile, string, string)	De naam of eigenschappen van een bestaand beveiligd bestand bijwerken
updateSecureFiles(SecureFile[], string)	Eigenschappen en/of namen van een set beveiligde bestanden bijwerken. Bestanden worden aangeduid met hun id's. De opgegeven eigenschappen overschrijven de bestaande volledig, d.w.w.w. worden niet samengevoegd.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Een taakgroep bijwerken.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Een variabelegroep bijwerken.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Een beveiligd bestand uploaden, de bestandsstroom opnemen in de aanvraagbody
validateInputs(InputValidationRequest)

Constructordetails

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parameters

options: IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addAgent(TaskAgent, number)

Hiermee voegt u een agent toe aan een pool. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Configureer in plaats daarvan een agent met behulp van het agentdownloadpakket.

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

Parameters

agent: TaskAgent

Details over de agent die wordt toegevoegd

poolId: number

De agentgroep waarin de agent moet worden toegevoegd

Retouren

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parameters

agentCloud: TaskAgentCloud

Retouren

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Creatie een agentgroep.

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

Parameters

pool: TaskAgentPool

Details over de nieuwe agentgroep

Retouren

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Creatie een nieuwe agentwachtrij om een project te verbinden met een agentgroep.

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

Parameters

queue: TaskAgentQueue

Details over de wachtrij die moet worden gemaakt

project: string

Project-id of projectnaam

authorizePipelines: boolean

Deze wachtrij automatisch autoriseren bij gebruik van YAML

Retouren

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Creatie een implementatiegroep.

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

Parameters

deploymentGroup: DeploymentGroupCreateParameter

Implementatiegroep die moet worden gemaakt.

project: string

Project-id of projectnaam

Retouren

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parameters

machine: DeploymentMachine

project: string

Project-id of projectnaam

deploymentGroupId: number

Retouren

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parameters

machineGroup: DeploymentMachineGroup

project: string

Project-id of projectnaam

Retouren

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Een implementatiedoel registreren bij een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.

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

Parameters

machine: DeploymentMachine

Implementatiedoel om te registreren.

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarbij het implementatiedoel is geregistreerd.

Retouren

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Creatie een omgeving.

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

Parameters

environmentCreateParameter: EnvironmentCreateParameter

Omgeving die moet worden gemaakt.

project: string

Project-id of projectnaam

Retouren

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parameters

createParameters: KubernetesResourceCreateParameters

project: string

Project-id of projectnaam

environmentId: number

Retouren

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Creatie een taakgroep.

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

Parameters

taskGroup: TaskGroupCreateParameter

Te maken taakgroepobject.

project: string

Project-id of projectnaam

Retouren

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Voeg een variabelegroep toe.

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

Parameters

variableGroupParameters: VariableGroupParameters

Retouren

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parameters

createParameters: VirtualMachineGroupCreateParameters

project: string

Project-id of projectnaam

environmentId: number

Retouren

Promise<VirtualMachineGroup>

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

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

Parameters

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Retouren

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parameters

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Retouren

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parameters

session: TaskAgentSession

poolId: number

Retouren

Promise<TaskAgentSession>

createTeamProject(string)

Creatie een nieuw teamproject.

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteAgent(number, number)

Een agent verwijderen. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Gebruik in plaats daarvan het agentconfiguratiescript om een agent uit uw organisatie te verwijderen.

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

Parameters

poolId: number

De pool-id waaruit de agent moet worden verwijderd

agentId: number

De agent-id die moet worden verwijderd

Retouren

Promise<void>

deleteAgentCloud(number)

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

Parameters

agentCloudId: number

Retouren

Promise<TaskAgentCloud>

deleteAgentPool(number)

Een agentgroep verwijderen.

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

Parameters

poolId: number

Id van de agentgroep die moet worden verwijderd

Retouren

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parameters

poolId: number

definitionId: number

Retouren

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parameters

poolId: number

jobId: number

Retouren

Promise<void>

deleteAgentQueue(number, string)

Hiermee verwijdert u een agentwachtrij uit een project.

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

Parameters

queueId: number

De agentwachtrij die moet worden verwijderd

project: string

Project-id of projectnaam

Retouren

Promise<void>

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

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

Parameters

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Retouren

Promise<void>

deleteAgentSession(number, string)

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

Parameters

poolId: number

sessionId: string

Retouren

Promise<void>

deleteDeploymentGroup(string, number)

Een implementatiegroep verwijderen.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep die moet worden verwijderd.

Retouren

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

machineId: number

Retouren

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parameters

project: string

Project-id of projectnaam

machineGroupId: number

Retouren

Promise<void>

deleteDeploymentTarget(string, number, number)

Een implementatiedoel verwijderen in een implementatiegroep. Hiermee verwijdert u ook de agent uit de bijbehorende implementatiegroep.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarin het implementatiedoel wordt verwijderd.

targetId: number

Id van het implementatiedoel dat moet worden verwijderd.

Retouren

Promise<void>

deleteEnvironment(string, number)

Verwijder de opgegeven omgeving.

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

Id van de omgeving.

Retouren

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

Retouren

Promise<void>

deleteMessage(number, number, string)

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

Parameters

poolId: number

messageId: number

sessionId: string

Retouren

Promise<void>

deleteSecureFile(string, string)

Een beveiligd bestand verwijderen

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

Parameters

project: string

Project-id of projectnaam

secureFileId: string

De unieke id van het beveiligde bestand

Retouren

Promise<void>

deleteTaskDefinition(string)

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

Parameters

taskId: string

Retouren

Promise<void>

deleteTaskGroup(string, string, string)

Een taakgroep verwijderen.

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

Id van de taakgroep die moet worden verwijderd.

comment: string

Opmerkingen die moeten worden verwijderd.

Retouren

Promise<void>

deleteVariableGroup(number, string[])

Een variabelegroep verwijderen

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

Parameters

groupId: number

Id van de variabelegroep.

projectIds: string[]

Retouren

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

Retouren

Promise<void>

downloadSecureFile(string, string, string, boolean)

Een beveiligd bestand downloaden op id

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

Parameters

project: string

Project-id of projectnaam

secureFileId: string

De unieke id van het beveiligde bestand

ticket: string

Een geldig downloadticket

download: boolean

Als downloaden waar is, wordt het bestand verzonden als bijlage in de hoofdtekst van het antwoord. Als downloaden onwaar is, bevat de hoofdtekst van het antwoord de bestandsstroom.

Retouren

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

EEN PAT-token ophalen voor het beheren (configureren, verwijderen, taggen) van implementatiedoelen in een implementatiegroep.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarin implementatiedoelen worden beheerd.

Retouren

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parameters

project: string

Project-id of projectnaam

machineGroupId: number

Retouren

Promise<string>

generateDeploymentPoolAccessToken(number)

EEN PAT-token ophalen voor het beheren (configureren, verwijderen, taggen) van implementatieagents in een implementatiegroep.

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

Parameters

poolId: number

Id van de implementatiegroep waarin implementatieagents worden beheerd.

Retouren

Promise<string>

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

Informatie over een agent ophalen.

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

Parameters

poolId: number

De agentgroep die de agent bevat

agentId: number

De agent-id om informatie over op te halen

includeCapabilities: boolean

Of de mogelijkheden van de agent in het antwoord moeten worden opgenomen

includeAssignedRequest: boolean

Of u details wilt opnemen over het huidige werk van de agent

includeLastCompletedRequest: boolean

Of u details wilt opnemen over het meest recente voltooide werk van de agents

propertyFilters: string[]

Filteren welke aangepaste eigenschappen worden geretourneerd

Retouren

Promise<TaskAgent>

getAgentCloud(number)

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

Parameters

agentCloudId: number

Retouren

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parameters

agentCloudId: number

Retouren

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Retouren

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Cloudtypen voor agents ophalen.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Retouren

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Informatie ophalen over een agentpool.

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

Parameters

poolId: number

Een agentgroep-id

properties: string[]

Eigenschappen van agentpools (door komma's gescheiden)

actionFilter: TaskAgentPoolActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parameters

poolId: number

definitionId: number

Retouren

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parameters

poolId: number

Retouren

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parameters

poolId: number

jobId: number

Retouren

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parameters

poolId: number

jobId: number

Retouren

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parameters

poolId: number

definitionId: number

Retouren

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parameters

poolId: number

Retouren

Promise<string>

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

Een lijst met agentgroepen ophalen.

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

Parameters

poolName: string

Filteren op naam

properties: string[]

Filteren op eigenschappen van agentpool (door komma's gescheiden)

poolType: TaskAgentPoolType

Filteren op pooltype

actionFilter: TaskAgentPoolActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Een lijst met agentgroepen ophalen.

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

Parameters

poolIds: number[]

op te halen pool-id's

actionFilter: TaskAgentPoolActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Informatie ophalen over een agentwachtrij.

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

Parameters

queueId: number

De agentwachtrij voor informatie over

project: string

Project-id of projectnaam

actionFilter: TaskAgentQueueActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Een lijst met agentwachtrijen ophalen.

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

Parameters

project: string

Project-id of projectnaam

queueName: string

Filteren op de naam van de agentwachtrij

actionFilter: TaskAgentQueueActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Een lijst met agentwachtrijen ophalen op hun id's

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

Parameters

queueIds: number[]

Een door komma's gescheiden lijst met agentwachtrij-id's die moeten worden opgehaald

project: string

Project-id of projectnaam

actionFilter: TaskAgentQueueActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Een lijst met agentwachtrijen ophalen op naam

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

Parameters

queueNames: string[]

Een door komma's gescheiden lijst met agentnamen die moeten worden opgehaald

project: string

Project-id of projectnaam

actionFilter: TaskAgentQueueActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Een lijst met agentwachtrijen ophalen op pool-id's

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

Parameters

poolIds: number[]

Een door komma's gescheiden lijst met pool-id's om de bijbehorende wachtrijen voor op te halen

project: string

Project-id of projectnaam

actionFilter: TaskAgentQueueActionFilter

Filteren op of de aanroepende gebruiker gebruiks- of beheermachtigingen heeft

Retouren

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parameters

poolId: number

requestId: number

includeStatus: boolean

Retouren

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parameters

poolId: number

top: number

continuationToken: string

Retouren

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parameters

poolId: number

agentId: number

completedRequestCount: number

Retouren

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parameters

poolId: number

agentIds: number[]

completedRequestCount: number

Retouren

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

machineId: number

completedRequestCount: number

Retouren

Promise<TaskAgentJobRequest[]>

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

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Retouren

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Agentaanvragen ophalen voor een implementatiedoel.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waartoe het doel behoort.

targetId: number

Id van het implementatiedoel.

completedRequestCount: number

Maximum aantal voltooide aanvragen dat moet worden geretourneerd. De standaardwaarde is 50

Retouren

Promise<TaskAgentJobRequest[]>

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

Agentaanvragen ophalen voor een lijst met implementatiedoelen.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waartoe de doelen behoren.

targetIds: number[]

Door komma's gescheiden lijst met id's van de implementatiedoelen.

ownerId: number

Id van de eigenaar van de agenttaakaanvraag.

completedOn: Date

Datum/tijd om de aanvraag na deze tijd te retourneren.

completedRequestCount: number

Maximum aantal voltooide aanvragen dat voor elk doel moet worden geretourneerd. De standaardwaarde is 50

Retouren

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parameters

poolId: number

planId: string

jobId: string

Retouren

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parameters

project: string

Project-id of projectnaam

queueId: number

top: number

continuationToken: string

Retouren

Promise<PagedList<TaskAgentJobRequest>>

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

Een lijst met agents ophalen.

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

Parameters

poolId: number

De agentpool met de agents

agentName: string

Filteren op agentnaam

includeCapabilities: boolean

Of de mogelijkheden van de agents in het antwoord moeten worden opgenomen

includeAssignedRequest: boolean

Of u details wilt opnemen over het huidige werk van de agents

includeLastCompletedRequest: boolean

Of u details wilt opnemen over het meest recente voltooide werk van de agents

propertyFilters: string[]

Filteren welke aangepaste eigenschappen worden geretourneerd

demands: string[]

Filteren op vereisten waaraan de agents kunnen voldoen

Retouren

Promise<TaskAgent[]>

getAzureManagementGroups()

Retourneert een lijst met Azure-abonnementen

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Retouren

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Retourneert een lijst met Azure-abonnementen

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Retouren

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Haal een implementatiegroep op op basis van de id.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep.

actionFilter: DeploymentGroupActionFilter

Haal de implementatiegroep alleen op als deze actie erop kan worden uitgevoerd.

expand: DeploymentGroupExpands

Neem deze aanvullende informatie op in het geretourneerde object.

Retouren

Promise<DeploymentGroup>

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

Een lijst met implementatiegroepen op naam of id's ophalen.

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

Parameters

project: string

Project-id of projectnaam

name: string

Naam van de implementatiegroep.

actionFilter: DeploymentGroupActionFilter

Alleen implementatiegroepen ophalen waarop deze actie kan worden uitgevoerd.

expand: DeploymentGroupExpands

Neem deze aanvullende informatie op in de geretourneerde objecten.

continuationToken: string

Haal implementatiegroepen op met namen die groter zijn dan deze continuationToken lexicographically.

top: number

Maximum aantal implementatiegroepen dat moet worden geretourneerd. De standaardwaarde is 1000.

ids: number[]

Door komma's gescheiden lijst met id's van de implementatiegroepen.

Retouren

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Een lijst met metrische gegevens van de implementatiegroep ophalen.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupName: string

Naam van de implementatiegroep.

continuationToken: string

Haal metrische gegevens op voor implementatiegroepen met namen die groter zijn dan dit vervolgToken lexicographically.

top: number

Maximum aantal metrische gegevens van de implementatiegroep dat moet worden geretourneerd. De standaardwaarde is 50.

Retouren

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Retouren

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parameters

project: string

Project-id of projectnaam

machineGroupId: number

actionFilter: MachineGroupActionFilter

Retouren

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parameters

project: string

Project-id of projectnaam

machineGroupId: number

tagFilters: string[]

Retouren

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parameters

project: string

Project-id of projectnaam

machineGroupName: string

actionFilter: MachineGroupActionFilter

Retouren

Promise<DeploymentMachineGroup[]>

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

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Retouren

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Een lijst met samenvattingen van implementatiegroepen ophalen.

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

Parameters

poolName: string

Naam van de implementatiegroep.

expands: DeploymentPoolSummaryExpands

Neem deze aanvullende informatie op in de geretourneerde objecten.

poolIds: number[]

Lijst met implementatiegroep-id's.

Retouren

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Een implementatiedoel ophalen op basis van de id in een implementatiegroep

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waartoe het implementatiedoel behoort.

targetId: number

Id van het implementatiedoel dat moet worden geretourneerd.

expand: DeploymentTargetExpands

Neem deze aanvullende informatie op in de geretourneerde objecten.

Retouren

Promise<DeploymentMachine>

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

Een lijst met implementatiedoelen in een implementatiegroep ophalen.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep.

tags: string[]

Haal alleen de implementatiedoelen op die al deze door komma's gescheiden lijst met tags bevatten.

name: string

Naampatroon van de implementatiedoelen die moeten worden geretourneerd.

partialNameMatch: boolean

Wanneer deze optie is ingesteld op true, wordt de naam als patroon behandeld. Anders behandelt het als een absolute overeenkomst. De standaardwaarde is false.

expand: DeploymentTargetExpands

Neem deze aanvullende informatie op in de geretourneerde objecten.

agentStatus: TaskAgentStatusFilter

Haal alleen implementatiedoelen op met deze status.

agentJobResult: TaskAgentJobResultFilter

Alleen implementatiedoelen ophalen met dit laatste taakresultaat.

continuationToken: string

Haal implementatiedoelen op met namen die groter zijn dan deze continuationToken lexicographically.

top: number

Maximum aantal implementatiedoelen dat moet worden geretourneerd. De standaardwaarde is 1000.

enabled: boolean

Alleen implementatiedoelen ophalen die zijn ingeschakeld of uitgeschakeld. De standaardwaarde is null, waarmee alle doelen worden geretourneerd.

propertyFilters: string[]

Retouren

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Een omgeving ophalen op basis van de id.

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

Id van de omgeving.

expands: EnvironmentExpands

Neem deze aanvullende informatie op in de geretourneerde objecten.

Retouren

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Uitvoeringsgeschiedenis van omgevingsimplementatie ophalen

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

continuationToken: string

top: number

Retouren

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Alle omgevingen ophalen.

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

Parameters

project: string

Project-id of projectnaam

name: string

continuationToken: string

top: number

Retouren

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

Retouren

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parameters

poolId: number

sessionId: string

lastMessageId: number

Retouren

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parameters

packageType: string

platform: string

version: string

Retouren

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parameters

packageType: string

platform: string

top: number

Retouren

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Retouren

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parameters

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Retouren

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Een beveiligd bestand ophalen

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

Parameters

project: string

Project-id of projectnaam

secureFileId: string

De unieke beveiligde bestands-id

includeDownloadTicket: boolean

Als includeDownloadTicket waar is en de aanroeper machtigingen heeft, wordt er een downloadticket opgenomen in het antwoord.

actionFilter: SecureFileActionFilter

Retouren

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Beveiligde bestanden ophalen

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

Parameters

project: string

Project-id of projectnaam

namePattern: string

Naam van het beveiligde bestand dat moet worden vergeleken. Kan jokertekens bevatten die overeenkomen met meerdere bestanden.

includeDownloadTickets: boolean

Als includeDownloadTickets waar is en de aanroeper machtigingen heeft, wordt een downloadticket voor elk beveiligd bestand opgenomen in het antwoord.

actionFilter: SecureFileActionFilter

Filter op bestandsmachtigingen voor de actie Weergeven, Beheren of Gebruiken. Standaard ingesteld op Weergave.

Retouren

Promise<SecureFile[]>

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

Beveiligde bestanden ophalen

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

Parameters

project: string

Project-id of projectnaam

secureFileIds: string[]

Een lijst met beveiligde bestands-id's

includeDownloadTickets: boolean

Als includeDownloadTickets waar is en de aanroeper machtigingen heeft, wordt een downloadticket voor elk beveiligd bestand opgenomen in het antwoord.

actionFilter: SecureFileActionFilter

Retouren

Promise<SecureFile[]>

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

Beveiligde bestanden ophalen

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

Parameters

project: string

Project-id of projectnaam

secureFileNames: string[]

Een lijst met beveiligde bestands-id's

includeDownloadTickets: boolean

Als includeDownloadTickets waar is en de aanroeper machtigingen heeft, wordt een downloadticket voor elk beveiligd bestand opgenomen in het antwoord.

actionFilter: SecureFileActionFilter

Retouren

Promise<SecureFile[]>

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

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

Parameters

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retouren

Promise<ArrayBuffer>

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

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

Parameters

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retouren

Promise<TaskDefinition>

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

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

Parameters

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Retouren

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Taakgroep ophalen.

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

Id van de taakgroep.

versionSpec: string

versiespecificatie van de taakgroep. voorbeelden: 1, 1.0.

expand: TaskGroupExpands

De eigenschappen die moeten worden uitgebreid. voorbeeld $expand=Taken vouwen geneste taakgroepen uit.

Retouren

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

Retouren

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

revision: number

Retouren

Promise<string>

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

Taakgroepen weergeven.

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

Id van de taakgroep.

expanded: boolean

'true' om taakgroepen recursief uit te vouwen. De standaardwaarde is 'false'.

taskIdFilter: string

Guid van de taak-id die moet worden gefilterd.

deleted: boolean

'true' om verwijderde taakgroepen op te nemen. De standaardwaarde is 'false'.

top: number

Het aantal taakgroepen dat u wilt ophalen.

continuationToken: Date

Hiermee haalt u de taakgroepen op na het opgegeven vervolgtoken.

queryOrder: TaskGroupQueryOrder

Hiermee worden de resultaten in de gedefinieerde volgorde opgehaald. De standaardwaarde is CreatedOnDescending.

Retouren

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parameters

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Retouren

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Een variabelegroep ophalen.

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

Parameters

project: string

Project-id of projectnaam

groupId: number

Id van de variabelegroep.

Retouren

Promise<VariableGroup>

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

Variabelegroepen ophalen.

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

Parameters

project: string

Project-id of projectnaam

groupName: string

Naam van variabelegroep.

actionFilter: VariableGroupActionFilter

Actiefilter voor de variabelegroep. Hiermee wordt de actie opgegeven die kan worden uitgevoerd op de variabelegroepen.

top: number

Het aantal variabelengroepen dat moet worden getypen.

continuationToken: number

Haalt de variabelegroepen op na het opgegeven vervolgtoken.

queryOrder: VariableGroupQueryOrder

Hiermee worden de resultaten in de gedefinieerde volgorde opgehaald. De standaardwaarde is IdDescending.

Retouren

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Variabelegroepen ophalen op id's.

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

Parameters

project: string

Project-id of projectnaam

groupIds: number[]

Door komma's gescheiden lijst met id's van variabele groepen.

loadSecrets: boolean

Vlag die aangeeft of de geheimen binnen variabelegroepen moeten worden geladen.

Retouren

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

Retouren

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

Parameters

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Retouren

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Retouren

Promise<string>

getYamlSchema(boolean)

HAAL het Yaml-schema op dat wordt gebruikt voor yaml-bestandsvalidatie.

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

Parameters

validateTaskNames: boolean

Of het schema moet valideren dat taken daadwerkelijk zijn geïnstalleerd (handig voor offlinehulpprogramma's waarvoor u geen validatie wilt).

Retouren

Promise<any>

hasPoolPermissions(number, number)

Controleert of de huidige identiteit machtigingen heeft doorgegeven voor een pool.

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

Parameters

poolId: number

Id van de pool die moet worden gecontroleerd

permissions: number

Machtigingen om te controleren. Meerdere machtigingen kunnen worden samengevoegd in één waarde met behulp van bitsgewijze OR-operator (bijvoorbeeld AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Retouren

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parameters

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Project-id of projectnaam

parentTaskGroupId: string

Retouren

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy voor een GET-aanvraag die is gedefinieerd door een 'eindpunt'. De aanvraag wordt geautoriseerd met behulp van een serviceverbinding. Het antwoord wordt gefilterd met behulp van een XPath/Json-selector.

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

Parameters

endpoint: TaskDefinitionEndpoint

Beschrijft de URL die moet worden opgehaald.

Retouren

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Beveilig bestanden met behulp van een naampatroon en een voorwaarde voor bestandseigenschappen.

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

Parameters

condition: string

De syntaxis van de hoofdvoorwaarde wordt hier beschreven. Gebruik de functie property('property-name') om toegang te krijgen tot de waarde van de opgegeven eigenschap van een beveiligd bestand. Deze retourneert null als de eigenschap niet is ingesteld. Bijvoorbeeld. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Project-id of projectnaam

namePattern: string

Naam van het beveiligde bestand dat moet worden vergeleken. Kan jokertekens bevatten die overeenkomen met meerdere bestanden.

Retouren

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parameters

job: TaskAgentPoolMaintenanceJob

poolId: number

Retouren

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parameters

request: TaskAgentJobRequest

project: string

Project-id of projectnaam

queueId: number

Retouren

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parameters

request: TaskAgentJobRequest

poolId: number

Retouren

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parameters

poolId: number

agentId: number

Retouren

Promise<void>

refreshAgents(number)

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

Parameters

poolId: number

Retouren

Promise<void>

refreshDeploymentMachines(string, number)

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Retouren

Promise<void>

refreshDeploymentTargets(string, number)

Upgrade de implementatiedoelen in een implementatiegroep.

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

Parameters

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep.

Retouren

Promise<void>

replaceAgent(TaskAgent, number, number)

Vervang een agent. U wilt dit eindpunt waarschijnlijk niet rechtstreeks aanroepen. Gebruik in plaats daarvan het agentconfiguratiescript om een agent uit uw organisatie te verwijderen en opnieuw te configureren.

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

Parameters

agent: TaskAgent

Bijgewerkte details over de vervangende agent

poolId: number

De agentgroep die moet worden gebruikt

agentId: number

De agent die moet worden vervangen

Retouren

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameters

machine: DeploymentMachine

project: string

Project-id of projectnaam

deploymentGroupId: number

machineId: number

Retouren

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Vervang een implementatiedoel in een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.

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

Parameters

machine: DeploymentMachine

Nieuw implementatiedoel.

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarin het implementatiedoel is vervangen.

targetId: number

Id van het implementatiedoel dat moet worden vervangen.

Retouren

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parameters

message: TaskAgentMessage

poolId: number

requestId: number

Retouren

Promise<void>

setAgentPoolMetadata(any, number)

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

Parameters

agentPoolMetadata: any

poolId: number

Retouren

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Voeg een variabelegroep toe.

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

Parameters

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Retouren

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parameters

taskGroup: TaskGroup

project: string

Project-id of projectnaam

Retouren

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Agentgegevens bijwerken.

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

Parameters

agent: TaskAgent

Bijgewerkte details over de agent

poolId: number

De agentgroep die moet worden gebruikt

agentId: number

De agent die moet worden bijgewerkt

Retouren

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parameters

updatedCloud: TaskAgentCloud

agentCloudId: number

Retouren

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Eigenschappen van een agentpool bijwerken

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

Parameters

pool: TaskAgentPool

Details van agentpool bijgewerkt

poolId: number

De bij te werken agentgroep

Retouren

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parameters

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Retouren

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parameters

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Retouren

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parameters

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Retouren

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parameters

poolId: number

agentId: number

currentState: string

Retouren

Promise<TaskAgent>

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

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

Parameters

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Retouren

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Een implementatiegroep bijwerken.

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

Parameters

deploymentGroup: DeploymentGroupUpdateParameter

Implementatiegroep die moet worden bijgewerkt.

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep.

Retouren

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameters

machine: DeploymentMachine

project: string

Project-id of projectnaam

deploymentGroupId: number

machineId: number

Retouren

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parameters

machineGroup: DeploymentMachineGroup

project: string

Project-id of projectnaam

machineGroupId: number

Retouren

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parameters

deploymentMachines: DeploymentMachine[]

project: string

Project-id of projectnaam

machineGroupId: number

Retouren

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parameters

machines: DeploymentMachine[]

project: string

Project-id of projectnaam

deploymentGroupId: number

Retouren

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Werk een implementatiedoel en de bijbehorende agenteigenschappen bij in een implementatiegroep. Over het algemeen wordt dit aangeroepen door het configuratieprogramma van de agent.

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

Parameters

machine: DeploymentMachine

Bij te werken implementatiedoel.

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarin het implementatiedoel wordt bijgewerkt.

targetId: number

Id van het implementatiedoel dat moet worden bijgewerkt.

Retouren

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Tags bijwerken van een lijst met implementatiedoelen in een implementatiegroep.

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

Parameters

machines: DeploymentTargetUpdateParameter[]

Implementatiedoelen met tags die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

deploymentGroupId: number

Id van de implementatiegroep waarin implementatiedoelen worden bijgewerkt.

Retouren

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Werk de opgegeven omgeving bij.

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

Parameters

environmentUpdateParameter: EnvironmentUpdateParameter

Omgevingsgegevens die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

environmentId: number

Id van de omgeving.

Retouren

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

De naam of eigenschappen van een bestaand beveiligd bestand bijwerken

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

Parameters

secureFile: SecureFile

Het beveiligde bestand met bijgewerkte naam en/of eigenschappen

project: string

Project-id of projectnaam

secureFileId: string

De unieke beveiligde bestands-id

Retouren

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Eigenschappen en/of namen van een set beveiligde bestanden bijwerken. Bestanden worden aangeduid met hun id's. De opgegeven eigenschappen overschrijven de bestaande volledig, d.w.w.w. worden niet samengevoegd.

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

Parameters

secureFiles: SecureFile[]

Een lijst met beveiligde bestandsobjecten. Er moeten slechts drie velden worden ingevuld: Id, Naam en Eigenschappen. De overige velden in het object worden genegeerd.

project: string

Project-id of projectnaam

Retouren

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Een taakgroep bijwerken.

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

Parameters

taskGroup: TaskGroupUpdateParameter

Bij te werken taakgroep.

project: string

Project-id of projectnaam

taskGroupId: string

Id van de bij te werken taakgroep.

Retouren

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parameters

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Project-id of projectnaam

taskGroupId: string

disablePriorVersions: boolean

Retouren

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parameters

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Retouren

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Een variabelegroep bijwerken.

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

Parameters

variableGroupParameters: VariableGroupParameters

groupId: number

Id van de variabelegroep die moet worden bijgewerkt.

Retouren

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parameters

resource: VirtualMachineGroup

project: string

Project-id of projectnaam

environmentId: number

Retouren

Promise<VirtualMachineGroup>

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

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

Parameters

machines: VirtualMachine[]

project: string

Project-id of projectnaam

environmentId: number

resourceId: number

Retouren

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Een beveiligd bestand uploaden, de bestandsstroom opnemen in de aanvraagbody

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

Parameters

content: any

Inhoud die moet worden geüpload

project: string

Project-id of projectnaam

name: string

Naam van het bestand dat u wilt uploaden

authorizePipelines: boolean

Als authorizePipelines true is, wordt het beveiligde bestand geautoriseerd voor gebruik door alle pijplijnen in het project.

Retouren

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parameters

inputValidationRequest: InputValidationRequest

Retouren

Promise<InputValidationRequest>

Delen via

TaskAgentRestClient class

Constructors

Eigenschappen

Methoden

Constructordetails

TaskAgentRestClient(IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

Waarde van eigenschap

Methodedetails

addAgent(TaskAgent, number)

Parameters

Retouren

addAgentCloud(TaskAgentCloud)

Parameters

Retouren

addAgentPool(TaskAgentPool)

Parameters

Retouren

addAgentQueue(TaskAgentQueue, string, boolean)

Parameters

Retouren

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parameters

Retouren

addDeploymentMachine(DeploymentMachine, string, number)

Parameters

Retouren

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parameters

Retouren

addDeploymentTarget(DeploymentMachine, string, number)

Parameters

Retouren

addEnvironment(EnvironmentCreateParameter, string)

Parameters

Retouren

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parameters

Retouren

addTaskGroup(TaskGroupCreateParameter, string)

Parameters

Retouren

addVariableGroup(VariableGroupParameters)

Parameters

Retouren

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parameters

Retouren

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

Parameters

Retouren

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parameters

Retouren

createAgentSession(TaskAgentSession, number)

Parameters

Retouren

createTeamProject(string)

Parameters

Retouren

deleteAgent(number, number)

Parameters

Retouren

deleteAgentCloud(number)

Parameters

Retouren

deleteAgentPool(number)

Parameters

Retouren

deleteAgentPoolMaintenanceDefinition(number, number)

Parameters

Retouren

deleteAgentPoolMaintenanceJob(number, number)

Parameters

Retouren

deleteAgentQueue(number, string)

Parameters