TaskAgentRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends: RestClientBase

Konstruktoren

TaskAgentRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addAgent(TaskAgent, number)	Fügt einem Pool einen Agent hinzu. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Konfigurieren Sie stattdessen einen Agent mithilfe des Agent-Downloadpakets.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create einen Agentpool.
addAgentQueue(TaskAgentQueue, string, boolean)	Create eine neue Agent-Warteschlange, um ein Projekt mit einem Agentpool zu verbinden.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create eine Bereitstellungsgruppe.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registrieren Eines Bereitstellungsziels bei einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.
addEnvironment(EnvironmentCreateParameter, string)	Eine Umgebung erstellen
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create eine Taskgruppe.
addVariableGroup(VariableGroupParameters)	Fügen Sie eine Variablengruppe hinzu.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create ein neues Teamprojekt.
deleteAgent(number, number)	Löschen Sie einen Agent. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Verwenden Sie stattdessen das Agentkonfigurationsskript, um einen Agent aus Ihrem organization zu entfernen.
deleteAgentCloud(number)
deleteAgentPool(number)	Löschen Sie einen Agentpool.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Entfernt eine Agent-Warteschlange aus einem Projekt.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Löschen Sie eine Bereitstellungsgruppe.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Löschen Sie ein Bereitstellungsziel in einer Bereitstellungsgruppe. Dadurch wird der Agent auch aus dem zugeordneten Bereitstellungspool gelöscht.
deleteEnvironment(string, number)	Löschen Sie die angegebene Umgebung.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Löschen einer sicheren Datei
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Löschen Sie eine Taskgruppe.
deleteVariableGroup(number, string[])	Löschen einer Variablengruppe
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Herunterladen einer sicheren Datei nach ID
generateDeploymentGroupAccessToken(string, number)	RUFEN Sie ein PAT-Token zum Verwalten (Konfigurieren, Entfernen, Markieren) von Bereitstellungszielen in einer Bereitstellungsgruppe ab.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	RUFEN Sie ein PAT-Token zum Verwalten (Konfigurieren, Entfernen, Markieren) von Bereitstellungs-Agents in einem Bereitstellungspool ab.
getAgent(number, number, boolean, boolean, boolean, string[])	Rufen Sie Informationen zu einem Agent ab.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Abrufen von Agent-Cloudtypen.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Rufen Sie Informationen zu einem Agentpool ab.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Rufen Sie eine Liste der Agentpools ab.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Rufen Sie eine Liste der Agentpools ab.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Rufen Sie Informationen zu einer Agent-Warteschlange ab.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Rufen Sie eine Liste der Agent-Warteschlangen ab.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Abrufen einer Liste der Agent-Warteschlangen nach ihren IDs
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Abrufen einer Liste von Agent-Warteschlangen nach ihren Namen
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Abrufen einer Liste von Agent-Warteschlangen nach Pool-IDs
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)	Abrufen von Agentanforderungen für ein Bereitstellungsziel.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Abrufen von Agentanforderungen für eine Liste von Bereitstellungszielen.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Rufen Sie eine Liste der Agents ab.
getAzureManagementGroups()	Gibt die Liste der Azure-Abonnements zurück
getAzureSubscriptions()	Gibt die Liste der Azure-Abonnements zurück
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Rufen Sie eine Bereitstellungsgruppe nach ihrer ID ab.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Rufen Sie eine Liste der Bereitstellungsgruppen nach Name oder IDs ab.
getDeploymentGroupsMetrics(string, string, string, number)	Rufen Sie eine Liste der Bereitstellungsgruppenmetriken ab.
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[])	Rufen Sie eine Liste der Zusammenfassungen des Bereitstellungspools ab.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Abrufen eines Bereitstellungsziels anhand seiner ID in einer Bereitstellungsgruppe
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Rufen Sie eine Liste der Bereitstellungsziele in einer Bereitstellungsgruppe ab.
getEnvironmentById(string, number, EnvironmentExpands)	Rufen Sie eine Umgebung anhand ihrer ID ab.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Abrufen des Ausführungsverlaufs der Umgebungsbereitstellung
getEnvironments(string, string, string, number)	Rufen Sie alle Umgebungen ab.
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)	Abrufen einer sicheren Datei
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Sichere Dateien abrufen
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Sichere Dateien abrufen
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Sichere Dateien abrufen
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Taskgruppe abrufen.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Auflisten von Aufgabengruppen.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Abrufen einer Variablengruppe.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Abrufen von Variablengruppen.
getVariableGroupsById(string, number[], boolean)	Abrufen von Variablengruppen nach ID.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	RUFEN Sie das yaml-Schema ab, das für die Yaml-Dateiüberprüfung verwendet wird.
hasPoolPermissions(number, number)	Überprüft, ob die aktuelle Identität Berechtigungen für einen Pool übergeben hat.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy für eine GET-Anforderung, die durch einen "Endpunkt" definiert wird. Die Anforderung wird mithilfe einer Dienstverbindung autorisiert. Die Antwort wird mithilfe eines XPath/Json-basierten Selektors gefiltert.
querySecureFilesByProperties(string, string, string)	Abfragen sicherer Dateien mithilfe eines Namensmusters und einer Bedingung für Dateieigenschaften.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Aktualisieren Sie die Bereitstellungsziele in einer Bereitstellungsgruppe.
replaceAgent(TaskAgent, number, number)	Ersetzen Sie einen Agent. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Verwenden Sie stattdessen das Agentkonfigurationsskript, um einen Agent aus Ihrem organization zu entfernen und neu zu konfigurieren.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Ersetzen Sie ein Bereitstellungsziel in einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Fügen Sie eine Variablengruppe hinzu.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Agentdetails aktualisieren.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aktualisieren von Eigenschaften in einem 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)	Aktualisieren sie eine Bereitstellungsgruppe.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Aktualisieren Sie ein Bereitstellungsziel und dessen Agenteigenschaften in einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Aktualisieren sie Tags einer Liste von Bereitstellungszielen in einer Bereitstellungsgruppe.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Aktualisieren Sie die angegebene Umgebung.
updateSecureFile(SecureFile, string, string)	Aktualisieren des Namens oder der Eigenschaften einer vorhandenen sicheren Datei
updateSecureFiles(SecureFile[], string)	Aktualisieren von Eigenschaften und/oder Namen einer Gruppe sicherer Dateien. Dateien werden durch ihre IDs identifiziert. Die bereitgestellten Eigenschaften setzen die vorhandene vollständig außer Kraft, d. h. führen nicht zusammen.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Aktualisieren sie eine Aufgabengruppe.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Aktualisieren einer Variablengruppe.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Hochladen einer sicheren Datei, Einschließen des Dateidatenstroms in den Anforderungstext
validateInputs(InputValidationRequest)

