TaskAgentRestClient class

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends: RestClientBase

Constructeurs

TaskAgentRestClient(IVssRestClientOptions)

Propriétés

Méthodes

addAgent(TaskAgent, number)	Ajoute un agent à un pool. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Au lieu de cela, configurer un agent à l’aide du package de téléchargement de l’agent.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Créez un pool d’agents.
addAgentQueue(TaskAgentQueue, string, boolean)	Créez une file d’attente d’agents pour connecter un projet à un pool d’agents.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Créez un groupe de déploiement.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Inscrivez une cible de déploiement dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.
addEnvironment(EnvironmentCreateParameter, string)	Créez un environnement.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Créez un groupe de tâches.
addVariableGroup(VariableGroupParameters)	Ajoutez un groupe de variables.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Créez un projet d’équipe.
deleteAgent(number, number)	Supprimer un agent. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Utilisez plutôt le script de configuration de l’agent pour supprimer un agent de votre organisation.
deleteAgentCloud(number)
deleteAgentPool(number)	Supprimer un pool d’agents.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Supprime une file d’attente d’agent d’un projet.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Supprimer un groupe de déploiement.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Supprimer une cible de déploiement dans un groupe de déploiement. Cela supprime également l’agent du pool de déploiement associé.
deleteEnvironment(string, number)	Supprimez l’environnement spécifié.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Supprimer un fichier sécurisé
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Supprimer un groupe de tâches.
deleteVariableGroup(number, string[])	Supprimer un groupe de variables
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Télécharger un fichier sécurisé par Id
generateDeploymentGroupAccessToken(string, number)	GET un jeton PAT pour gérer (configuration, suppression, balisage) les cibles de déploiement dans un groupe de déploiement.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	OBTENEZ un jeton PAT pour gérer (configuration, suppression, balisage) les agents de déploiement dans un pool de déploiement.
getAgent(number, number, boolean, boolean, boolean, string[])	Obtenez des informations sur un agent.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Obtenez les types de cloud d’agent.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Obtenez des informations sur un pool d’agents.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Obtenez la liste des pools d’agents.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Obtenez la liste des pools d’agents.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Obtenez des informations sur une file d’attente d’agents.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Obtenir la liste des files d’attente d’agents.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Obtenir une liste des files d’attente d’agents par leur ID
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Obtenir une liste des files d’attente d’agents par leur nom
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Obtenir la liste des files d’attente d’agent par ID de pool
getAgentRequest(number, number, boolean)
getAgentRequests(number, number, string)
getAgentRequestsForAgent(number, number, number)
getAgentRequestsForAgents(number, number[], number)
getAgentRequestsForDeploymentMachine(string, number, number, number)
getAgentRequestsForDeploymentMachines(string, number, number[], number)
getAgentRequestsForDeploymentTarget(string, number, number, number)	Obtenir les demandes d’agent pour une cible de déploiement.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Obtenir les demandes de l’agent pour une liste de cibles de déploiement.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Obtenez une liste d’agents.
getAzureManagementGroups()	Retourne la liste des abonnements Azure
getAzureSubscriptions()	Retourne la liste des abonnements Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Obtenez un groupe de déploiement par son ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Obtenez la liste des groupes de déploiement par nom ou ID.
getDeploymentGroupsMetrics(string, string, string, number)	Obtenez la liste des métriques de groupe de déploiement.
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[])	Obtenez la liste des résumés des pools de déploiement.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Obtenir une cible de déploiement par son ID dans un groupe de déploiement
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Obtenez la liste des cibles de déploiement dans un groupe de déploiement.
getEnvironmentById(string, number, EnvironmentExpands)	Obtenez un environnement par son ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Obtenir l’historique d’exécution du déploiement de l’environnement
getEnvironments(string, string, string, number)	Obtenez tous les environnements.
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)	Obtenir un fichier sécurisé
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Obtenez des fichiers sécurisés
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Obtenez des fichiers sécurisés
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Obtenez des fichiers sécurisés
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Obtenir le groupe de tâches.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Dresser la liste des groupes de tâches.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Obtenez un groupe variable.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Obtenir des groupes de variables.
getVariableGroupsById(string, number[], boolean)	Obtenir des groupes de variables par ids.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	GET le schéma Yaml utilisé pour la validation du fichier Yaml.
hasPoolPermissions(number, number)	Vérifie si l’identité actuelle a transmis des autorisations sur un pool.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy pour une requête GET définie par un « point de terminaison ». La demande est autorisée à l’aide d’une connexion de service. La réponse est filtrée à l’aide d’un sélecteur XPath/Json.
querySecureFilesByProperties(string, string, string)	Interrogez des fichiers sécurisés à l’aide d’un modèle de nom et d’une condition sur les propriétés du fichier.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Mettez à niveau les cibles de déploiement dans un groupe de déploiement.
replaceAgent(TaskAgent, number, number)	Remplacez un agent. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Au lieu de cela, utiliser le script de configuration de l’agent pour supprimer et reconfigurer un agent de votre organisation.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Remplacez une cible de déploiement dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Ajoutez un groupe de variables.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Mettre à jour les détails de l’agent.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Mettre à jour les propriétés d’un pool d’agents
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)	Mettez à jour un groupe de déploiement.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Mettre à jour une cible de déploiement et ses propriétés d’agent dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Mettez à jour les balises d’une liste de cibles de déploiement dans un groupe de déploiement.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Mettez à jour l’environnement spécifié.
updateSecureFile(SecureFile, string, string)	Mettre à jour le nom ou les propriétés d’un fichier sécurisé existant
updateSecureFiles(SecureFile[], string)	Mettre à jour les propriétés et/ou les noms d’un ensemble de fichiers sécurisés. Les fichiers sont identifiés par leur identifiant. Les propriétés fournies remplacent entièrement la propriété existante, c’est-à-dire qu’elles ne fusionnent pas.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Mettre à jour un groupe de tâches.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Mettre à jour un groupe de variables.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Chargez un fichier sécurisé, incluez le flux de fichiers dans le corps de la demande
validateInputs(InputValidationRequest)

