TaskAgentRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Task |
Propiedades
| RESOURCE_AREA_ID |
Métodos
Detalles del constructor
TaskAgentRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
addAgent(TaskAgent, number)
Agrega un agente a un grupo. Probablemente no quiera llamar directamente a este punto de conexión. En su lugar, configure un agente mediante el paquete de descarga del agente.
function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>Parámetros
- agent
- TaskAgent
Detalles sobre el agente que se va a agregar
- poolId
-
number
Grupo de agentes en el que se va a agregar el agente.
Devoluciones
Promise<TaskAgent>
addAgentCloud(TaskAgentCloud)
function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>Parámetros
- agentCloud
- TaskAgentCloud
Devoluciones
Promise<TaskAgentCloud>
addAgentPool(TaskAgentPool)
Create un grupo de agentes.
function addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>Parámetros
- pool
- TaskAgentPool
Detalles sobre el nuevo grupo de agentes
Devoluciones
Promise<TaskAgentPool>
addAgentQueue(TaskAgentQueue, string, boolean)
Create una nueva cola de agentes para conectar un proyecto a un grupo de agentes.
function addAgentQueue(queue: TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentQueue>Parámetros
- queue
- TaskAgentQueue
Detalles sobre la cola que se va a crear
- project
-
string
Id. de proyecto o nombre del proyecto
- authorizePipelines
-
boolean
Autorización automática de esta cola al usar YAML
Devoluciones
Promise<TaskAgentQueue>
addDeploymentGroup(DeploymentGroupCreateParameter, string)
Create un grupo de implementación.
function addDeploymentGroup(deploymentGroup: DeploymentGroupCreateParameter, project: string): Promise<DeploymentGroup>Parámetros
- deploymentGroup
- DeploymentGroupCreateParameter
Grupo de implementación que se va a crear.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<DeploymentGroup>
addDeploymentMachine(DeploymentMachine, string, number)
function addDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Devoluciones
Promise<DeploymentMachine>
addDeploymentMachineGroup(DeploymentMachineGroup, string)
function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>Parámetros
- machineGroup
- DeploymentMachineGroup
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<DeploymentMachineGroup>
addDeploymentTarget(DeploymentMachine, string, number)
Registre un destino de implementación en un grupo de implementación. Por lo general, la herramienta de configuración del agente llama a esto.
function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
Destino de implementación que se va a registrar.
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación al que está registrado el destino de implementación.
Devoluciones
Promise<DeploymentMachine>
addEnvironment(EnvironmentCreateParameter, string)
Crear un entorno
function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>Parámetros
- environmentCreateParameter
- EnvironmentCreateParameter
Entorno que se va a crear.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<EnvironmentInstance>
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
function addKubernetesResource(createParameters: KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<KubernetesResource>Parámetros
- createParameters
- KubernetesResourceCreateParameters
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Devoluciones
Promise<KubernetesResource>
addTaskGroup(TaskGroupCreateParameter, string)
Create un grupo de tareas.
function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>Parámetros
- taskGroup
- TaskGroupCreateParameter
Objeto de grupo de tareas que se va a crear.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TaskGroup>
addVariableGroup(VariableGroupParameters)
Agregue un grupo de variables.
function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>Parámetros
- variableGroupParameters
- VariableGroupParameters
Devoluciones
Promise<VariableGroup>
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
function addVirtualMachineGroup(createParameters: VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<VirtualMachineGroup>Parámetros
- createParameters
- VirtualMachineGroupCreateParameters
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Devoluciones
Promise<VirtualMachineGroup>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parámetros
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Devoluciones
Promise<string>
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parámetros
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceDefinition>
createAgentSession(TaskAgentSession, number)
function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>Parámetros
- session
- TaskAgentSession
- poolId
-
number
Devoluciones
Promise<TaskAgentSession>
createTeamProject(string)
Create un nuevo proyecto de equipo.
function createTeamProject(project?: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<void>
deleteAgent(number, number)
Elimine un agente. Probablemente no quiera llamar directamente a este punto de conexión. En su lugar, use el script de configuración del agente para quitar un agente de la organización.
function deleteAgent(poolId: number, agentId: number): Promise<void>Parámetros
- poolId
-
number
Identificador del grupo del que se va a quitar el agente
- agentId
-
number
Identificador del agente que se va a quitar
Devoluciones
Promise<void>
deleteAgentCloud(number)
function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>Parámetros
- agentCloudId
-
number
Devoluciones
Promise<TaskAgentCloud>
deleteAgentPool(number)
Elimine un grupo de agentes.
function deleteAgentPool(poolId: number): Promise<void>Parámetros
- poolId
-
number
Identificador del grupo de agentes que se va a eliminar
Devoluciones
Promise<void>
deleteAgentPoolMaintenanceDefinition(number, number)
function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>Parámetros
- poolId
-
number
- definitionId
-
number
Devoluciones
Promise<void>
deleteAgentPoolMaintenanceJob(number, number)
function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>Parámetros
- poolId
-
number
- jobId
-
number
Devoluciones
Promise<void>
deleteAgentQueue(number, string)
Quita una cola de agente de un proyecto.
function deleteAgentQueue(queueId: number, project?: string): Promise<void>Parámetros
- queueId
-
number
Cola del agente que se va a quitar
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<void>
deleteAgentRequest(number, number, string, TaskResult, boolean)
function deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskResult, agentShuttingDown?: boolean): Promise<void>Parámetros
- poolId
-
number
- requestId
-
number
- lockToken
-
string
- result
- TaskResult
- agentShuttingDown
-
boolean
Devoluciones
Promise<void>
deleteAgentSession(number, string)
function deleteAgentSession(poolId: number, sessionId: string): Promise<void>Parámetros
- poolId
-
number
- sessionId
-
string
Devoluciones
Promise<void>
deleteDeploymentGroup(string, number)
Elimine un grupo de implementación.
function deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación que se va a eliminar.
Devoluciones
Promise<void>
deleteDeploymentMachine(string, number, number)
function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineId
-
number
Devoluciones
Promise<void>
deleteDeploymentMachineGroup(string, number)
function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
Devoluciones
Promise<void>
deleteDeploymentTarget(string, number, number)
Elimine un destino de implementación en un grupo de implementación. Esto también elimina el agente del grupo de implementación asociado.
function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación en el que se elimina el destino de implementación.
- targetId
-
number
Identificador del destino de implementación que se va a eliminar.
Devoluciones
Promise<void>
deleteEnvironment(string, number)
Elimine el entorno especificado.
function deleteEnvironment(project: string, environmentId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Identificador del entorno.
Devoluciones
Promise<void>
deleteKubernetesResource(string, number, number)
function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
Devoluciones
Promise<void>
deleteMessage(number, number, string)
function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>Parámetros
- poolId
-
number
- messageId
-
number
- sessionId
-
string
Devoluciones
Promise<void>
deleteSecureFile(string, string)
Eliminación de un archivo seguro
function deleteSecureFile(project: string, secureFileId: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileId
-
string
Identificador de archivo seguro único
Devoluciones
Promise<void>
deleteTaskDefinition(string)
function deleteTaskDefinition(taskId: string): Promise<void>Parámetros
- taskId
-
string
Devoluciones
Promise<void>
deleteTaskGroup(string, string, string)
Elimine un grupo de tareas.
function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
Identificador del grupo de tareas que se va a eliminar.
- comment
-
string
Comentarios que se van a eliminar.
Devoluciones
Promise<void>
deleteVariableGroup(number, string[])
Eliminar un grupo de variables
function deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>Parámetros
- groupId
-
number
Identificador del grupo de variables.
- projectIds
-
string[]
Devoluciones
Promise<void>
deleteVirtualMachineGroup(string, number, number)
function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
Devoluciones
Promise<void>
downloadSecureFile(string, string, string, boolean)
Descarga de un archivo seguro por identificador
function downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileId
-
string
Identificador de archivo seguro único
- ticket
-
string
Un vale de descarga válido
- download
-
boolean
Si la descarga es true, el archivo se envía como adjunto en el cuerpo de la respuesta. Si la descarga es false, el cuerpo de la respuesta contiene la secuencia de archivos.
Devoluciones
Promise<ArrayBuffer>
generateDeploymentGroupAccessToken(string, number)
OBTENGA un token pat para administrar (configurar, quitar, etiquetar) destinos de implementación en un grupo de implementación.
function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación en el que se administran los destinos de implementación.
Devoluciones
Promise<string>
generateDeploymentMachineGroupAccessToken(string, number)
function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
Devoluciones
Promise<string>
generateDeploymentPoolAccessToken(number)
OBTENGA un token pat para administrar (configurar, quitar, etiquetar) agentes de implementación en un grupo de implementaciones.
function generateDeploymentPoolAccessToken(poolId: number): Promise<string>Parámetros
- poolId
-
number
Identificador del grupo de implementación en el que se administran los agentes de implementación.
Devoluciones
Promise<string>
getAgent(number, number, boolean, boolean, boolean, string[])
Obtenga información sobre un agente.
function getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgent>Parámetros
- poolId
-
number
Grupo de agentes que contiene el agente
- agentId
-
number
Identificador del agente para obtener información sobre
- includeCapabilities
-
boolean
Si se deben incluir las funcionalidades del agente en la respuesta
- includeAssignedRequest
-
boolean
Si se deben incluir detalles sobre el trabajo actual del agente
- includeLastCompletedRequest
-
boolean
Si se deben incluir detalles sobre el trabajo completado más reciente de los agentes
- propertyFilters
-
string[]
Filtrar qué propiedades personalizadas se devolverán
Devoluciones
Promise<TaskAgent>
getAgentCloud(number)
function getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>Parámetros
- agentCloudId
-
number
Devoluciones
Promise<TaskAgentCloud>
getAgentCloudRequests(number)
function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>Parámetros
- agentCloudId
-
number
Devoluciones
Promise<TaskAgentCloudRequest[]>
getAgentClouds()
getAgentCloudTypes()
Obtiene los tipos de nube del agente.
function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>Devoluciones
Promise<TaskAgentCloudType[]>
getAgentPool(number, string[], TaskAgentPoolActionFilter)
Obtenga información sobre un grupo de agentes.
function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>Parámetros
- poolId
-
number
Un identificador de grupo de agentes
- properties
-
string[]
Propiedades del grupo de agentes (separadas por comas)
- actionFilter
- TaskAgentPoolActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentPool>
getAgentPoolMaintenanceDefinition(number, number)
function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parámetros
- poolId
-
number
- definitionId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceDefinition>
getAgentPoolMaintenanceDefinitions(number)
function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>Parámetros
- poolId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceDefinition[]>
getAgentPoolMaintenanceJob(number, number)
function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>Parámetros
- poolId
-
number
- jobId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceJob>
getAgentPoolMaintenanceJobLogs(number, number)
function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>Parámetros
- poolId
-
number
- jobId
-
number
Devoluciones
Promise<ArrayBuffer>
getAgentPoolMaintenanceJobs(number, number)
function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>Parámetros
- poolId
-
number
- definitionId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceJob[]>
getAgentPoolMetadata(number)
function getAgentPoolMetadata(poolId: number): Promise<string>Parámetros
- poolId
-
number
Devoluciones
Promise<string>
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)
Obtenga una lista de grupos de agentes.
function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>Parámetros
- poolName
-
string
Filtrar por nombre
- properties
-
string[]
Filtrar por propiedades del grupo de agentes (separadas por comas)
- poolType
- TaskAgentPoolType
Filtrar por tipo de grupo
- actionFilter
- TaskAgentPoolActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentPool[]>
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)
Obtenga una lista de grupos de agentes.
function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>Parámetros
- poolIds
-
number[]
identificadores de grupo que se van a capturar
- actionFilter
- TaskAgentPoolActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentPool[]>
getAgentQueue(number, string, TaskAgentQueueActionFilter)
Obtenga información sobre una cola de agentes.
function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>Parámetros
- queueId
-
number
Cola del agente para obtener información sobre
- project
-
string
Id. de proyecto o nombre del proyecto
- actionFilter
- TaskAgentQueueActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentQueue>
getAgentQueues(string, string, TaskAgentQueueActionFilter)
Obtenga una lista de colas de agentes.
function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- queueName
-
string
Filtrar por el nombre de la cola del agente
- actionFilter
- TaskAgentQueueActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentQueue[]>
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)
Obtención de una lista de colas de agentes por sus identificadores
function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parámetros
- queueIds
-
number[]
Lista separada por comas de identificadores de cola de agentes que se van a recuperar
- project
-
string
Id. de proyecto o nombre del proyecto
- actionFilter
- TaskAgentQueueActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentQueue[]>
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)
Obtención de una lista de colas de agentes por sus nombres
function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parámetros
- queueNames
-
string[]
Lista separada por comas de nombres de agente que se van a recuperar
- project
-
string
Id. de proyecto o nombre del proyecto
- actionFilter
- TaskAgentQueueActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentQueue[]>
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)
Obtención de una lista de colas de agentes por identificadores de grupo
function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>Parámetros
- poolIds
-
number[]
Lista separada por comas de identificadores de grupo para obtener las colas correspondientes para
- project
-
string
Id. de proyecto o nombre del proyecto
- actionFilter
- TaskAgentQueueActionFilter
Filtre por si el usuario que realiza la llamada tiene permisos de uso o administración
Devoluciones
Promise<TaskAgentQueue[]>
getAgentRequest(number, number, boolean)
function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>Parámetros
- poolId
-
number
- requestId
-
number
- includeStatus
-
boolean
Devoluciones
Promise<TaskAgentJobRequest>
getAgentRequests(number, number, string)
function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>Parámetros
- poolId
-
number
- top
-
number
- continuationToken
-
string
Devoluciones
Promise<PagedList<TaskAgentJobRequest>>
getAgentRequestsForAgent(number, number, number)
function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- poolId
-
number
- agentId
-
number
- completedRequestCount
-
number
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForAgents(number, number[], number)
function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- poolId
-
number
- agentIds
-
number[]
- completedRequestCount
-
number
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentMachine(string, number, number, number)
function getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineId
-
number
- completedRequestCount
-
number
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentMachines(string, number, number[], number)
function getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineIds
-
number[]
- completedRequestCount
-
number
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTarget(string, number, number, number)
Obtener solicitudes de agente para un destino de implementación.
function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación al que pertenece el destino.
- targetId
-
number
Identificador del destino de implementación.
- completedRequestCount
-
number
Número máximo de solicitudes completadas que se van a devolver. El valor predeterminado es 50
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)
Obtiene las solicitudes de agente de una lista de destinos de implementación.
function getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación al que pertenecen los destinos.
- targetIds
-
number[]
Lista separada por comas de identificadores de los destinos de implementación.
- ownerId
-
number
Identificador del propietario de la solicitud de trabajo del agente.
- completedOn
-
Date
Datetime para devolver la solicitud después de esta hora.
- completedRequestCount
-
number
Número máximo de solicitudes completadas que se van a devolver para cada destino. El valor predeterminado es 50
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForPlan(number, string, string)
function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>Parámetros
- poolId
-
number
- planId
-
string
- jobId
-
string
Devoluciones
Promise<TaskAgentJobRequest[]>
getAgentRequestsForQueue(string, number, number, string)
function getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- queueId
-
number
- top
-
number
- continuationToken
-
string
Devoluciones
Promise<PagedList<TaskAgentJobRequest>>
getAgents(number, string, boolean, boolean, boolean, string[], string[])
Obtenga una lista de agentes.
function getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgent[]>Parámetros
- poolId
-
number
Grupo de agentes que contiene los agentes
- agentName
-
string
Filtrar por el nombre del agente
- includeCapabilities
-
boolean
Si se deben incluir las funcionalidades de los agentes en la respuesta
- includeAssignedRequest
-
boolean
Si se deben incluir detalles sobre el trabajo actual de los agentes
- includeLastCompletedRequest
-
boolean
Si se deben incluir detalles sobre el trabajo completado más reciente de los agentes
- propertyFilters
-
string[]
Filtrar qué propiedades personalizadas se devolverán
- demands
-
string[]
Filtrar por demandas que los agentes pueden satisfacer
Devoluciones
Promise<TaskAgent[]>
getAzureManagementGroups()
Devuelve la lista de suscripciones de Azure.
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Devoluciones
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Devuelve la lista de suscripciones de Azure.
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Devoluciones
Promise<AzureSubscriptionQueryResult>
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)
Obtenga un grupo de implementación por su identificador.
function getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands): Promise<DeploymentGroup>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación.
- actionFilter
- DeploymentGroupActionFilter
Obtenga el grupo de implementación solo si esta acción se puede realizar en él.
- expand
- DeploymentGroupExpands
Incluya estos detalles adicionales en el objeto devuelto.
Devoluciones
Promise<DeploymentGroup>
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])
Obtenga una lista de grupos de implementación por nombre o identificadores.
function getDeploymentGroups(project: string, name?: string, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<PagedList<DeploymentGroup>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- name
-
string
Nombre del grupo de implementación.
- actionFilter
- DeploymentGroupActionFilter
Obtenga solo los grupos de implementación en los que se puede realizar esta acción.
- expand
- DeploymentGroupExpands
Incluya estos detalles adicionales en los objetos devueltos.
- continuationToken
-
string
Obtenga grupos de implementación con nombres mayores que esta continuaciónToken lexicográficamente.
- top
-
number
Número máximo de grupos de implementación que se van a devolver. El valor predeterminado es 1000.
- ids
-
number[]
Lista separada por comas de identificadores de los grupos de implementación.
Devoluciones
Promise<PagedList<DeploymentGroup>>
getDeploymentGroupsMetrics(string, string, string, number)
Obtenga una lista de métricas de grupo de implementación.
function getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<PagedList<DeploymentGroupMetrics>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupName
-
string
Nombre del grupo de implementación.
- continuationToken
-
string
Obtenga métricas para grupos de implementación con nombres mayores que esta continuaciónToken lexicográficamente.
- top
-
number
Número máximo de métricas de grupo de implementación que se van a devolver. El valor predeterminado es 50.
Devoluciones
Promise<PagedList<DeploymentGroupMetrics>>
getDeploymentMachine(string, number, number, DeploymentMachineExpands)
function getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: DeploymentMachineExpands): Promise<DeploymentMachine>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineId
-
number
- expand
- DeploymentMachineExpands
Devoluciones
Promise<DeploymentMachine>
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
function getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
- actionFilter
- MachineGroupActionFilter
Devoluciones
Promise<DeploymentMachineGroup>
getDeploymentMachineGroupMachines(string, number, string[])
function getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<DeploymentMachine[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
- tagFilters
-
string[]
Devoluciones
Promise<DeploymentMachine[]>
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
function getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupName
-
string
- actionFilter
- MachineGroupActionFilter
Devoluciones
Promise<DeploymentMachineGroup[]>
getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)
function getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: DeploymentMachineExpands): Promise<DeploymentMachine[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- tags
-
string[]
- name
-
string
- expand
- DeploymentMachineExpands
Devoluciones
Promise<DeploymentMachine[]>
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])
Obtenga una lista de resúmenes del grupo de implementación.
function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>Parámetros
- poolName
-
string
Nombre del grupo de implementación.
- expands
- DeploymentPoolSummaryExpands
Incluya estos detalles adicionales en los objetos devueltos.
- poolIds
-
number[]
Lista de identificadores del grupo de implementación.
Devoluciones
Promise<DeploymentPoolSummary[]>
getDeploymentTarget(string, number, number, DeploymentTargetExpands)
Obtención de un destino de implementación por su identificador en un grupo de implementación
function getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: DeploymentTargetExpands): Promise<DeploymentMachine>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación al que pertenece el destino de implementación.
- targetId
-
number
Identificador del destino de implementación que se va a devolver.
- expand
- DeploymentTargetExpands
Incluya estos detalles adicionales en los objetos devueltos.
Devoluciones
Promise<DeploymentMachine>
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])
Obtenga una lista de destinos de implementación en un grupo de implementación.
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>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación.
- tags
-
string[]
Obtenga solo los destinos de implementación que contengan todas estas listas de etiquetas de separación de comas.
- name
-
string
Patrón de nombre de los destinos de implementación que se van a devolver.
- partialNameMatch
-
boolean
Cuando se establece en true, trata el nombre como patrón. Else lo trata como coincidencia absoluta. El valor predeterminado es false.
- expand
- DeploymentTargetExpands
Incluya estos detalles adicionales en los objetos devueltos.
- agentStatus
- TaskAgentStatusFilter
Obtenga solo los destinos de implementación que tengan este estado.
- agentJobResult
- TaskAgentJobResultFilter
Obtenga solo los destinos de implementación que tengan este último resultado de trabajo.
- continuationToken
-
string
Obtenga destinos de implementación con nombres mayores que esta continuaciónToken lexicográficamente.
- top
-
number
Número máximo de destinos de implementación que se van a devolver. El valor predeterminado es 1000.
- enabled
-
boolean
Obtenga solo destinos de implementación habilitados o deshabilitados. El valor predeterminado es "null", que devuelve todos los destinos.
- propertyFilters
-
string[]
Devoluciones
Promise<PagedList<DeploymentMachine>>
getEnvironmentById(string, number, EnvironmentExpands)
Obtenga un entorno por su identificador.
function getEnvironmentById(project: string, environmentId: number, expands?: EnvironmentExpands): Promise<EnvironmentInstance>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Identificador del entorno.
- expands
- EnvironmentExpands
Incluya estos detalles adicionales en los objetos devueltos.
Devoluciones
Promise<EnvironmentInstance>
getEnvironmentDeploymentExecutionRecords(string, number, string, number)
Obtención del historial de ejecución de implementación del entorno
function getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- continuationToken
-
string
- top
-
number
Devoluciones
getEnvironments(string, string, string, number)
Obtenga todos los entornos.
function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- name
-
string
- continuationToken
-
string
- top
-
number
Devoluciones
Promise<PagedList<EnvironmentInstance>>
getKubernetesResource(string, number, number)
function getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<KubernetesResource>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
Devoluciones
Promise<KubernetesResource>
getMessage(number, string, number)
function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>Parámetros
- poolId
-
number
- sessionId
-
string
- lastMessageId
-
number
Devoluciones
Promise<TaskAgentMessage>
getPackage(string, string, string)
function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>Parámetros
- packageType
-
string
- platform
-
string
- version
-
string
Devoluciones
Promise<PackageMetadata>
getPackages(string, string, number)
function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>Parámetros
- packageType
-
string
- platform
-
string
- top
-
number
Devoluciones
Promise<PackageMetadata[]>
getResourceLimits()
getResourceUsage(string, boolean, boolean)
function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>Parámetros
- parallelismTag
-
string
- poolIsHosted
-
boolean
- includeRunningRequests
-
boolean
Devoluciones
Promise<ResourceUsage>
getSecureFile(string, string, boolean, SecureFileActionFilter)
Obtención de un archivo seguro
function getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileId
-
string
Identificador de archivo seguro único
- includeDownloadTicket
-
boolean
Si includeDownloadTicket es true y el autor de la llamada tiene permisos, se incluye un vale de descarga en la respuesta.
- actionFilter
- SecureFileActionFilter
Devoluciones
Promise<SecureFile>
getSecureFiles(string, string, boolean, SecureFileActionFilter)
Obtención de archivos seguros
function getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- namePattern
-
string
Nombre del archivo seguro que se va a coincidir. Puede incluir caracteres comodín para que coincidan con varios archivos.
- includeDownloadTickets
-
boolean
Si includeDownloadTickets es true y el autor de la llamada tiene permisos, se incluye un vale de descarga para cada archivo seguro en la respuesta.
- actionFilter
- SecureFileActionFilter
Filtre por permisos de archivo seguros para la acción Ver, Administrar o Usar. El valor predeterminado es Ver.
Devoluciones
Promise<SecureFile[]>
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)
Obtención de archivos seguros
function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileIds
-
string[]
Una lista de identificadores de archivo seguros
- includeDownloadTickets
-
boolean
Si includeDownloadTickets es true y el autor de la llamada tiene permisos, se incluye un vale de descarga para cada archivo seguro en la respuesta.
- actionFilter
- SecureFileActionFilter
Devoluciones
Promise<SecureFile[]>
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)
Obtención de archivos seguros
function getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileNames
-
string[]
Una lista de identificadores de archivo seguros
- includeDownloadTickets
-
boolean
Si includeDownloadTickets es true y el autor de la llamada tiene permisos, se incluye un vale de descarga para cada archivo seguro en la respuesta.
- actionFilter
- SecureFileActionFilter
Devoluciones
Promise<SecureFile[]>
getTaskContentZip(string, string, string[], boolean)
function getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<ArrayBuffer>Parámetros
- taskId
-
string
- versionString
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
Devoluciones
Promise<ArrayBuffer>
getTaskDefinition(string, string, string[], boolean)
function getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskDefinition>Parámetros
- taskId
-
string
- versionString
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
Devoluciones
Promise<TaskDefinition>
getTaskDefinitions(string, string[], boolean, boolean)
function getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskDefinition[]>Parámetros
- taskId
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
- allVersions
-
boolean
Devoluciones
Promise<TaskDefinition[]>
getTaskGroup(string, string, string, TaskGroupExpands)
Obtener grupo de tareas.
function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
Identificador del grupo de tareas.
- versionSpec
-
string
especificación de versión del grupo de tareas. ejemplos: 1, 1.0.
- expand
- TaskGroupExpands
Propiedades que se deben expandir. ejemplo $expand=Tareas expandirá los grupos de tareas anidados.
Devoluciones
Promise<TaskGroup>
getTaskGroupHistory(string, string)
function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
Devoluciones
Promise<TaskGroupRevision[]>
getTaskGroupRevision(string, string, number)
function getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
- revision
-
number
Devoluciones
Promise<string>
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)
Enumerar grupos de tareas.
function getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskGroupQueryOrder): Promise<TaskGroup[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
Identificador del grupo de tareas.
- expanded
-
boolean
'true' para expandir de forma recursiva los grupos de tareas. El valor predeterminado es "false".
- taskIdFilter
-
string
Guid del taskId que se va a filtrar.
- deleted
-
boolean
"true" para incluir grupos de tareas eliminados. El valor predeterminado es "false".
- top
-
number
Número de grupos de tareas que se van a obtener.
- continuationToken
-
Date
Obtiene los grupos de tareas después del token de continuación proporcionado.
- queryOrder
- TaskGroupQueryOrder
Obtiene los resultados en el orden definido. El valor predeterminado es "CreatedOnDescending".
Devoluciones
Promise<TaskGroup[]>
getTaskHubLicenseDetails(string, boolean, boolean)
function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>Parámetros
- hubName
-
string
- includeEnterpriseUsersCount
-
boolean
- includeHostedAgentMinutesCount
-
boolean
Devoluciones
Promise<TaskHubLicenseDetails>
getVariableGroup(string, number)
Obtiene un grupo de variables.
function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- groupId
-
number
Identificador del grupo de variables.
Devoluciones
Promise<VariableGroup>
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)
Obtener grupos de variables.
function getVariableGroups(project: string, groupName?: string, actionFilter?: VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: VariableGroupQueryOrder): Promise<VariableGroup[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- groupName
-
string
Nombre del grupo de variables.
- actionFilter
- VariableGroupActionFilter
Filtro de acción para el grupo de variables. Especifica la acción que se puede realizar en los grupos de variables.
- top
-
number
Número de grupos de variables que se van a obtener.
- continuationToken
-
number
Obtiene los grupos de variables después del token de continuación proporcionado.
- queryOrder
- VariableGroupQueryOrder
Obtiene los resultados en el orden definido. El valor predeterminado es "IdDescending".
Devoluciones
Promise<VariableGroup[]>
getVariableGroupsById(string, number[], boolean)
Obtiene grupos de variables por identificadores.
function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- groupIds
-
number[]
Lista separada por comas de identificadores de grupos de variables.
- loadSecrets
-
boolean
Marca que indica si se deben cargar los secretos de los grupos de variables.
Devoluciones
Promise<VariableGroup[]>
getVirtualMachineGroup(string, number, number)
function getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<VirtualMachineGroup>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
Devoluciones
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>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
- continuationToken
-
string
- name
-
string
- partialNameMatch
-
boolean
- tags
-
string[]
- top
-
number
Devoluciones
Promise<PagedList<VirtualMachine>>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Devoluciones
Promise<string>
getYamlSchema(boolean)
OBTENGA el esquema Yaml usado para la validación de archivos Yaml.
function getYamlSchema(validateTaskNames?: boolean): Promise<any>Parámetros
- validateTaskNames
-
boolean
Si el esquema debe validar que las tareas están instaladas realmente (útiles para las herramientas sin conexión en las que no desea la validación).
Devoluciones
Promise<any>
hasPoolPermissions(number, number)
Comprueba si la identidad actual ha pasado permisos en un grupo.
function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>Parámetros
- poolId
-
number
Identificador del grupo que se va a comprobar
- permissions
-
number
Permisos para comprobar. Es posible que varios permisos se combinen en un solo valor mediante el operador OR bit a bit (por ejemplo, AgentPoolPermissions.Manage | AgentPoolPermissions.View)
Devoluciones
Promise<boolean>
publishTaskGroup(PublishTaskGroupMetadata, string, string)
function publishTaskGroup(taskGroupMetadata: PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskGroup[]>Parámetros
- taskGroupMetadata
- PublishTaskGroupMetadata
- project
-
string
Id. de proyecto o nombre del proyecto
- parentTaskGroupId
-
string
Devoluciones
Promise<TaskGroup[]>
queryEndpoint(TaskDefinitionEndpoint)
Proxy para una solicitud GET definida por un "punto de conexión". La solicitud está autorizada mediante una conexión de servicio. La respuesta se filtra mediante un selector basado en XPath/Json.
function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>Parámetros
- endpoint
- TaskDefinitionEndpoint
Describe la dirección URL que se va a capturar.
Devoluciones
Promise<string[]>
querySecureFilesByProperties(string, string, string)
Consulta de archivos seguros mediante un patrón de nombre y una condición en las propiedades del archivo.
function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>Parámetros
- condition
-
string
La sintaxis de condición principal se describe aquí. Use la función property('property-name') para tener acceso al valor de la propiedad especificada de un archivo seguro. Devuelve null si la propiedad no está establecida. Por ejemplo and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )
- project
-
string
Id. de proyecto o nombre del proyecto
- namePattern
-
string
Nombre del archivo seguro que se va a coincidir. Puede incluir caracteres comodín para que coincidan con varios archivos.
Devoluciones
Promise<SecureFile[]>
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>Parámetros
- poolId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceJob>
queueAgentRequest(TaskAgentJobRequest, string, number)
function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>Parámetros
- request
- TaskAgentJobRequest
- project
-
string
Id. de proyecto o nombre del proyecto
- queueId
-
number
Devoluciones
Promise<TaskAgentJobRequest>
queueAgentRequestByPool(TaskAgentJobRequest, number)
function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>Parámetros
- request
- TaskAgentJobRequest
- poolId
-
number
Devoluciones
Promise<TaskAgentJobRequest>
refreshAgent(number, number)
function refreshAgent(poolId: number, agentId: number): Promise<void>Parámetros
- poolId
-
number
- agentId
-
number
Devoluciones
Promise<void>
refreshAgents(number)
function refreshAgents(poolId: number): Promise<void>Parámetros
- poolId
-
number
Devoluciones
Promise<void>
refreshDeploymentMachines(string, number)
function refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Devoluciones
Promise<void>
refreshDeploymentTargets(string, number)
Actualice los destinos de implementación en un grupo de implementación.
function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación.
Devoluciones
Promise<void>
replaceAgent(TaskAgent, number, number)
Reemplace un agente. Probablemente no quiera llamar directamente a este punto de conexión. En su lugar, use el script de configuración del agente para quitar y volver a configurar un agente de la organización.
function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>Parámetros
- agent
- TaskAgent
Detalles actualizados sobre el agente de reemplazo
- poolId
-
number
Grupo de agentes que se va a usar
- agentId
-
number
Agente que se va a reemplazar
Devoluciones
Promise<TaskAgent>
replaceDeploymentMachine(DeploymentMachine, string, number, number)
function replaceDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineId
-
number
Devoluciones
Promise<DeploymentMachine>
replaceDeploymentTarget(DeploymentMachine, string, number, number)
Reemplace un destino de implementación en un grupo de implementación. Por lo general, la herramienta de configuración del agente llama a esto.
function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
Nuevo destino de implementación.
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación en el que se reemplaza el destino de implementación.
- targetId
-
number
Identificador del destino de implementación que se va a reemplazar.
Devoluciones
Promise<DeploymentMachine>
sendMessage(TaskAgentMessage, number, number)
function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>Parámetros
- message
- TaskAgentMessage
- poolId
-
number
- requestId
-
number
Devoluciones
Promise<void>
setAgentPoolMetadata(any, number)
function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>Parámetros
- agentPoolMetadata
-
any
- poolId
-
number
Devoluciones
Promise<void>
shareVariableGroup(VariableGroupProjectReference[], number)
Agregue un grupo de variables.
function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>Parámetros
- variableGroupProjectReferences
- variableGroupId
-
number
Devoluciones
Promise<void>
undeleteTaskGroup(TaskGroup, string)
function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>Parámetros
- taskGroup
- TaskGroup
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TaskGroup[]>
updateAgent(TaskAgent, number, number)
Actualice los detalles del agente.
function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>Parámetros
- agent
- TaskAgent
Detalles actualizados sobre el agente
- poolId
-
number
Grupo de agentes que se va a usar
- agentId
-
number
Agente que se va a actualizar
Devoluciones
Promise<TaskAgent>
updateAgentCloud(TaskAgentCloud, number)
function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>Parámetros
- updatedCloud
- TaskAgentCloud
- agentCloudId
-
number
Devoluciones
Promise<TaskAgentCloud>
updateAgentPool(TaskAgentPool, number)
Actualización de propiedades en un grupo de agentes
function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>Parámetros
- pool
- TaskAgentPool
Detalles actualizados del grupo de agentes
- poolId
-
number
Grupo de agentes que se va a actualizar
Devoluciones
Promise<TaskAgentPool>
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>Parámetros
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
- definitionId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceDefinition>
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>Parámetros
- poolId
-
number
- jobId
-
number
Devoluciones
Promise<TaskAgentPoolMaintenanceJob>
updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)
function updateAgentRequest(request: TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentRequestUpdateOptions): Promise<TaskAgentJobRequest>Parámetros
- request
- TaskAgentJobRequest
- poolId
-
number
- requestId
-
number
- lockToken
-
string
- updateOptions
- TaskAgentRequestUpdateOptions
Devoluciones
Promise<TaskAgentJobRequest>
updateAgentUpdateState(number, number, string)
function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>Parámetros
- poolId
-
number
- agentId
-
number
- currentState
-
string
Devoluciones
Promise<TaskAgent>
updateAgentUserCapabilities({[key: string]: string}, number, number)
function updateAgentUserCapabilities(userCapabilities: {[key: string]: string}, poolId: number, agentId: number): Promise<TaskAgent>Parámetros
- userCapabilities
-
{[key: string]: string}
- poolId
-
number
- agentId
-
number
Devoluciones
Promise<TaskAgent>
updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)
Actualizar un grupo de implementación.
function updateDeploymentGroup(deploymentGroup: DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<DeploymentGroup>Parámetros
- deploymentGroup
- DeploymentGroupUpdateParameter
Grupo de implementación que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación.
Devoluciones
Promise<DeploymentGroup>
updateDeploymentMachine(DeploymentMachine, string, number, number)
function updateDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
- machineId
-
number
Devoluciones
Promise<DeploymentMachine>
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
function updateDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string, machineGroupId: number): Promise<DeploymentMachineGroup>Parámetros
- machineGroup
- DeploymentMachineGroup
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
Devoluciones
Promise<DeploymentMachineGroup>
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>Parámetros
- deploymentMachines
- project
-
string
Id. de proyecto o nombre del proyecto
- machineGroupId
-
number
Devoluciones
Promise<DeploymentMachine[]>
updateDeploymentMachines(DeploymentMachine[], string, number)
function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>Parámetros
- machines
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Devoluciones
Promise<DeploymentMachine[]>
updateDeploymentTarget(DeploymentMachine, string, number, number)
Actualice un destino de implementación y sus propiedades de agente en un grupo de implementación. Por lo general, la herramienta de configuración del agente llama a esto.
function updateDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>Parámetros
- machine
- DeploymentMachine
Destino de implementación que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación en el que se actualiza el destino de implementación.
- targetId
-
number
Identificador del destino de implementación que se va a actualizar.
Devoluciones
Promise<DeploymentMachine>
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)
Actualice las etiquetas de una lista de destinos de implementación en un grupo de implementación.
function updateDeploymentTargets(machines: DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>Parámetros
- machines
Destinos de implementación con etiquetas en udpdate.
- project
-
string
Id. de proyecto o nombre del proyecto
- deploymentGroupId
-
number
Identificador del grupo de implementación en el que se actualizan los destinos de implementación.
Devoluciones
Promise<DeploymentMachine[]>
updateEnvironment(EnvironmentUpdateParameter, string, number)
Actualice el entorno especificado.
function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>Parámetros
- environmentUpdateParameter
- EnvironmentUpdateParameter
Datos de entorno que se van a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Identificador del entorno.
Devoluciones
Promise<EnvironmentInstance>
updateSecureFile(SecureFile, string, string)
Actualizar el nombre o las propiedades de un archivo seguro existente
function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>Parámetros
- secureFile
- SecureFile
El archivo seguro con el nombre o las propiedades actualizados
- project
-
string
Id. de proyecto o nombre del proyecto
- secureFileId
-
string
Identificador de archivo seguro único
Devoluciones
Promise<SecureFile>
updateSecureFiles(SecureFile[], string)
Actualice las propiedades o los nombres de un conjunto de archivos seguros. Los archivos se identifican mediante sus identificadores. Las propiedades proporcionadas invalidan la existente por completo, es decir, no se combinan.
function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>Parámetros
- secureFiles
Lista de objetos de archivo seguros. Solo se deben rellenar tres campos Id, Name y Properties. El resto de campos del objeto se omiten.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<SecureFile[]>
updateTaskGroup(TaskGroupUpdateParameter, string, string)
Actualizar un grupo de tareas.
function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>Parámetros
- taskGroup
- TaskGroupUpdateParameter
Grupo de tareas que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
Identificador del grupo de tareas que se va a actualizar.
Devoluciones
Promise<TaskGroup>
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
function updateTaskGroupProperties(taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskGroup[]>Parámetros
- taskGroupUpdateProperties
- TaskGroupUpdatePropertiesBase
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
- disablePriorVersions
-
boolean
Devoluciones
Promise<TaskGroup[]>
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>Parámetros
- taskHubLicenseDetails
- TaskHubLicenseDetails
- hubName
-
string
Devoluciones
Promise<TaskHubLicenseDetails>
updateVariableGroup(VariableGroupParameters, number)
Actualizar un grupo de variables.
function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>Parámetros
- variableGroupParameters
- VariableGroupParameters
- groupId
-
number
Identificador del grupo de variables que se va a actualizar.
Devoluciones
Promise<VariableGroup>
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
function updateVirtualMachineGroup(resource: VirtualMachineGroup, project: string, environmentId: number): Promise<VirtualMachineGroup>Parámetros
- resource
- VirtualMachineGroup
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
Devoluciones
Promise<VirtualMachineGroup>
updateVirtualMachines(VirtualMachine[], string, number, number)
function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>Parámetros
- machines
- project
-
string
Id. de proyecto o nombre del proyecto
- environmentId
-
number
- resourceId
-
number
Devoluciones
Promise<VirtualMachine[]>
uploadSecureFile(any, string, string, boolean)
Cargar un archivo seguro, incluir el flujo de archivos en el cuerpo de la solicitud
function uploadSecureFile(content: any, project: string, name: string, authorizePipelines?: boolean): Promise<SecureFile>Parámetros
- content
-
any
Contenido que se va a cargar
- project
-
string
Id. de proyecto o nombre del proyecto
- name
-
string
Nombre del archivo que se va a cargar
- authorizePipelines
-
boolean
Si authorizePipelines es true, el archivo seguro está autorizado para su uso por todas las canalizaciones del proyecto.
Devoluciones
Promise<SecureFile>
validateInputs(InputValidationRequest)
function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>Parámetros
- inputValidationRequest
- InputValidationRequest
Devoluciones
Promise<InputValidationRequest>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de