Details zum Konstruktor

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addAgent(TaskAgent, number)

Fügt einem Pool einen Agent hinzu. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Konfigurieren Sie stattdessen einen Agent mithilfe des Agent-Downloadpakets.

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

Parameter

agent: TaskAgent

Details zum hinzugefügten Agent

poolId: number

Der Agentpool, in dem der Agent hinzugefügt werden soll

Gibt zurück

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parameter

agentCloud: TaskAgentCloud

Gibt zurück

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create einen Agentpool.

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

Parameter

pool: TaskAgentPool

Details zum neuen Agentpool

Gibt zurück

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create eine neue Agent-Warteschlange, um ein Projekt mit einem Agentpool zu verbinden.

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

Parameter

queue: TaskAgentQueue

Details zur zu erstellenden Warteschlange

project: string

Projekt-ID oder Projektname

authorizePipelines: boolean

Automatisches Autorisieren dieser Warteschlange bei Verwendung von YAML

Gibt zurück

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create eine Bereitstellungsgruppe.

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

Parameter

deploymentGroup: DeploymentGroupCreateParameter

Zu erstellende Bereitstellungsgruppe.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parameter

machine: DeploymentMachine

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

Gibt zurück

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parameter

machineGroup: DeploymentMachineGroup

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registrieren Eines Bereitstellungsziels bei einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.

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

Parameter

machine: DeploymentMachine

Zu registrierende Bereitstellungsziel.

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der das Bereitstellungsziel registriert ist.

Gibt zurück

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Eine Umgebung erstellen

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

Parameter

environmentCreateParameter: EnvironmentCreateParameter

Zu erstellende Umgebung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parameter

createParameters: KubernetesResourceCreateParameters

project: string

Projekt-ID oder Projektname

environmentId: number

Gibt zurück

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create eine Taskgruppe.

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

Parameter

taskGroup: TaskGroupCreateParameter

Zu erstellende Aufgabengruppenobjekt.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Fügen Sie eine Variablengruppe hinzu.

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

Parameter

variableGroupParameters: VariableGroupParameters

Gibt zurück

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parameter

createParameters: VirtualMachineGroupCreateParameters

project: string

Projekt-ID oder Projektname

environmentId: number

Gibt zurück

Promise<VirtualMachineGroup>

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

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

Parameter

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Gibt zurück

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parameter

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parameter

session: TaskAgentSession

poolId: number

Gibt zurück

Promise<TaskAgentSession>

createTeamProject(string)

Create ein neues Teamprojekt.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deleteAgent(number, number)

Löschen Sie einen Agent. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Verwenden Sie stattdessen das Agentkonfigurationsskript, um einen Agent aus Ihrem organization zu entfernen.

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

Parameter

poolId: number

Die Pool-ID, aus der der Agent entfernt werden soll

agentId: number

Die zu entfernende Agent-ID

Gibt zurück

Promise<void>

deleteAgentCloud(number)

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

Parameter

agentCloudId: number

Gibt zurück

Promise<TaskAgentCloud>

deleteAgentPool(number)

Löschen Sie einen Agentpool.

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

Parameter

poolId: number

ID des zu löschenden Agentpools

Gibt zurück

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parameter

poolId: number

definitionId: number

Gibt zurück

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parameter

poolId: number

jobId: number