Détails du constructeur

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addAgent(TaskAgent, number)

Ajoute un agent à un pool. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Au lieu de cela, configurer un agent à l’aide du package de téléchargement de l’agent.

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

Paramètres

agent: TaskAgent

Détails sur l’agent ajouté

poolId: number

Pool d’agents dans lequel ajouter l’agent

Retours

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Paramètres

agentCloud: TaskAgentCloud

Retours

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Créez un pool d’agents.

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

Paramètres

pool: TaskAgentPool

Détails sur le nouveau pool d’agents

Retours

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Créez une file d’attente d’agents pour connecter un projet à un pool d’agents.

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

Paramètres

queue: TaskAgentQueue

Détails sur la file d’attente à créer

project: string

ID de projet ou nom du projet

authorizePipelines: boolean

Autoriser automatiquement cette file d’attente lors de l’utilisation de YAML

Retours

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Créez un groupe de déploiement.

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

Paramètres

deploymentGroup: DeploymentGroupCreateParameter

Groupe de déploiement à créer.

project: string

ID de projet ou nom du projet

Retours

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Paramètres

machine: DeploymentMachine

project: string

ID de projet ou nom du projet

deploymentGroupId: number

Retours

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Paramètres

machineGroup: DeploymentMachineGroup

project: string

ID de projet ou nom du projet

Retours

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Inscrivez une cible de déploiement dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.

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

Paramètres

machine: DeploymentMachine

Cible de déploiement à enregistrer.

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel la cible de déploiement est enregistrée.

Retours

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Créez un environnement.

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

Paramètres

environmentCreateParameter: EnvironmentCreateParameter

Environnement à créer.

project: string

ID de projet ou nom du projet

Retours

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Paramètres

createParameters: KubernetesResourceCreateParameters

project: string

ID de projet ou nom du projet

environmentId: number

Retours

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Créez un groupe de tâches.

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

Paramètres

taskGroup: TaskGroupCreateParameter

Objet de groupe de tâches à créer.

project: string

ID de projet ou nom du projet

Retours

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Ajoutez un groupe de variables.

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

Paramètres

variableGroupParameters: VariableGroupParameters

Retours

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Paramètres

createParameters: VirtualMachineGroupCreateParameters

project: string

ID de projet ou nom du projet

environmentId: number

Retours

Promise<VirtualMachineGroup>

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

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

Paramètres

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Retours

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Paramètres

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Retours

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Paramètres

session: TaskAgentSession

poolId: number

Retours

Promise<TaskAgentSession>

createTeamProject(string)

Créez un projet d’équipe.

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<void>

deleteAgent(number, number)

Supprimer un agent. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Utilisez plutôt le script de configuration de l’agent pour supprimer un agent de votre organisation.

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

Paramètres

poolId: number

ID de pool à partir duquel l’agent doit être supprimé

agentId: number

L’ID de l’agent à supprimer

Retours

Promise<void>

deleteAgentCloud(number)

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

Paramètres

agentCloudId: number

Retours

Promise<TaskAgentCloud>

deleteAgentPool(number)

Supprimer un pool d’agents.

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

Paramètres

