TaskAgentRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS
- Extends
Constructeurs
Task |
Propriétés
RESOURCE_AREA_ID |
Méthodes
Détails du constructeur
TaskAgentRestClient(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, configurez 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 en cours d’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)
Create 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)
Create une nouvelle file d’attente d’agent 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)
Create 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)
Inscrire une cible de déploiement dans un groupe de déploiement. En général, cela est appelé par 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 à inscrire.
- project
-
string
ID de projet ou nom du projet
- deploymentGroupId
-
number
ID du groupe de déploiement auprès duquel la cible de déploiement est inscrite.
Retours
Promise<DeploymentMachine>
addEnvironment(EnvironmentCreateParameter, string)
Créer 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)
Create 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)
Create un nouveau 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 organization.
function deleteAgent(poolId: number, agentId: number): Promise<void>
Paramètres
- poolId
-
number
ID de pool à partir duquel supprimer l’agent
- agentId
-
number
ID d’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
ID de fichier sécurisé unique
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
ID de fichier sécurisé unique
- ticket
-
string
Un ticket de téléchargement valide
- download
-
boolean
Si download a la valeur true, le fichier est envoyé en tant qu’attachement dans le corps de la réponse. Si le téléchargement a la valeur false, le corps de la réponse contient le flux de fichier.
Retours
Promise<ArrayBuffer>
generateDeploymentGroupAccessToken(string, number)
OBTENEZ un jeton PAT pour gérer (configurer, supprimer, baliser) 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 la gestion (configuration, suppression, étiquetage) des 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[])
Obtenir 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 d’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()
getAgentCloudTypes()
Obtenir les types de cloud d’agent.
function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>
Retours
Promise<TaskAgentCloudType[]>
getAgentPool(number, string[], TaskAgentPoolActionFilter)
Obtenir des informations sur un pool d’agents.
function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>
Paramètres
- poolId
-
number
ID d’un 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 d’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 pool
- actionFilter
- TaskAgentPoolActionFilter
Filtrer selon que l’utilisateur appelant dispose d’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[]
ID de pool à extraire
- actionFilter
- TaskAgentPoolActionFilter
Filtrer selon que l’utilisateur appelant dispose d’autorisations d’utilisation ou de gestion
Retours
Promise<TaskAgentPool[]>
getAgentQueue(number, string, TaskAgentQueueActionFilter)
Obtenir des informations sur une file d’attente d’agent.
function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>
Paramètres
- queueId
-
number
File d’attente de l’agent pour obtenir des informations sur
- project
-
string
ID de projet ou nom du projet
- actionFilter
- TaskAgentQueueActionFilter
Filtrer selon que l’utilisateur appelant dispose d’autorisations d’utilisation ou de gestion
Retours
Promise<TaskAgentQueue>
getAgentQueues(string, string, TaskAgentQueueActionFilter)
Obtenez 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 d’autorisations d’utilisation ou de gestion
Retours
Promise<TaskAgentQueue[]>
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)
Obtenir la liste des files d’attente d’agents par ID
function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Paramètres
- queueIds
-
number[]
Liste séparée par des virgules des ID de file d’attente d’agents à récupérer
- project
-
string
ID de projet ou nom du projet
- actionFilter
- TaskAgentQueueActionFilter
Filtrer selon que l’utilisateur appelant dispose d’autorisations d’utilisation ou de gestion
Retours
Promise<TaskAgentQueue[]>
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)
Obtenir la liste des files d’attente d’agents par leur nom
function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Paramètres
- queueNames
-
string[]
Liste séparée par des virgules des noms d’agents à récupérer
- project
-
string
ID de projet ou nom du projet
- actionFilter
- TaskAgentQueueActionFilter
Filtrer selon que l’utilisateur appelant dispose d’autorisations d’utilisation ou de gestion
Retours
Promise<TaskAgentQueue[]>
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)
Obtenir la liste des files d’attente d’agents par ID de pool
function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Paramètres
- poolIds
-
number[]
Liste séparée par des virgules des ID de pool pour obtenir les files d’attente correspondantes pour
- project
-
string
ID de projet ou nom du projet
- actionFilter
- TaskAgentQueueActionFilter
Filtrer selon que l’utilisateur appelant dispose d’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 des 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 terminées à retourner. La valeur par défaut est 50
Retours
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)
Obtenir des demandes d’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 d’ID séparés par des virgules des cibles de déploiement.
- ownerId
-
number
ID du propriétaire de la demande de travail de l’agent.
- completedOn
-
Date
Datetime pour renvoyer la demande après cette heure.
- completedRequestCount
-
number
Nombre maximal de demandes terminé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 la liste des 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 demandes que les agents peuvent 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 sur celui-ci.
- 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 dont le nom est supérieur à cette continuationToken lexicographiquement.
- top
-
number
Nombre maximal de groupes de déploiement à retourner. La valeur par défaut est 1000.
- ids
-
number[]
Liste d’ID séparés par des virgules 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 à cette continuationToken lexicographiquement.
- top
-
number
Nombre maximal de métriques de groupe de déploiement à retourner. 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 du pool 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[])
Obtenir 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 listes de balises séparés par des virgules.
- name
-
string
Nom du modèle des cibles de déploiement à retourner.
- partialNameMatch
-
boolean
Lorsqu’il est défini sur true, traite le nom comme un modèle. Sinon, elle est traitée 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 ce status.
- agentJobResult
- TaskAgentJobResultFilter
Obtenez uniquement les cibles de déploiement qui ont ce dernier résultat de travail.
- continuationToken
-
string
Obtenir des cibles de déploiement avec des noms supérieurs à cette continuationToken lexicographiquement.
- top
-
number
Nombre maximal de cibles de déploiement à retourner. La valeur par défaut est 1000.
- 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)
Obtenir 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 des exécutions de 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
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()
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
ID de fichier sécurisé unique
- 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)
Obtenir 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 faire 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 fichier sécurisées pour l’action Afficher, Gérer ou Utiliser. La valeur par défaut est Affichage.
Retours
Promise<SecureFile[]>
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)
Obtenir 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[]
Liste des ID de fichier 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)
Obtenir 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[]
Liste des ID de fichier 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
Propriétés qui doivent être développées. exemple $expand=Tasks développe 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)
Répertorier les 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 de manière récursive des groupes de tâches. La valeur par défaut est « false ».
- taskIdFilter
-
string
GUID du 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)
Obtenir un groupe de variables.
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 ID.
function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- groupIds
-
number[]
Liste séparée par des virgules des ID des groupes de variables.
- loadSecrets
-
boolean
Indicateur indiquant si les secrets dans les 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)
OBTENEZ le schéma Yaml utilisé pour la validation des fichiers Yaml.
function getYamlSchema(validateTaskNames?: boolean): Promise<any>
Paramètres
- validateTaskNames
-
boolean
Indique si le schéma doit valider que les tâches sont réellement installées (utile pour les outils hors connexion 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
ID du pool à case activée
- permissions
-
number
Autorisations pour case activée. 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 basé sur XPath/Json.
function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>
Paramètres
- endpoint
- TaskDefinitionEndpoint
Décrit l’URL à extraire.
Retours
Promise<string[]>
querySecureFilesByProperties(string, string, string)
Interroger des fichiers sécurisés à l’aide d’un modèle de nom et d’une condition sur les propriétés des fichiers.
function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>
Paramètres
- condition
-
string
La syntaxe de condition main 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é. Elle retourne 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 faire correspondre plusieurs fichiers.
Retours
Promise<SecureFile[]>
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>
Paramètres
- 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. Utilisez plutôt le script de configuration de l’agent pour supprimer et reconfigurer un agent de votre organization.
function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>
Paramètres
- agent
- TaskAgent
Détails mis à jour 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. En général, cela est appelé par l’outil de configuration de l’agent.
function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>
Paramètres
- machine
- DeploymentMachine
Nouvelle cible 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
- 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)
Mettez à jour les détails de l’agent.
function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>
Paramètres
- agent
- TaskAgent
Détails mis à jour 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
Détails du pool d’agents mis à jour
- 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
- 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)
Mettre à 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
- 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
- project
-
string
ID de projet ou nom du projet
- deploymentGroupId
-
number
Retours
Promise<DeploymentMachine[]>
updateDeploymentTarget(DeploymentMachine, string, number, number)
Mettez à jour une cible de déploiement et ses propriétés d’agent dans un groupe de déploiement. En général, cela est appelé par 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)
Mettre à 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
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
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
ID de fichier sécurisé unique
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 leurs ID. Les propriétés fournies remplacent entièrement l’existant, c’est-à-dire qu’elles ne fusionnent pas.
function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>
Paramètres
- secureFiles
Liste d’objets de fichier sécurisés. Seuls trois champs doivent être renseignés ID, Nom et Propriétés. Les autres champs de l’objet sont ignorés.
- 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
- project
-
string
ID de projet ou nom du projet
- environmentId
-
number
- resourceId
-
number
Retours
Promise<VirtualMachine[]>
uploadSecureFile(any, string, string, boolean)
Charger un fichier sécurisé, inclure 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 à charger
- authorizePipelines
-
boolean
Si authorizePipelines a la valeur true, le fichier sécurisé est autorisé à être utilisé par tous les pipelines du projet.
Retours
Promise<SecureFile>
validateInputs(InputValidationRequest)
function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>
Paramètres
- inputValidationRequest
- InputValidationRequest
Retours
Promise<InputValidationRequest>