Gibt zurück

Promise<void>

deleteAgentQueue(number, string)

Entfernt eine Agent-Warteschlange aus einem Projekt.

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

Parameter

queueId: number

Die zu entfernende Agent-Warteschlange

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

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

Parameter

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Gibt zurück

Promise<void>

deleteAgentSession(number, string)

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

Parameter

poolId: number

sessionId: string

Gibt zurück

Promise<void>

deleteDeploymentGroup(string, number)

Löschen Sie eine Bereitstellungsgruppe.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der zu löschenden Bereitstellungsgruppe.

Gibt zurück

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineId: number

Gibt zurück

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

machineGroupId: number

Gibt zurück

Promise<void>

deleteDeploymentTarget(string, number, number)

Löschen Sie ein Bereitstellungsziel in einer Bereitstellungsgruppe. Dadurch wird der Agent auch aus dem zugeordneten Bereitstellungspool gelöscht.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der das Bereitstellungsziel gelöscht wird.

targetId: number

ID des zu löschenden Bereitstellungsziels.

Gibt zurück

Promise<void>

deleteEnvironment(string, number)

Löschen Sie die angegebene Umgebung.

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

ID der Umgebung.

Gibt zurück

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

Gibt zurück

Promise<void>

deleteMessage(number, number, string)

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

Parameter

poolId: number

messageId: number

sessionId: string

Gibt zurück

Promise<void>

deleteSecureFile(string, string)

Löschen einer sicheren Datei

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

Parameter

project: string

Projekt-ID oder Projektname

secureFileId: string

Die eindeutige ID der sicheren Datei

Gibt zurück

Promise<void>

deleteTaskDefinition(string)

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

Parameter

taskId: string

Gibt zurück

Promise<void>

deleteTaskGroup(string, string, string)

Löschen Sie eine Taskgruppe.

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

Parameter

project: string

Projekt-ID oder Projektname

taskGroupId: string

ID der zu löschenden Taskgruppe.

comment: string

Zu löschende Kommentare.

Gibt zurück

Promise<void>

deleteVariableGroup(number, string[])

Löschen einer Variablengruppe

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

Parameter

groupId: number

ID der Variablengruppe.

projectIds: string[]

Gibt zurück

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

Gibt zurück

Promise<void>

downloadSecureFile(string, string, string, boolean)

Herunterladen einer sicheren Datei nach ID

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

Parameter

project: string

Projekt-ID oder Projektname

secureFileId: string

Die eindeutige ID der sicheren Datei

ticket: string

Ein gültiges Downloadticket

download: boolean

Wenn der Download true ist, wird die Datei als Anfügen im Antworttext gesendet. Wenn der Download false ist, enthält der Antworttext den Dateistream.

Gibt zurück

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

RUFEN Sie ein PAT-Token zum Verwalten (Konfigurieren, Entfernen, Markieren) von Bereitstellungszielen in einer Bereitstellungsgruppe ab.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der Bereitstellungsziele verwaltet werden.

Gibt zurück

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

machineGroupId: number

Gibt zurück

Promise<string>

generateDeploymentPoolAccessToken(number)

RUFEN Sie ein PAT-Token zum Verwalten (Konfigurieren, Entfernen, Markieren) von Bereitstellungs-Agents in einem Bereitstellungspool ab.

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

Parameter

poolId: number

ID des Bereitstellungspools, in dem Bereitstellungs-Agents verwaltet werden.

Gibt zurück

Promise<string>

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

Rufen Sie Informationen zu einem Agent ab.

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

Parameter

poolId: number

Der Agentpool, der den Agent enthält

agentId: number

Die Agent-ID, über die Informationen abgerufen werden sollen

includeCapabilities: boolean

Ob die Funktionen des Agents in die Antwort einbezogen werden sollen

includeAssignedRequest: boolean

Gibt an, ob Details zur aktuellen Arbeit des Agents angegeben werden sollen

includeLastCompletedRequest: boolean

Gibt an, ob Details zur letzten abgeschlossenen Arbeit der Agents angegeben werden sollen.

propertyFilters: string[]

Filtern, welche benutzerdefinierten Eigenschaften zurückgegeben werden

Gibt zurück

Promise<TaskAgent>

getAgentCloud(number)

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

Parameter

agentCloudId: number

Gibt zurück

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parameter

agentCloudId: number

Gibt zurück

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Gibt zurück

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Abrufen von Agent-Cloudtypen.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Gibt zurück

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Rufen Sie Informationen zu einem Agentpool ab.

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

Parameter

poolId: number

Eine Agentpool-ID

properties: string[]

Eigenschaften des Agentpools (durch Trennzeichen getrennt)

actionFilter: TaskAgentPoolActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parameter

poolId: number

definitionId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parameter

poolId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parameter

poolId: number

jobId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parameter

poolId: number

jobId: number

Gibt zurück

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parameter

poolId: number

definitionId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parameter

poolId: number

Gibt zurück

Promise<string>

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

Rufen Sie eine Liste der Agentpools ab.

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

Parameter

poolName: string