poolId: number

ID du pool d’agents à supprimer

Retours

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Paramètres

poolId: number

definitionId: number

Retours

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Paramètres

poolId: number

jobId: number

Retours

Promise<void>

deleteAgentQueue(number, string)

Supprime une file d’attente d’agent d’un projet.

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

Paramètres

queueId: number

File d’attente de l’agent à supprimer

project: string

ID de projet ou nom du projet

Retours

Promise<void>

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

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

Paramètres

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Retours

Promise<void>

deleteAgentSession(number, string)

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

Paramètres

poolId: number

sessionId: string

Retours

Promise<void>

deleteDeploymentGroup(string, number)

Supprimer un groupe de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement à supprimer.

Retours

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineId: number

Retours

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

machineGroupId: number

Retours

Promise<void>

deleteDeploymentTarget(string, number, number)

Supprimer une cible de déploiement dans un groupe de déploiement. Cela supprime également l’agent du pool de déploiement associé.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel la cible de déploiement est supprimée.

targetId: number

ID de la cible de déploiement à supprimer.

Retours

Promise<void>

deleteEnvironment(string, number)

Supprimez l’environnement spécifié.

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

ID de l’environnement.

Retours

Promise<void>

deleteKubernetesResource(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

Retours

Promise<void>

deleteMessage(number, number, string)

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

Paramètres

poolId: number

messageId: number

sessionId: string

Retours

Promise<void>

deleteSecureFile(string, string)

Supprimer un fichier sécurisé

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

Paramètres

project: string

ID de projet ou nom du projet

secureFileId: string

L’ID unique du fichier sécurisé

Retours

Promise<void>

deleteTaskDefinition(string)

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

Paramètres

taskId: string

Retours

Promise<void>

deleteTaskGroup(string, string, string)

Supprimer un groupe de tâches.

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

Id du groupe de tâches à supprimer.

comment: string

Commentaires à supprimer.

Retours

Promise<void>

deleteVariableGroup(number, string[])

Supprimer un groupe de variables

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

Paramètres

groupId: number

Id du groupe de variables.

projectIds: string[]

Retours

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

Retours

Promise<void>

downloadSecureFile(string, string, string, boolean)

Télécharger un fichier sécurisé par Id

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

Paramètres

project: string

ID de projet ou nom du projet

secureFileId: string

L’ID unique du fichier sécurisé

ticket: string

Un billet de téléchargement valide

download: boolean

Si la valeur download est true, le fichier est envoyé en pièce jointe dans le corps de la réponse. Si la valeur de download est false, le corps de la réponse contient le flux de fichiers.

Retours

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

GET un jeton PAT pour gérer (configuration, suppression, balisage) les cibles de déploiement dans un groupe de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel les cibles de déploiement sont gérées.

Retours

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

machineGroupId: number

Retours

Promise<string>

generateDeploymentPoolAccessToken(number)

OBTENEZ un jeton PAT pour gérer (configuration, suppression, balisage) les agents de déploiement dans un pool de déploiement.

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

Paramètres

poolId: number

ID du pool de déploiement dans lequel les agents de déploiement sont gérés.

Retours

Promise<string>

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

Obtenez des informations sur un agent.

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

Paramètres

poolId: number

Pool d’agents contenant l’agent

agentId: number

ID de l’agent pour obtenir des informations sur

includeCapabilities: boolean

Indique s’il faut inclure les fonctionnalités de l’agent dans la réponse

includeAssignedRequest: boolean

Indique s’il faut inclure des détails sur le travail actuel de l’agent

includeLastCompletedRequest: boolean

Indique s’il faut inclure des détails sur le travail terminé le plus récent des agents

propertyFilters: string[]

Filtrer les propriétés personnalisées qui seront retournées

Retours

Promise<TaskAgent>

getAgentCloud(number)

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

Paramètres

agentCloudId: number

Retours

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Paramètres

agentCloudId: number

Retours

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Retours

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Obtenez les types de cloud d’agent.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Retours

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Obtenez des informations sur un pool d’agents.

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

Paramètres

poolId: number

Un ID de pool d’agents

properties: string[]

Propriétés du pool d’agents (séparées par des virgules)

actionFilter: TaskAgentPoolActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Paramètres

poolId: number

definitionId: number

Retours

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Paramètres

poolId: number

Retours

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Paramètres

poolId: number

jobId: number

Retours

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Paramètres

poolId: number

jobId: number

Retours

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Paramètres

poolId: number

definitionId: number

Retours

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Paramètres

poolId: number

Retours

Promise<string>

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

Obtenez la liste des pools d’agents.

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

Paramètres

poolName: string

Filtrer par nom

properties: string[]

Filtrer par propriétés du pool d’agents (séparées par des virgules)

poolType: TaskAgentPoolType

Filtrer par type de piscine

actionFilter: TaskAgentPoolActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Obtenez la liste des pools d’agents.

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

Paramètres

poolIds: number[]

Identifiants de pool à récupérer

actionFilter: TaskAgentPoolActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Obtenez des informations sur une file d’attente d’agents.

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

Paramètres

queueId: number

La file d’attente de l’agent sur laquelle obtenir des informations

project: string

ID de projet ou nom du projet

actionFilter: TaskAgentQueueActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Obtenir la liste des files d’attente d’agents.

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

Paramètres

project: string

ID de projet ou nom du projet

queueName: string

Filtrer sur le nom de la file d’attente de l’agent

actionFilter: TaskAgentQueueActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Obtenir une liste des files d’attente d’agents par leur ID

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

Paramètres

queueIds: number[]

Liste d’ID de file d’attente d’agent séparés par des virgules à récupérer

project: string

ID de projet ou nom du projet

actionFilter: TaskAgentQueueActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Obtenir une liste des files d’attente d’agents par leur nom

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

Paramètres

queueNames: string[]

Une liste de noms d’agents séparés par des virgules à récupérer

project: string

ID de projet ou nom du projet

actionFilter: TaskAgentQueueActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Obtenir la liste des files d’attente d’agent par ID de pool

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

Paramètres

poolIds: number[]

Une liste d’ID de pool séparés par des virgules pour obtenir les files d’attente correspondantes

project: string

ID de projet ou nom du projet

actionFilter: TaskAgentQueueActionFilter

Filtrer selon que l’utilisateur appelant dispose des autorisations d’utilisation ou de gestion

Retours

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Paramètres

poolId: number

requestId: number

includeStatus: boolean

Retours

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Paramètres

poolId: number

top: number

continuationToken: string

Retours

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Paramètres

poolId: number

agentId: number

completedRequestCount: number

Retours

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Paramètres

poolId: number

agentIds: number[]

completedRequestCount: number

Retours

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineId: number

completedRequestCount: number

Retours

Promise<TaskAgentJobRequest[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Retours

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Obtenir les demandes d’agent pour une cible de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement auquel appartient la cible.

targetId: number

ID de la cible de déploiement.

completedRequestCount: number

Nombre maximal de demandes de retour complétées. La valeur par défaut est 50

Retours

Promise<TaskAgentJobRequest[]>

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

Obtenir les demandes de l’agent pour une liste de cibles de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement auquel appartiennent les cibles.

targetIds: number[]

Liste des ID des cibles de déploiement, séparés par des virgules.

ownerId: number

Id du propriétaire de la demande de travail de l’agent.

completedOn: Date

Datetime de retour de la demande après cette heure.

completedRequestCount: number

Nombre maximal de demandes complétées à retourner pour chaque cible. La valeur par défaut est 50

Retours

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Paramètres

poolId: number

planId: string

jobId: string

Retours

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Paramètres

project: string

ID de projet ou nom du projet

queueId: number

top: number

continuationToken: string

Retours

Promise<PagedList<TaskAgentJobRequest>>

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

Obtenez une liste d’agents.

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

Paramètres

poolId: number

Pool d’agents contenant les agents

agentName: string

Filtrer sur le nom de l’agent

includeCapabilities: boolean

Indique s’il faut inclure les fonctionnalités des agents dans la réponse

includeAssignedRequest: boolean

Indique s’il faut inclure des détails sur le travail actuel des agents

includeLastCompletedRequest: boolean

Indique s’il faut inclure des détails sur le travail terminé le plus récent des agents

propertyFilters: string[]

Filtrer les propriétés personnalisées qui seront retournées

demands: string[]

Filtrer par demande que les agents puissent satisfaire

Retours

Promise<TaskAgent[]>

getAzureManagementGroups()

Retourne la liste des abonnements Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Retours

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Retourne la liste des abonnements Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Retours

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Obtenez un groupe de déploiement par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement.

actionFilter: DeploymentGroupActionFilter

Obtenez le groupe de déploiement uniquement si cette action peut être effectuée dessus.

expand: DeploymentGroupExpands

Incluez ces détails supplémentaires dans l’objet retourné.

Retours

Promise<DeploymentGroup>

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

Obtenez la liste des groupes de déploiement par nom ou ID.

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

Paramètres

project: string

ID de projet ou nom du projet

name: string

Nom du groupe de déploiement.

actionFilter: DeploymentGroupActionFilter

Obtenez uniquement les groupes de déploiement sur lesquels cette action peut être effectuée.

expand: DeploymentGroupExpands

Incluez ces détails supplémentaires dans les objets retournés.

continuationToken: string

Obtenez des groupes de déploiement avec des noms supérieurs à ce continuationToken lexicographiquement.

top: number

Nombre maximal de groupes de déploiement à retourner. La valeur par défaut est 1 000.

ids: number[]

Liste séparée par des virgules des ID des groupes de déploiement.

Retours

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Obtenez la liste des métriques de groupe de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupName: string

Nom du groupe de déploiement.

continuationToken: string

Obtenez des métriques pour les groupes de déploiement dont le nom est supérieur à ce continuationToken de manière lexicographique.

top: number

Nombre maximal de métriques de groupe de déploiement à renvoyer. La valeur par défaut est 50.

Retours

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Retours

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Paramètres

project: string

ID de projet ou nom du projet

machineGroupId: number

actionFilter: MachineGroupActionFilter

Retours

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Paramètres

project: string

ID de projet ou nom du projet

machineGroupId: number

tagFilters: string[]

Retours

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Paramètres

project: string

ID de projet ou nom du projet

machineGroupName: string

actionFilter: MachineGroupActionFilter

Retours

Promise<DeploymentMachineGroup[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Retours

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Obtenez la liste des résumés des pools de déploiement.

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

Paramètres

poolName: string

Nom du pool de déploiement.

expands: DeploymentPoolSummaryExpands

Incluez ces détails supplémentaires dans les objets retournés.

poolIds: number[]

Liste des ID de pool de déploiement.

Retours

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Obtenir une cible de déploiement par son ID dans un groupe de déploiement

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement auquel appartient la cible de déploiement.

targetId: number

ID de la cible de déploiement à retourner.

expand: DeploymentTargetExpands

Incluez ces détails supplémentaires dans les objets retournés.

Retours

Promise<DeploymentMachine>

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

Obtenez la liste des cibles de déploiement dans un groupe de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement.

tags: string[]

Obtenez uniquement les cibles de déploiement qui contiennent toutes ces virgules separted list of tags.

name: string

Modèle de nom des cibles de déploiement à retourner.

partialNameMatch: boolean

Quand la valeur est true, traite nom comme modèle. Sinon, elle la traite comme une correspondance absolue. La valeur par défaut est False.

expand: DeploymentTargetExpands

Incluez ces détails supplémentaires dans les objets retournés.

agentStatus: TaskAgentStatusFilter

Obtenez uniquement les cibles de déploiement qui ont cet état.

agentJobResult: TaskAgentJobResultFilter

Obtenez uniquement les cibles de déploiement qui ont ce dernier résultat de travail.

continuationToken: string

Obtenez des cibles de déploiement avec des noms supérieurs à ce continuationToken lexicographiquement.

top: number

Nombre maximal de cibles de déploiement à retourner. La valeur par défaut est 1 000.

enabled: boolean

Obtenez uniquement les cibles de déploiement activées ou désactivées. La valeur par défaut est « null » qui retourne toutes les cibles.

propertyFilters: string[]

Retours

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Obtenez un environnement par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

ID de l’environnement.

expands: EnvironmentExpands

Incluez ces détails supplémentaires dans les objets retournés.

Retours

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Obtenir l’historique d’exécution du déploiement de l’environnement

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

continuationToken: string

top: number

Retours

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Obtenez tous les environnements.

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

Paramètres

project: string

ID de projet ou nom du projet

name: string

continuationToken: string

top: number

Retours

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

Retours

Promise<KubernetesResource>

getMessage(number, string, number)

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

Paramètres

poolId: number

sessionId: string

lastMessageId: number

Retours

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Paramètres

packageType: string

platform: string

version: string

Retours

Promise<PackageMetadata>

getPackages(string, string, number)

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

Paramètres

packageType: string

platform: string

top: number

Retours

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Retours

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Paramètres

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Retours

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Obtenir un fichier sécurisé

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

Paramètres

project: string

ID de projet ou nom du projet

secureFileId: string

L’ID unique du fichier sécurisé

includeDownloadTicket: boolean

Si includeDownloadTicket a la valeur true et que l’appelant dispose d’autorisations, un ticket de téléchargement est inclus dans la réponse.

actionFilter: SecureFileActionFilter

Retours

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Obtenez des fichiers sécurisés

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

Paramètres

project: string

ID de projet ou nom du projet

namePattern: string

Nom du fichier sécurisé à mettre en correspondance. Peut inclure des caractères génériques pour correspondre à plusieurs fichiers.

includeDownloadTickets: boolean

Si includeDownloadTickets a la valeur true et que l’appelant dispose d’autorisations, un ticket de téléchargement pour chaque fichier sécurisé est inclus dans la réponse.

actionFilter: SecureFileActionFilter

Filtrez par autorisations de fichiers sécurisés pour l’action Afficher, Gérer ou Utiliser. La valeur par défaut est Afficher.

Retours

Promise<SecureFile[]>

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

Obtenez des fichiers sécurisés

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

Paramètres

project: string

ID de projet ou nom du projet

secureFileIds: string[]

Une liste d’identifiants de fichiers sécurisés

includeDownloadTickets: boolean

Si includeDownloadTickets a la valeur true et que l’appelant dispose d’autorisations, un ticket de téléchargement pour chaque fichier sécurisé est inclus dans la réponse.

actionFilter: SecureFileActionFilter

Retours

Promise<SecureFile[]>

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

Obtenez des fichiers sécurisés

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

Paramètres

project: string

ID de projet ou nom du projet

secureFileNames: string[]

Une liste d’identifiants de fichiers sécurisés

includeDownloadTickets: boolean

Si includeDownloadTickets a la valeur true et que l’appelant dispose d’autorisations, un ticket de téléchargement pour chaque fichier sécurisé est inclus dans la réponse.

actionFilter: SecureFileActionFilter

Retours

Promise<SecureFile[]>

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

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

Paramètres

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retours

Promise<ArrayBuffer>

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

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

Paramètres

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Retours

Promise<TaskDefinition>

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

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

Paramètres

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Retours

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Obtenir le groupe de tâches.

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

Id du groupe de tâches.

versionSpec: string

spécification de version du groupe de tâches. Exemples : 1, 1.0.

expand: TaskGroupExpands

Les propriétés qui doivent être développées. exemple $expand=Tasks développera les groupes de tâches imbriqués.

Retours

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

Retours

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

revision: number

Retours

Promise<string>

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

Dresser la liste des groupes de tâches.

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

Id du groupe de tâches.

expanded: boolean

'true' pour développer récursivement les groupes de tâches. La valeur par défaut est « false ».

taskIdFilter: string

Guid de la taskId à filtrer.

deleted: boolean

'true’pour inclure les groupes de tâches supprimés. La valeur par défaut est « false ».

top: number

Nombre de groupes de tâches à obtenir.

continuationToken: Date

Obtient les groupes de tâches après le jeton de continuation fourni.

queryOrder: TaskGroupQueryOrder

Obtient les résultats dans l’ordre défini. La valeur par défaut est 'CreatedOnDescending'.

Retours

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Paramètres

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Retours

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Obtenez un groupe variable.

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

Paramètres

project: string

ID de projet ou nom du projet

groupId: number

Id du groupe de variables.

Retours

Promise<VariableGroup>

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

Obtenir des groupes de variables.

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

Paramètres

project: string

ID de projet ou nom du projet

groupName: string

Nom du groupe de variables.

actionFilter: VariableGroupActionFilter

Filtre d’action pour le groupe de variables. Il spécifie l’action qui peut être effectuée sur les groupes de variables.

top: number

Nombre de groupes de variables à obtenir.

continuationToken: number

Obtient les groupes de variables après le jeton de continuation fourni.

queryOrder: VariableGroupQueryOrder

Obtient les résultats dans l’ordre défini. La valeur par défaut est 'IdDescending'.

Retours

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Obtenir des groupes de variables par ids.

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

Paramètres

project: string

ID de projet ou nom du projet

groupIds: number[]

Liste des ID des groupes de variables séparés par des virgules.

loadSecrets: boolean

Indicateur indiquant si les secrets au sein des groupes de variables doivent être chargés.

Retours

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Retours

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Retours

Promise<string>

getYamlSchema(boolean)

GET le schéma Yaml utilisé pour la validation du fichier Yaml.

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

Paramètres

validateTaskNames: boolean

Si le schéma doit valider que les tâches sont réellement installées (utile pour les outils hors ligne où vous ne souhaitez pas de validation).

Retours

Promise<any>

hasPoolPermissions(number, number)

Vérifie si l’identité actuelle a transmis des autorisations sur un pool.

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

Paramètres

poolId: number

Identifiant de la piscine à vérifier

permissions: number

Autorisations à vérifier. Plusieurs autorisations peuvent être fusionnées en une seule valeur à l’aide de l’opérateur OR au niveau du bit (par exemple, AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Retours

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Paramètres

taskGroupMetadata: PublishTaskGroupMetadata

project: string

ID de projet ou nom du projet

parentTaskGroupId: string

Retours

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy pour une requête GET définie par un « point de terminaison ». La demande est autorisée à l’aide d’une connexion de service. La réponse est filtrée à l’aide d’un sélecteur XPath/Json.

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

Paramètres

endpoint: TaskDefinitionEndpoint

Décrit l’URL à récupérer.

Retours

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Interrogez des fichiers sécurisés à l’aide d’un modèle de nom et d’une condition sur les propriétés du fichier.

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

Paramètres

condition: string

La syntaxe de la condition principale est décrite ici. Utilisez la fonction property('property-name') pour accéder à la valeur de la propriété spécifiée d’un fichier sécurisé. Il renvoie null si la propriété n’est pas définie. Par exemple and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

ID de projet ou nom du projet

namePattern: string

Nom du fichier sécurisé à mettre en correspondance. Peut inclure des caractères génériques pour correspondre à plusieurs fichiers.

Retours

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Paramètres

job: TaskAgentPoolMaintenanceJob

poolId: number

Retours

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Paramètres

request: TaskAgentJobRequest

project: string

ID de projet ou nom du projet

queueId: number

Retours

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Paramètres

request: TaskAgentJobRequest

poolId: number

Retours

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Paramètres

poolId: number

agentId: number

Retours

Promise<void>

refreshAgents(number)

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

Paramètres

poolId: number

Retours

Promise<void>

refreshDeploymentMachines(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

Retours

Promise<void>

refreshDeploymentTargets(string, number)

Mettez à niveau les cibles de déploiement dans un groupe de déploiement.

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

Paramètres

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement.

Retours

Promise<void>

replaceAgent(TaskAgent, number, number)

Remplacez un agent. Vous ne souhaitez probablement pas appeler ce point de terminaison directement. Au lieu de cela, utiliser le script de configuration de l’agent pour supprimer et reconfigurer un agent de votre organisation.

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

Paramètres

agent: TaskAgent

Mise à jour des détails sur l’agent de remplacement

poolId: number

Pool d’agents à utiliser

agentId: number

Agent à remplacer

Retours

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Paramètres

machine: DeploymentMachine

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineId: number

Retours

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Remplacez une cible de déploiement dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.

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

Paramètres

machine: DeploymentMachine

Nouvel objectif de déploiement.

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel la cible de déploiement est remplacée.

targetId: number

ID de la cible de déploiement à remplacer.

Retours

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Paramètres

message: TaskAgentMessage

poolId: number

requestId: number

Retours

Promise<void>

setAgentPoolMetadata(any, number)

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

Paramètres

agentPoolMetadata: any

poolId: number

Retours

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Ajoutez un groupe de variables.

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

Paramètres

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Retours

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Paramètres

taskGroup: TaskGroup

project: string

ID de projet ou nom du projet

Retours

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Mettre à jour les détails de l’agent.

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

Paramètres

agent: TaskAgent

Mise à jour des détails sur l’agent

poolId: number

Pool d’agents à utiliser

agentId: number

Agent à mettre à jour

Retours

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Paramètres

updatedCloud: TaskAgentCloud

agentCloudId: number

Retours

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Mettre à jour les propriétés d’un pool d’agents

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

Paramètres

pool: TaskAgentPool

Mise à jour des détails du pool d’agents

poolId: number

Pool d’agents à mettre à jour

Retours

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Paramètres

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Retours

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Paramètres

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Retours

Promise<TaskAgentPoolMaintenanceJob>

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

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

Paramètres

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Retours

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Paramètres

poolId: number

agentId: number

currentState: string

Retours

Promise<TaskAgent>

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

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

Paramètres

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Retours

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Mettez à jour un groupe de déploiement.

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

Paramètres

deploymentGroup: DeploymentGroupUpdateParameter

Groupe de déploiement à mettre à jour.

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement.

Retours

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Paramètres

machine: DeploymentMachine

project: string

ID de projet ou nom du projet

deploymentGroupId: number

machineId: number

Retours

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Paramètres

machineGroup: DeploymentMachineGroup

project: string

ID de projet ou nom du projet

machineGroupId: number

Retours

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Paramètres

deploymentMachines: DeploymentMachine[]

project: string

ID de projet ou nom du projet

machineGroupId: number

Retours

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Paramètres

machines: DeploymentMachine[]

project: string

ID de projet ou nom du projet

deploymentGroupId: number

Retours

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Mettre à jour une cible de déploiement et ses propriétés d’agent dans un groupe de déploiement. Généralement, il s’agit de l’outil de configuration de l’agent.

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

Paramètres

machine: DeploymentMachine

Cible de déploiement à mettre à jour.

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel la cible de déploiement est mise à jour.

targetId: number

ID de la cible de déploiement à mettre à jour.

Retours

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Mettez à jour les balises d’une liste de cibles de déploiement dans un groupe de déploiement.

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

Paramètres

machines: DeploymentTargetUpdateParameter[]

Cibles de déploiement avec des balises à udpdate.

project: string

ID de projet ou nom du projet

deploymentGroupId: number

ID du groupe de déploiement dans lequel les cibles de déploiement sont mises à jour.

Retours

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Mettez à jour l’environnement spécifié.

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

Paramètres

environmentUpdateParameter: EnvironmentUpdateParameter

Données d’environnement à mettre à jour.

project: string

ID de projet ou nom du projet

environmentId: number

ID de l’environnement.

Retours

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Mettre à jour le nom ou les propriétés d’un fichier sécurisé existant

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

Paramètres

secureFile: SecureFile

Le fichier sécurisé avec le nom et/ou les propriétés mis à jour

project: string

ID de projet ou nom du projet

secureFileId: string

L’ID unique du fichier sécurisé

Retours

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Mettre à jour les propriétés et/ou les noms d’un ensemble de fichiers sécurisés. Les fichiers sont identifiés par leur identifiant. Les propriétés fournies remplacent entièrement la propriété existante, c’est-à-dire qu’elles ne fusionnent pas.

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

Paramètres

secureFiles: SecureFile[]

Liste des objets de fichier sécurisés. Seuls trois champs doivent être renseignés : Id, Nom et Propriétés. Le reste des champs de l’objet est ignoré.

project: string

ID de projet ou nom du projet

Retours

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Mettre à jour un groupe de tâches.

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

Paramètres

taskGroup: TaskGroupUpdateParameter

Groupe de tâches à mettre à jour.

project: string

ID de projet ou nom du projet

taskGroupId: string

Id du groupe de tâches à mettre à jour.

Retours

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Paramètres

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

ID de projet ou nom du projet

taskGroupId: string

disablePriorVersions: boolean

Retours

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Paramètres

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Retours

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Mettre à jour un groupe de variables.

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

Paramètres

variableGroupParameters: VariableGroupParameters

groupId: number

Id du groupe de variables à mettre à jour.

Retours

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Paramètres

resource: VirtualMachineGroup

project: string

ID de projet ou nom du projet

environmentId: number

Retours

Promise<VirtualMachineGroup>

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

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

Paramètres

machines: VirtualMachine[]

project: string

ID de projet ou nom du projet

environmentId: number

resourceId: number

Retours

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Chargez un fichier sécurisé, incluez le flux de fichiers dans le corps de la demande

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

Paramètres

content: any

Contenu à charger

project: string

ID de projet ou nom du projet

name: string

Nom du fichier à télécharger

authorizePipelines: boolean

Si authorizePipelines a la valeur true, l’utilisation du fichier sécurisé est autorisée par tous les pipelines du projet.

Retours

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Paramètres

inputValidationRequest: InputValidationRequest

Retours

Promise<InputValidationRequest>

Rétroaction

Cette page vous a-t-elle été utile ?

Partager via

TaskAgentRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

TaskAgentRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

addAgent(TaskAgent, number)

Paramètres

Retours

addAgentCloud(TaskAgentCloud)

Paramètres

Retours

addAgentPool(TaskAgentPool)

Paramètres

Retours

addAgentQueue(TaskAgentQueue, string, boolean)

Paramètres

Retours

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Paramètres

Retours

addDeploymentMachine(DeploymentMachine, string, number)

Paramètres

Retours

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Paramètres

Retours

addDeploymentTarget(DeploymentMachine, string, number)

Paramètres

Retours

addEnvironment(EnvironmentCreateParameter, string)

Paramètres

Retours

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Paramètres

Retours

addTaskGroup(TaskGroupCreateParameter, string)

Paramètres

Retours

addVariableGroup(VariableGroupParameters)

Paramètres

Retours

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Paramètres

Retours

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

Paramètres

Retours

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Paramètres

Retours

createAgentSession(TaskAgentSession, number)

Paramètres

Retours

createTeamProject(string)

Paramètres

Retours

deleteAgent(number, number)

Paramètres

Retours

deleteAgentCloud(number)

Paramètres

Retours

deleteAgentPool(number)

Paramètres

Retours

deleteAgentPoolMaintenanceDefinition(number, number)

Paramètres

Retours

deleteAgentPoolMaintenanceJob(number, number)

Paramètres

Retours

deleteAgentQueue(number, string)

Paramètres