Nach Name filtern

properties: string[]

Filtern nach Agentpooleigenschaften (durch Trennzeichen getrennt)

poolType: TaskAgentPoolType

Filtern nach Pooltyp

actionFilter: TaskAgentPoolActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Rufen Sie eine Liste der Agentpools ab.

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

Parameter

poolIds: number[]

abzurufende Pool-IDs

actionFilter: TaskAgentPoolActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Rufen Sie Informationen zu einer Agent-Warteschlange ab.

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

Parameter

queueId: number

Die Agent-Warteschlange zum Abrufen von Informationen

project: string

Projekt-ID oder Projektname

actionFilter: TaskAgentQueueActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Rufen Sie eine Liste der Agent-Warteschlangen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

queueName: string

Filtern nach dem Namen der Agent-Warteschlange

actionFilter: TaskAgentQueueActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Abrufen einer Liste der Agent-Warteschlangen nach ihren IDs

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

Parameter

queueIds: number[]

Eine durch Trennzeichen getrennte Liste der abzurufenden Agent-Warteschlangen-IDs

project: string

Projekt-ID oder Projektname

actionFilter: TaskAgentQueueActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Abrufen einer Liste von Agent-Warteschlangen nach ihren Namen

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

Parameter

queueNames: string[]

Eine durch Trennzeichen getrennte Liste von Agentnamen, die abgerufen werden sollen

project: string

Projekt-ID oder Projektname

actionFilter: TaskAgentQueueActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Abrufen einer Liste von Agent-Warteschlangen nach Pool-IDs

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

Parameter

poolIds: number[]

Eine durch Trennzeichen getrennte Liste von Pool-IDs zum Abrufen der entsprechenden Warteschlangen für

project: string

Projekt-ID oder Projektname

actionFilter: TaskAgentQueueActionFilter

Filtern, ob der aufrufende Benutzer über Nutzungs- oder Verwaltungsberechtigungen verfügt

Gibt zurück

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parameter

poolId: number

requestId: number

includeStatus: boolean

Gibt zurück

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parameter

poolId: number

top: number

continuationToken: string

Gibt zurück

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parameter

poolId: number

agentId: number

completedRequestCount: number

Gibt zurück

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parameter

poolId: number

agentIds: number[]

completedRequestCount: number

Gibt zurück

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineId: number

completedRequestCount: number

Gibt zurück

Promise<TaskAgentJobRequest[]>

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

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Gibt zurück

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Abrufen von Agentanforderungen für ein Bereitstellungsziel.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, zu der das Ziel gehört.

targetId: number

ID des Bereitstellungsziels.

completedRequestCount: number

Maximale Anzahl abgeschlossener Anforderungen, die zurückgegeben werden sollen. Der Standardwert ist 50.

Gibt zurück

Promise<TaskAgentJobRequest[]>

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

Abrufen von Agentanforderungen für eine Liste von Bereitstellungszielen.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, zu der die Ziele gehören.

targetIds: number[]

Durch Kommas getrennte Liste der IDs der Bereitstellungsziele.

ownerId: number

Id des Besitzers der Agentauftragsanforderung.

completedOn: Date

Datetime, um die Anforderung nach diesem Zeitpunkt zurückzugeben.

completedRequestCount: number

Maximale Anzahl abgeschlossener Anforderungen, die für jedes Ziel zurückgegeben werden sollen. Der Standardwert ist 50.

Gibt zurück

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parameter

poolId: number

planId: string

jobId: string

Gibt zurück

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parameter

project: string

Projekt-ID oder Projektname

queueId: number

top: number

continuationToken: string

Gibt zurück

Promise<PagedList<TaskAgentJobRequest>>

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

Rufen Sie eine Liste der Agents ab.

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

Parameter

poolId: number

Der Agentpool, der die Agents enthält

agentName: string

Filtern nach Agentname

includeCapabilities: boolean

Ob die Funktionen der Agents in die Antwort einbezogen werden sollen

includeAssignedRequest: boolean

Gibt an, ob Details zur aktuellen Arbeit der Agents angegeben werden sollen

includeLastCompletedRequest: boolean

Gibt an, ob Details zur letzten abgeschlossenen Arbeit der Agents angegeben werden sollen.

propertyFilters: string[]

Filtern, welche benutzerdefinierten Eigenschaften zurückgegeben werden

demands: string[]

Filtern nach Anforderungen, die die Agents erfüllen können

Gibt zurück

Promise<TaskAgent[]>

getAzureManagementGroups()

Gibt die Liste der Azure-Abonnements zurück

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Gibt zurück

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Gibt die Liste der Azure-Abonnements zurück

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Gibt zurück

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Rufen Sie eine Bereitstellungsgruppe nach ihrer ID ab.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe.

actionFilter: DeploymentGroupActionFilter

Rufen Sie die Bereitstellungsgruppe nur ab, wenn diese Aktion für sie ausgeführt werden kann.

expand: DeploymentGroupExpands

Fügen Sie diese zusätzlichen Details in das zurückgegebene Objekt ein.

Gibt zurück

Promise<DeploymentGroup>

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

Rufen Sie eine Liste der Bereitstellungsgruppen nach Name oder IDs ab.

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

Parameter

project: string

Projekt-ID oder Projektname

name: string

Name der Bereitstellungsgruppe.

actionFilter: DeploymentGroupActionFilter

Rufen Sie nur Bereitstellungsgruppen ab, für die diese Aktion ausgeführt werden kann.

expand: DeploymentGroupExpands

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

continuationToken: string

Rufen Sie Bereitstellungsgruppen ab, deren Namen größer als diese FortsetzungToken lexikografisch sind.

top: number

Maximale Anzahl von Bereitstellungsgruppen, die zurückgegeben werden sollen. Der Standardwert ist 1000.

ids: number[]

Durch Kommas getrennte Liste der IDs der Bereitstellungsgruppen.

Gibt zurück

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Rufen Sie eine Liste der Bereitstellungsgruppenmetriken ab.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupName: string

Name der Bereitstellungsgruppe.

continuationToken: string

Rufen Sie Metriken für Bereitstellungsgruppen ab, deren Namen größer als diese FortsetzungToken lexikografisch sind.

top: number

Die maximale Anzahl der zurückzugebenden Bereitstellungsgruppenmetriken. Der Standardwert ist 50.

Gibt zurück

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Gibt zurück

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parameter

project: string

Projekt-ID oder Projektname

machineGroupId: number

actionFilter: MachineGroupActionFilter

Gibt zurück

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parameter

project: string

Projekt-ID oder Projektname

machineGroupId: number

tagFilters: string[]

Gibt zurück

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parameter

project: string

Projekt-ID oder Projektname

machineGroupName: string

actionFilter: MachineGroupActionFilter

Gibt zurück

Promise<DeploymentMachineGroup[]>

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

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Gibt zurück

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Rufen Sie eine Liste der Zusammenfassungen des Bereitstellungspools ab.

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

Parameter

poolName: string

Name des Bereitstellungspools.

expands: DeploymentPoolSummaryExpands

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

poolIds: number[]

Liste der Bereitstellungspool-IDs.

Gibt zurück

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Abrufen eines Bereitstellungsziels anhand seiner ID in einer Bereitstellungsgruppe

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, zu der das Bereitstellungsziel gehört.

targetId: number

ID des zurückzugebenden Bereitstellungsziels.

expand: DeploymentTargetExpands

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

Gibt zurück

Promise<DeploymentMachine>

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

Rufen Sie eine Liste der Bereitstellungsziele in einer Bereitstellungsgruppe ab.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe.

tags: string[]

Rufen Sie nur die Bereitstellungsziele ab, die alle diese kommas separtierten Liste von Tags enthalten.

name: string

Namensmuster der zurückzugebenden Bereitstellungsziele.

partialNameMatch: boolean

Wenn auf "true" festgelegt ist, wird name als Muster behandelt. Else behandelt es als absolute Übereinstimmung. Die Standardeinstellung lautet false.

expand: DeploymentTargetExpands

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

agentStatus: TaskAgentStatusFilter

Rufen Sie nur Bereitstellungsziele ab, die über diese status verfügen.

agentJobResult: TaskAgentJobResultFilter

Rufen Sie nur Bereitstellungsziele ab, die dieses letzte Auftragsergebnis aufweisen.

continuationToken: string

Rufen Sie Bereitstellungsziele ab, deren Namen größer als diese FortsetzungToken lexikografisch sind.

top: number

Maximale Anzahl von Bereitstellungszielen, die zurückgegeben werden sollen. Der Standardwert ist 1000.

enabled: boolean

Rufen Sie nur Bereitstellungsziele ab, die aktiviert oder deaktiviert sind. Der Standardwert ist "NULL", wodurch alle Ziele zurückgegeben werden.

propertyFilters: string[]

Gibt zurück

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Rufen Sie eine Umgebung anhand ihrer ID ab.

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

ID der Umgebung.

expands: EnvironmentExpands

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

Gibt zurück

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Abrufen des Ausführungsverlaufs der Umgebungsbereitstellung

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

continuationToken: string

top: number

Gibt zurück

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Rufen Sie alle Umgebungen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

name: string

continuationToken: string

top: number

Gibt zurück

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

Gibt zurück

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parameter

poolId: number

sessionId: string

lastMessageId: number

Gibt zurück

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parameter

packageType: string

platform: string

version: string

Gibt zurück

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parameter

packageType: string

platform: string

top: number

Gibt zurück

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Gibt zurück

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parameter

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Gibt zurück

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Abrufen einer sicheren Datei

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

Parameter

project: string

Projekt-ID oder Projektname

secureFileId: string

Die eindeutige ID der sicheren Datei

includeDownloadTicket: boolean

Wenn includeDownloadTicket true ist und der Aufrufer über Berechtigungen verfügt, ist ein Downloadticket in der Antwort enthalten.

actionFilter: SecureFileActionFilter

Gibt zurück

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Sichere Dateien abrufen

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

Parameter

project: string

Projekt-ID oder Projektname

namePattern: string

Name der zu übereinstimmenden sicheren Datei. Kann Wildcards enthalten, um mehrere Dateien abzugleichen.

includeDownloadTickets: boolean

Wenn includeDownloadTickets true ist und der Aufrufer über Berechtigungen verfügt, ist ein Downloadticket für jede sichere Datei in der Antwort enthalten.

actionFilter: SecureFileActionFilter

Filtern Sie nach sicheren Dateiberechtigungen für die Aktion Anzeigen, Verwalten oder Verwenden. Standardmäßig wird "Ansicht" verwendet.

Gibt zurück

Promise<SecureFile[]>

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

Sichere Dateien abrufen

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

Parameter

project: string

Projekt-ID oder Projektname

secureFileIds: string[]

Eine Liste mit sicheren Datei-IDs

includeDownloadTickets: boolean

Wenn includeDownloadTickets true ist und der Aufrufer über Berechtigungen verfügt, ist ein Downloadticket für jede sichere Datei in der Antwort enthalten.

actionFilter: SecureFileActionFilter

Gibt zurück

Promise<SecureFile[]>

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

Sichere Dateien abrufen

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

Parameter

project: string

Projekt-ID oder Projektname

secureFileNames: string[]

Eine Liste mit sicheren Datei-IDs

includeDownloadTickets: boolean

Wenn includeDownloadTickets true ist und der Aufrufer über Berechtigungen verfügt, ist ein Downloadticket für jede sichere Datei in der Antwort enthalten.

actionFilter: SecureFileActionFilter

Gibt zurück

Promise<SecureFile[]>

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

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

Parameter

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Gibt zurück

Promise<ArrayBuffer>

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

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

Parameter

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Gibt zurück

Promise<TaskDefinition>

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

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

Parameter

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Gibt zurück

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Taskgruppe abrufen.

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

Parameter

project: string

Projekt-ID oder Projektname

taskGroupId: string

ID der Taskgruppe.

versionSpec: string

Versionsspezifikation der Taskgruppe. Beispiele: 1, 1.0.

expand: TaskGroupExpands

Die Eigenschaften, die erweitert werden sollen. beispiel $expand=Tasks erweitert geschachtelte Aufgabengruppen.

Gibt zurück

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parameter

project: string

Projekt-ID oder Projektname

taskGroupId: string

Gibt zurück

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

taskGroupId: string

revision: number

Gibt zurück

Promise<string>

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

Auflisten von Aufgabengruppen.

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

Parameter

project: string

Projekt-ID oder Projektname

taskGroupId: string

ID der Taskgruppe.

expanded: boolean

"true", um Aufgabengruppen rekursiv zu erweitern. Der Standardwert ist "false".

taskIdFilter: string

Guid der zu filternden taskId.

deleted: boolean

"true", um gelöschte Aufgabengruppen einzuschließen. Der Standardwert ist "false".

top: number

Die Anzahl der abzurufenden Aufgabengruppen.

continuationToken: Date

Ruft die Aufgabengruppen nach dem bereitgestellten Fortsetzungstoken ab.

queryOrder: TaskGroupQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge ab. Der Standardwert ist "CreatedOnDescending".

Gibt zurück

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parameter

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Gibt zurück

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Abrufen einer Variablengruppe.

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

Parameter

project: string

Projekt-ID oder Projektname

groupId: number

ID der Variablengruppe.

Gibt zurück

Promise<VariableGroup>

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

Abrufen von Variablengruppen.

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

Parameter

project: string

Projekt-ID oder Projektname

groupName: string

Name der Variablengruppe.

actionFilter: VariableGroupActionFilter

Aktionsfilter für die Variablengruppe. Es gibt die Aktion an, die für die Variablengruppen ausgeführt werden kann.

top: number

Anzahl der variablen Gruppen, die abgerufen werden sollen.

continuationToken: number

Ruft die Variablengruppen nach dem bereitgestellten Fortsetzungstoken ab.

queryOrder: VariableGroupQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge ab. Der Standardwert ist "IdDescending".

Gibt zurück

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Abrufen von Variablengruppen nach ID.

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

Parameter

project: string

Projekt-ID oder Projektname

groupIds: number[]

Durch Trennzeichen getrennte Liste der Ids von Variablengruppen.

loadSecrets: boolean

Flag, das angibt, ob die Geheimnisse in Variablengruppen geladen werden sollen.

Gibt zurück

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Gibt zurück

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Gibt zurück

Promise<string>

getYamlSchema(boolean)

RUFEN Sie das yaml-Schema ab, das für die Yaml-Dateiüberprüfung verwendet wird.

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

Parameter

validateTaskNames: boolean

Gibt an, ob das Schema überprüfen soll, ob Aufgaben tatsächlich installiert sind (nützlich für Offlinetools, bei denen sie keine Überprüfung wünschen).

Gibt zurück

Promise<any>

hasPoolPermissions(number, number)

Überprüft, ob die aktuelle Identität Berechtigungen für einen Pool übergeben hat.

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

Parameter

poolId: number

ID des zu überprüfenden Pools

permissions: number

Zu überprüfende Berechtigungen. Mehrere Berechtigungen können mithilfe des bitweisen OR-Operators (z. B. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Gibt zurück

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parameter

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Projekt-ID oder Projektname

parentTaskGroupId: string

Gibt zurück

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy für eine GET-Anforderung, die durch einen "Endpunkt" definiert wird. Die Anforderung wird mithilfe einer Dienstverbindung autorisiert. Die Antwort wird mithilfe eines XPath/Json-basierten Selektors gefiltert.

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

Parameter

endpoint: TaskDefinitionEndpoint

Beschreibt die abzurufende URL.

Gibt zurück

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Abfragen sicherer Dateien mithilfe eines Namensmusters und einer Bedingung für Dateieigenschaften.

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

Parameter

condition: string

Die Syntax der Standard Bedingung wird hier beschrieben. Verwenden Sie die Funktion property('property-name'), um auf den Wert der angegebenen Eigenschaft einer sicheren Datei zuzugreifen. Es gibt NULL zurück, wenn die Eigenschaft nicht festgelegt ist. Beispiel: and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Projekt-ID oder Projektname

namePattern: string

Name der zu übereinstimmenden sicheren Datei. Kann Wildcards enthalten, um mehrere Dateien abzugleichen.

Gibt zurück

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parameter

job: TaskAgentPoolMaintenanceJob

poolId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parameter

request: TaskAgentJobRequest

project: string

Projekt-ID oder Projektname

queueId: number

Gibt zurück

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parameter

request: TaskAgentJobRequest

poolId: number

Gibt zurück

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parameter

poolId: number

agentId: number

Gibt zurück

Promise<void>

refreshAgents(number)

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

Parameter

poolId: number

Gibt zurück

Promise<void>

refreshDeploymentMachines(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

Gibt zurück

Promise<void>

refreshDeploymentTargets(string, number)

Aktualisieren Sie die Bereitstellungsziele in einer Bereitstellungsgruppe.

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

Parameter

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe.

Gibt zurück

Promise<void>

replaceAgent(TaskAgent, number, number)

Ersetzen Sie einen Agent. Sie möchten diesen Endpunkt wahrscheinlich nicht direkt aufrufen. Verwenden Sie stattdessen das Agentkonfigurationsskript, um einen Agent aus Ihrem organization zu entfernen und neu zu konfigurieren.

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

Parameter

agent: TaskAgent

Details zum ersetzenden Agent wurden aktualisiert.

poolId: number

Der zu verwendende Agentpool.

agentId: number

Der zu ersetzende Agent

Gibt zurück

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameter

machine: DeploymentMachine

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineId: number

Gibt zurück

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Ersetzen Sie ein Bereitstellungsziel in einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.

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

Parameter

machine: DeploymentMachine

Neues Bereitstellungsziel.

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der das Bereitstellungsziel ersetzt wird.

targetId: number

ID des zu ersetzenden Bereitstellungsziels.

Gibt zurück

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parameter

message: TaskAgentMessage

poolId: number

requestId: number

Gibt zurück

Promise<void>

setAgentPoolMetadata(any, number)

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

Parameter

agentPoolMetadata: any

poolId: number

Gibt zurück

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Fügen Sie eine Variablengruppe hinzu.

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

Parameter

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Gibt zurück

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parameter

taskGroup: TaskGroup

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Agentdetails aktualisieren.

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

Parameter

agent: TaskAgent

Aktualisierte Details zum Agent

poolId: number

Der zu verwendende Agentpool.

agentId: number

Der zu aktualisierende Agent

Gibt zurück

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parameter

updatedCloud: TaskAgentCloud

agentCloudId: number

Gibt zurück

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Aktualisieren von Eigenschaften in einem Agentpool

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

Parameter

pool: TaskAgentPool

Aktualisierte Agentpooldetails

poolId: number

Der zu aktualisierende Agentpool

Gibt zurück

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parameter

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parameter

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Gibt zurück

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parameter

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Gibt zurück

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parameter

poolId: number

agentId: number

currentState: string

Gibt zurück

Promise<TaskAgent>

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

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

Parameter

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Gibt zurück

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Aktualisieren sie eine Bereitstellungsgruppe.

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

Parameter

deploymentGroup: DeploymentGroupUpdateParameter

Zu aktualisierende Bereitstellungsgruppe.

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe.

Gibt zurück

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameter

machine: DeploymentMachine

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

machineId: number

Gibt zurück

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parameter

machineGroup: DeploymentMachineGroup

project: string

Projekt-ID oder Projektname

machineGroupId: number

Gibt zurück

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parameter

deploymentMachines: DeploymentMachine[]

project: string

Projekt-ID oder Projektname

machineGroupId: number

Gibt zurück

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parameter

machines: DeploymentMachine[]

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

Gibt zurück

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Aktualisieren Sie ein Bereitstellungsziel und dessen Agenteigenschaften in einer Bereitstellungsgruppe. Im Allgemeinen wird dies vom Agentkonfigurationstool aufgerufen.

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

Parameter

machine: DeploymentMachine

Zu aktualisierende Bereitstellungsziel.

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der das Bereitstellungsziel aktualisiert wird.

targetId: number

ID des zu aktualisierenden Bereitstellungsziels.

Gibt zurück

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Aktualisieren sie Tags einer Liste von Bereitstellungszielen in einer Bereitstellungsgruppe.

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

Parameter

machines: DeploymentTargetUpdateParameter[]

Bereitstellungsziele mit Tags für udpdate.

project: string

Projekt-ID oder Projektname

deploymentGroupId: number

ID der Bereitstellungsgruppe, in der Die Bereitstellungsziele aktualisiert werden.

Gibt zurück

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Aktualisieren Sie die angegebene Umgebung.

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

Parameter

environmentUpdateParameter: EnvironmentUpdateParameter

Zu aktualisierende Umgebungsdaten.

project: string

Projekt-ID oder Projektname

environmentId: number

ID der Umgebung.

Gibt zurück

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Aktualisieren des Namens oder der Eigenschaften einer vorhandenen sicheren Datei

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

Parameter

secureFile: SecureFile

Die sichere Datei mit aktualisierten Namen und/oder Eigenschaften

project: string

Projekt-ID oder Projektname

secureFileId: string

Die eindeutige id der sicheren Datei

Gibt zurück

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Aktualisieren von Eigenschaften und/oder Namen einer Gruppe sicherer Dateien. Dateien werden durch ihre IDs identifiziert. Die bereitgestellten Eigenschaften setzen die vorhandene vollständig außer Kraft, d. h. führen nicht zusammen.

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

Parameter

secureFiles: SecureFile[]

Eine Liste mit sicheren Dateiobjekten. Es müssen nur drei Felder mit ID, Name und Eigenschaften ausgefüllt werden. Die restlichen Felder im -Objekt werden ignoriert.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Aktualisieren sie eine Aufgabengruppe.

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

Parameter

taskGroup: TaskGroupUpdateParameter

Zu aktualisierende Aufgabengruppe.

project: string

Projekt-ID oder Projektname

taskGroupId: string

ID der zu aktualisierenden Aufgabengruppe.

Gibt zurück

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parameter

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Projekt-ID oder Projektname

taskGroupId: string

disablePriorVersions: boolean

Gibt zurück

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parameter

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Gibt zurück

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Aktualisieren einer Variablengruppe.

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

Parameter

variableGroupParameters: VariableGroupParameters

groupId: number

ID der zu aktualisierenden Variablengruppe.

Gibt zurück

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parameter

resource: VirtualMachineGroup

project: string

Projekt-ID oder Projektname

environmentId: number

Gibt zurück

Promise<VirtualMachineGroup>

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

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

Parameter

machines: VirtualMachine[]

project: string

Projekt-ID oder Projektname

environmentId: number

resourceId: number

Gibt zurück

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Hochladen einer sicheren Datei, Einschließen des Dateidatenstroms in den Anforderungstext

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

Parameter

content: any

Hochzuladende Inhalte

project: string

Projekt-ID oder Projektname

name: string

Name der hochzuladenden Datei

authorizePipelines: boolean

Wenn authorizePipelines true ist, ist die sichere Datei für die Verwendung durch alle Pipelines im Projekt autorisiert.

Gibt zurück

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parameter

inputValidationRequest: InputValidationRequest

Gibt zurück

Promise<InputValidationRequest>

Share via

TaskAgentRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

TaskAgentRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

addAgent(TaskAgent, number)

Parameter

Gibt zurück

addAgentCloud(TaskAgentCloud)

Parameter

Gibt zurück

addAgentPool(TaskAgentPool)

Parameter

Gibt zurück

addAgentQueue(TaskAgentQueue, string, boolean)

Parameter

Gibt zurück

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parameter

Gibt zurück

addDeploymentMachine(DeploymentMachine, string, number)

Parameter

Gibt zurück

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parameter

Gibt zurück

addDeploymentTarget(DeploymentMachine, string, number)

Parameter

Gibt zurück

addEnvironment(EnvironmentCreateParameter, string)

Parameter

Gibt zurück

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parameter

Gibt zurück

addTaskGroup(TaskGroupCreateParameter, string)

Parameter

Gibt zurück

addVariableGroup(VariableGroupParameters)

Parameter

Gibt zurück

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parameter

Gibt zurück

createAgentSession(TaskAgentSession, number)

Parameter

Gibt zurück

createTeamProject(string)

Parameter

Gibt zurück

deleteAgent(number, number)

Parameter

Gibt zurück

deleteAgentCloud(number)

Parameter

Gibt zurück

deleteAgentPool(number)

Parameter

Gibt zurück

deleteAgentPoolMaintenanceDefinition(number, number)

Parameter

Gibt zurück

deleteAgentPoolMaintenanceJob(number, number)

Parameter

Gibt zurück

deleteAgentQueue(number, string)

Parameter