TaskAgentRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
Task |
Свойства
RESOURCE_AREA_ID |
Методы
Сведения о конструкторе
TaskAgentRestClient(IVssRestClientOptions)
Сведения о свойстве
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Значение свойства
string
Сведения о методе
addAgent(TaskAgent, number)
Добавляет агент в пул. Вероятно, вы не хотите вызывать эту конечную точку напрямую. Вместо этого настройте агент с помощью пакета для скачивания агента.
function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>
Параметры
- agent
- TaskAgent
Сведения о добавляемом агенте
- poolId
-
number
Пул агентов, в который добавляется агент.
Возвращаемое значение
Promise<TaskAgent>
addAgentCloud(TaskAgentCloud)
function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>
Параметры
- agentCloud
- TaskAgentCloud
Возвращаемое значение
Promise<TaskAgentCloud>
addAgentPool(TaskAgentPool)
Create пула агентов.
function addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>
Параметры
- pool
- TaskAgentPool
Сведения о новом пуле агентов
Возвращаемое значение
Promise<TaskAgentPool>
addAgentQueue(TaskAgentQueue, string, boolean)
Create новую очередь агента для подключения проекта к пулу агентов.
function addAgentQueue(queue: TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentQueue>
Параметры
- queue
- TaskAgentQueue
Сведения о создаваемой очереди
- project
-
string
Идентификатор или имя проекта
- authorizePipelines
-
boolean
Автоматическая авторизация этой очереди при использовании YAML
Возвращаемое значение
Promise<TaskAgentQueue>
addDeploymentGroup(DeploymentGroupCreateParameter, string)
Create группы развертывания.
function addDeploymentGroup(deploymentGroup: DeploymentGroupCreateParameter, project: string): Promise<DeploymentGroup>
Параметры
- deploymentGroup
- DeploymentGroupCreateParameter
Создаемая группа развертывания.
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<DeploymentGroup>
addDeploymentMachine(DeploymentMachine, string, number)
function addDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Возвращаемое значение
Promise<DeploymentMachine>
addDeploymentMachineGroup(DeploymentMachineGroup, string)
function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>
Параметры
- machineGroup
- DeploymentMachineGroup
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<DeploymentMachineGroup>
addDeploymentTarget(DeploymentMachine, string, number)
Зарегистрируйте целевой объект развертывания в группе развертывания. Обычно это вызывается средством настройки агента.
function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
Целевой объект развертывания для регистрации.
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой зарегистрирован целевой объект развертывания.
Возвращаемое значение
Promise<DeploymentMachine>
addEnvironment(EnvironmentCreateParameter, string)
Create среды.
function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>
Параметры
- environmentCreateParameter
- EnvironmentCreateParameter
Создаваемая среда.
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<EnvironmentInstance>
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
function addKubernetesResource(createParameters: KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<KubernetesResource>
Параметры
- createParameters
- KubernetesResourceCreateParameters
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Возвращаемое значение
Promise<KubernetesResource>
addTaskGroup(TaskGroupCreateParameter, string)
Create группы задач.
function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>
Параметры
- taskGroup
- TaskGroupCreateParameter
Создаваемый объект группы задач.
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<TaskGroup>
addVariableGroup(VariableGroupParameters)
Добавьте группу переменных.
function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>
Параметры
- variableGroupParameters
- VariableGroupParameters
Возвращаемое значение
Promise<VariableGroup>
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
function addVirtualMachineGroup(createParameters: VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<VirtualMachineGroup>
Параметры
- createParameters
- VirtualMachineGroupCreateParameters
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Возвращаемое значение
Promise<VirtualMachineGroup>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>
Параметры
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Возвращаемое значение
Promise<string>
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>
Параметры
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceDefinition>
createAgentSession(TaskAgentSession, number)
function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>
Параметры
- session
- TaskAgentSession
- poolId
-
number
Возвращаемое значение
Promise<TaskAgentSession>
createTeamProject(string)
Create новый командный проект.
function createTeamProject(project?: string): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<void>
deleteAgent(number, number)
Удаление агента. Вероятно, вы не хотите вызывать эту конечную точку напрямую. Вместо этого используйте скрипт конфигурации агента , чтобы удалить агент из организации.
function deleteAgent(poolId: number, agentId: number): Promise<void>
Параметры
- poolId
-
number
Идентификатор пула для удаления агента
- agentId
-
number
Идентификатор агента для удаления
Возвращаемое значение
Promise<void>
deleteAgentCloud(number)
function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>
Параметры
- agentCloudId
-
number
Возвращаемое значение
Promise<TaskAgentCloud>
deleteAgentPool(number)
Удаление пула агентов.
function deleteAgentPool(poolId: number): Promise<void>
Параметры
- poolId
-
number
Идентификатор удаляемого пула агентов
Возвращаемое значение
Promise<void>
deleteAgentPoolMaintenanceDefinition(number, number)
function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>
Параметры
- poolId
-
number
- definitionId
-
number
Возвращаемое значение
Promise<void>
deleteAgentPoolMaintenanceJob(number, number)
function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>
Параметры
- poolId
-
number
- jobId
-
number
Возвращаемое значение
Promise<void>
deleteAgentQueue(number, string)
Удаляет очередь агента из проекта.
function deleteAgentQueue(queueId: number, project?: string): Promise<void>
Параметры
- queueId
-
number
Удаляемая очередь агента
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<void>
deleteAgentRequest(number, number, string, TaskResult, boolean)
function deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskResult, agentShuttingDown?: boolean): Promise<void>
Параметры
- poolId
-
number
- requestId
-
number
- lockToken
-
string
- result
- TaskResult
- agentShuttingDown
-
boolean
Возвращаемое значение
Promise<void>
deleteAgentSession(number, string)
function deleteAgentSession(poolId: number, sessionId: string): Promise<void>
Параметры
- poolId
-
number
- sessionId
-
string
Возвращаемое значение
Promise<void>
deleteDeploymentGroup(string, number)
Удаление группы развертывания.
function deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор удаляемой группы развертывания.
Возвращаемое значение
Promise<void>
deleteDeploymentMachine(string, number, number)
function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
- machineId
-
number
Возвращаемое значение
Promise<void>
deleteDeploymentMachineGroup(string, number)
function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- machineGroupId
-
number
Возвращаемое значение
Promise<void>
deleteDeploymentTarget(string, number, number)
Удаление целевого объекта развертывания в группе развертывания. При этом агент также удаляется из связанного пула развертывания.
function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой удаляется целевой объект развертывания.
- targetId
-
number
Идентификатор удаляемого целевого объекта развертывания.
Возвращаемое значение
Promise<void>
deleteEnvironment(string, number)
Удалите указанную среду.
function deleteEnvironment(project: string, environmentId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Идентификатор среды.
Возвращаемое значение
Promise<void>
deleteKubernetesResource(string, number, number)
function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
- resourceId
-
number
Возвращаемое значение
Promise<void>
deleteMessage(number, number, string)
function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>
Параметры
- poolId
-
number
- messageId
-
number
- sessionId
-
string
Возвращаемое значение
Promise<void>
deleteSecureFile(string, string)
Удаление защищенного файла
function deleteSecureFile(project: string, secureFileId: string): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- secureFileId
-
string
Уникальный идентификатор защищенного файла
Возвращаемое значение
Promise<void>
deleteTaskDefinition(string)
function deleteTaskDefinition(taskId: string): Promise<void>
Параметры
- taskId
-
string
Возвращаемое значение
Promise<void>
deleteTaskGroup(string, string, string)
Удаление группы задач.
function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- taskGroupId
-
string
Идентификатор удаляемой группы задач.
- comment
-
string
Комментарии для удаления.
Возвращаемое значение
Promise<void>
deleteVariableGroup(number, string[])
Удаление группы переменных
function deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>
Параметры
- groupId
-
number
Идентификатор группы переменных.
- projectIds
-
string[]
Возвращаемое значение
Promise<void>
deleteVirtualMachineGroup(string, number, number)
function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
- resourceId
-
number
Возвращаемое значение
Promise<void>
downloadSecureFile(string, string, string, boolean)
Скачивание защищенного файла по идентификатору
function downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<ArrayBuffer>
Параметры
- project
-
string
Идентификатор или имя проекта
- secureFileId
-
string
Уникальный идентификатор защищенного файла
- ticket
-
string
Действительный билет на скачивание
- download
-
boolean
Если загрузка имеет значение true, файл отправляется как вложение в тексте ответа. Если для скачивания задано значение false, текст ответа содержит файловый поток.
Возвращаемое значение
Promise<ArrayBuffer>
generateDeploymentGroupAccessToken(string, number)
ПОЛУЧЕНИЕ маркера PAT для управления целевыми объектами развертывания (настройка, удаление, добавление тегов) в группе развертывания.
function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой управляются целевые объекты развертывания.
Возвращаемое значение
Promise<string>
generateDeploymentMachineGroupAccessToken(string, number)
function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>
Параметры
- project
-
string
Идентификатор или имя проекта
- machineGroupId
-
number
Возвращаемое значение
Promise<string>
generateDeploymentPoolAccessToken(number)
ПОЛУЧЕНИЕ маркера PAT для управления (настройки, удаления, добавления тегов) агентов развертывания в пуле развертывания.
function generateDeploymentPoolAccessToken(poolId: number): Promise<string>
Параметры
- poolId
-
number
Идентификатор пула развертывания, в котором управляются агенты развертывания.
Возвращаемое значение
Promise<string>
getAgent(number, number, boolean, boolean, boolean, string[])
Получение сведений об агенте.
function getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgent>
Параметры
- poolId
-
number
Пул агентов, содержащий агент
- agentId
-
number
Идентификатор агента для получения сведений
- includeCapabilities
-
boolean
Включение возможностей агента в ответ
- includeAssignedRequest
-
boolean
Необходимость включения сведений о текущей работе агента
- includeLastCompletedRequest
-
boolean
Следует ли включать сведения о последней завершенной работе агентов
- propertyFilters
-
string[]
Фильтрация возвращаемых пользовательских свойств
Возвращаемое значение
Promise<TaskAgent>
getAgentCloud(number)
function getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>
Параметры
- agentCloudId
-
number
Возвращаемое значение
Promise<TaskAgentCloud>
getAgentCloudRequests(number)
function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>
Параметры
- agentCloudId
-
number
Возвращаемое значение
Promise<TaskAgentCloudRequest[]>
getAgentClouds()
function getAgentClouds(): Promise<TaskAgentCloud[]>
Возвращаемое значение
Promise<TaskAgentCloud[]>
getAgentCloudTypes()
Получение типов облака агента.
function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>
Возвращаемое значение
Promise<TaskAgentCloudType[]>
getAgentPool(number, string[], TaskAgentPoolActionFilter)
Получение сведений о пуле агентов.
function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>
Параметры
- poolId
-
number
Идентификатор пула агентов
- properties
-
string[]
Свойства пула агентов (разделенные запятыми)
- actionFilter
- TaskAgentPoolActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentPool>
getAgentPoolMaintenanceDefinition(number, number)
function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>
Параметры
- poolId
-
number
- definitionId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceDefinition>
getAgentPoolMaintenanceDefinitions(number)
function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>
Параметры
- poolId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceDefinition[]>
getAgentPoolMaintenanceJob(number, number)
function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>
Параметры
- poolId
-
number
- jobId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceJob>
getAgentPoolMaintenanceJobLogs(number, number)
function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>
Параметры
- poolId
-
number
- jobId
-
number
Возвращаемое значение
Promise<ArrayBuffer>
getAgentPoolMaintenanceJobs(number, number)
function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>
Параметры
- poolId
-
number
- definitionId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceJob[]>
getAgentPoolMetadata(number)
function getAgentPoolMetadata(poolId: number): Promise<string>
Параметры
- poolId
-
number
Возвращаемое значение
Promise<string>
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)
Получение списка пулов агентов.
function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>
Параметры
- poolName
-
string
Фильтровать по имени
- properties
-
string[]
Фильтрация по свойствам пула агентов (разделенные запятыми)
- poolType
- TaskAgentPoolType
Фильтрация по типу пула
- actionFilter
- TaskAgentPoolActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentPool[]>
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)
Получение списка пулов агентов.
function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>
Параметры
- poolIds
-
number[]
идентификаторы пула для получения
- actionFilter
- TaskAgentPoolActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentPool[]>
getAgentQueue(number, string, TaskAgentQueueActionFilter)
Получение сведений об очереди агента.
function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>
Параметры
- queueId
-
number
Очередь агента для получения сведений
- project
-
string
Идентификатор или имя проекта
- actionFilter
- TaskAgentQueueActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentQueue>
getAgentQueues(string, string, TaskAgentQueueActionFilter)
Получение списка очередей агентов.
function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- queueName
-
string
Фильтрация по имени очереди агента
- actionFilter
- TaskAgentQueueActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentQueue[]>
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)
Получение списка очередей агентов по их идентификаторам
function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Параметры
- queueIds
-
number[]
Разделенный запятыми список идентификаторов очередей агентов для извлечения
- project
-
string
Идентификатор или имя проекта
- actionFilter
- TaskAgentQueueActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentQueue[]>
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)
Получение списка очередей агентов по их именам
function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Параметры
- queueNames
-
string[]
Список имен агентов, которые нужно получить с разделителями-запятыми
- project
-
string
Идентификатор или имя проекта
- actionFilter
- TaskAgentQueueActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentQueue[]>
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)
Получение списка очередей агентов по идентификаторам пулов
function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>
Параметры
- poolIds
-
number[]
Разделенный запятыми список идентификаторов пулов для получения соответствующих очередей
- project
-
string
Идентификатор или имя проекта
- actionFilter
- TaskAgentQueueActionFilter
Фильтрация по тому, использует ли вызывающий пользователь разрешения на использование разрешений или управление ими
Возвращаемое значение
Promise<TaskAgentQueue[]>
getAgentRequest(number, number, boolean)
function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>
Параметры
- poolId
-
number
- requestId
-
number
- includeStatus
-
boolean
Возвращаемое значение
Promise<TaskAgentJobRequest>
getAgentRequests(number, number, string)
function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>
Параметры
- poolId
-
number
- top
-
number
- continuationToken
-
string
Возвращаемое значение
Promise<PagedList<TaskAgentJobRequest>>
getAgentRequestsForAgent(number, number, number)
function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- poolId
-
number
- agentId
-
number
- completedRequestCount
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForAgents(number, number[], number)
function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- poolId
-
number
- agentIds
-
number[]
- completedRequestCount
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentMachine(string, number, number, number)
function getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
- machineId
-
number
- completedRequestCount
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentMachines(string, number, number[], number)
function getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
- machineIds
-
number[]
- completedRequestCount
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTarget(string, number, number, number)
Получение запросов агента для целевого объекта развертывания.
function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, к которой принадлежит целевой объект.
- targetId
-
number
Идентификатор целевого объекта развертывания.
- completedRequestCount
-
number
Максимальное количество выполненных запросов для возврата. Значение по умолчанию — 50.
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)
Получение запросов агента для целевых объектов развертывания списка.
function getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, к которой принадлежат целевые объекты.
- targetIds
-
number[]
Разделенный запятыми список идентификаторов целевых объектов развертывания.
- ownerId
-
number
Идентификатор владельца запроса задания агента.
- completedOn
-
Date
Дата и время возврата запроса по истечении этого времени.
- completedRequestCount
-
number
Максимальное количество завершенных запросов, возвращаемых для каждого целевого объекта. Значение по умолчанию — 50.
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForPlan(number, string, string)
function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>
Параметры
- poolId
-
number
- planId
-
string
- jobId
-
string
Возвращаемое значение
Promise<TaskAgentJobRequest[]>
getAgentRequestsForQueue(string, number, number, string)
function getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>
Параметры
- project
-
string
Идентификатор или имя проекта
- queueId
-
number
- top
-
number
- continuationToken
-
string
Возвращаемое значение
Promise<PagedList<TaskAgentJobRequest>>
getAgents(number, string, boolean, boolean, boolean, string[], string[])
Получение списка агентов.
function getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgent[]>
Параметры
- poolId
-
number
Пул агентов, содержащий агенты
- agentName
-
string
Фильтрация по имени агента
- includeCapabilities
-
boolean
Включение возможностей агентов в ответ
- includeAssignedRequest
-
boolean
Необходимость включения сведений о текущей работе агентов
- includeLastCompletedRequest
-
boolean
Следует ли включать сведения о последней завершенной работе агентов
- propertyFilters
-
string[]
Фильтрация возвращаемых пользовательских свойств
- demands
-
string[]
Фильтрация по требованиям, которым могут удовлетворять агенты
Возвращаемое значение
Promise<TaskAgent[]>
getAzureManagementGroups()
Возвращает список подписок Azure.
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>
Возвращаемое значение
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Возвращает список подписок Azure.
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>
Возвращаемое значение
Promise<AzureSubscriptionQueryResult>
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)
Получение группы развертывания по ее идентификатору.
function getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands): Promise<DeploymentGroup>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания.
- actionFilter
- DeploymentGroupActionFilter
Получите группу развертывания только в том случае, если с ней можно выполнить это действие.
- expand
- DeploymentGroupExpands
Включите эти дополнительные сведения в возвращаемый объект .
Возвращаемое значение
Promise<DeploymentGroup>
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])
Получение списка групп развертывания по имени или идентификаторам.
function getDeploymentGroups(project: string, name?: string, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<PagedList<DeploymentGroup>>
Параметры
- project
-
string
Идентификатор или имя проекта
- name
-
string
Имя группы развертывания.
- actionFilter
- DeploymentGroupActionFilter
Получение только групп развертывания, в которых можно выполнить это действие.
- expand
- DeploymentGroupExpands
Включите эти дополнительные сведения в возвращаемые объекты.
- continuationToken
-
string
Получите группы развертывания с именами, превышающими этот параметр continuationToken лексикографически.
- top
-
number
Максимальное количество возвращаемых групп развертывания. Значение по умолчанию — 1000.
- ids
-
number[]
Разделенный запятыми список идентификаторов групп развертывания.
Возвращаемое значение
Promise<PagedList<DeploymentGroup>>
getDeploymentGroupsMetrics(string, string, string, number)
Получение списка метрик группы развертывания.
function getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<PagedList<DeploymentGroupMetrics>>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupName
-
string
Имя группы развертывания.
- continuationToken
-
string
Получите метрики для групп развертывания с именами, превышающими этот параметр continuationToken лексикографически.
- top
-
number
Максимальное количество возвращаемых метрик группы развертывания. Значение по умолчанию — 50.
Возвращаемое значение
Promise<PagedList<DeploymentGroupMetrics>>
getDeploymentMachine(string, number, number, DeploymentMachineExpands)
function getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: DeploymentMachineExpands): Promise<DeploymentMachine>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
- machineId
-
number
- expand
- DeploymentMachineExpands
Возвращаемое значение
Promise<DeploymentMachine>
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
function getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup>
Параметры
- project
-
string
Идентификатор или имя проекта
- machineGroupId
-
number
- actionFilter
- MachineGroupActionFilter
Возвращаемое значение
Promise<DeploymentMachineGroup>
getDeploymentMachineGroupMachines(string, number, string[])
function getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<DeploymentMachine[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- machineGroupId
-
number
- tagFilters
-
string[]
Возвращаемое значение
Promise<DeploymentMachine[]>
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
function getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- machineGroupName
-
string
- actionFilter
- MachineGroupActionFilter
Возвращаемое значение
Promise<DeploymentMachineGroup[]>
getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)
function getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: DeploymentMachineExpands): Promise<DeploymentMachine[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
- tags
-
string[]
- name
-
string
- expand
- DeploymentMachineExpands
Возвращаемое значение
Promise<DeploymentMachine[]>
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])
Получение списка сводок по пулу развертывания.
function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>
Параметры
- poolName
-
string
Имя пула развертывания.
- expands
- DeploymentPoolSummaryExpands
Включите эти дополнительные сведения в возвращаемые объекты.
- poolIds
-
number[]
Список идентификаторов пулов развертывания.
Возвращаемое значение
Promise<DeploymentPoolSummary[]>
getDeploymentTarget(string, number, number, DeploymentTargetExpands)
Получение целевого объекта развертывания по его идентификатору в группе развертывания
function getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: DeploymentTargetExpands): Promise<DeploymentMachine>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, к которой принадлежит целевой объект развертывания.
- targetId
-
number
Идентификатор возвращаемого целевого объекта развертывания.
- expand
- DeploymentTargetExpands
Включите эти дополнительные сведения в возвращаемые объекты.
Возвращаемое значение
Promise<DeploymentMachine>
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])
Получение списка целевых объектов развертывания в группе развертывания.
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>>
Параметры
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания.
- tags
-
string[]
Получение только целевых объектов развертывания, содержащих все эти разделенные запятыми список тегов.
- name
-
string
Шаблон имени возвращаемых целевых объектов развертывания.
- partialNameMatch
-
boolean
Если задано значение true, имя обрабатывается как шаблон. В противном случае обрабатывается как абсолютное соответствие. Значение по умолчанию — false.
- expand
- DeploymentTargetExpands
Включите эти дополнительные сведения в возвращаемые объекты.
- agentStatus
- TaskAgentStatusFilter
Получение только целевых объектов развертывания с таким состоянием.
- agentJobResult
- TaskAgentJobResultFilter
Получение только целевых объектов развертывания, которые имеют этот результат последнего задания.
- continuationToken
-
string
Получение целевых объектов развертывания с именами, превышающими этот параметр continuationToken лексикографически.
- top
-
number
Максимальное число возвращаемых целевых объектов развертывания. Значение по умолчанию — 1000.
- enabled
-
boolean
Получение только включенных или отключенных целевых объектов развертывания. Значение по умолчанию — null, которое возвращает все целевые объекты.
- propertyFilters
-
string[]
Возвращаемое значение
Promise<PagedList<DeploymentMachine>>
getEnvironmentById(string, number, EnvironmentExpands)
Получение среды по ее идентификатору.
function getEnvironmentById(project: string, environmentId: number, expands?: EnvironmentExpands): Promise<EnvironmentInstance>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Идентификатор среды.
- expands
- EnvironmentExpands
Включите эти дополнительные сведения в возвращаемые объекты.
Возвращаемое значение
Promise<EnvironmentInstance>
getEnvironmentDeploymentExecutionRecords(string, number, string, number)
Получение журнала выполнения развертывания среды
function getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
- continuationToken
-
string
- top
-
number
Возвращаемое значение
getEnvironments(string, string, string, number)
Получение всех сред.
function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>
Параметры
- project
-
string
Идентификатор или имя проекта
- name
-
string
- continuationToken
-
string
- top
-
number
Возвращаемое значение
Promise<PagedList<EnvironmentInstance>>
getKubernetesResource(string, number, number)
function getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<KubernetesResource>
Параметры
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
- resourceId
-
number
Возвращаемое значение
Promise<KubernetesResource>
getMessage(number, string, number)
function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>
Параметры
- poolId
-
number
- sessionId
-
string
- lastMessageId
-
number
Возвращаемое значение
Promise<TaskAgentMessage>
getPackage(string, string, string)
function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>
Параметры
- packageType
-
string
- platform
-
string
- version
-
string
Возвращаемое значение
Promise<PackageMetadata>
getPackages(string, string, number)
function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>
Параметры
- packageType
-
string
- platform
-
string
- top
-
number
Возвращаемое значение
Promise<PackageMetadata[]>
getResourceLimits()
function getResourceLimits(): Promise<ResourceLimit[]>
Возвращаемое значение
Promise<ResourceLimit[]>
getResourceUsage(string, boolean, boolean)
function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>
Параметры
- parallelismTag
-
string
- poolIsHosted
-
boolean
- includeRunningRequests
-
boolean
Возвращаемое значение
Promise<ResourceUsage>
getSecureFile(string, string, boolean, SecureFileActionFilter)
Получение защищенного файла
function getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile>
Параметры
- project
-
string
Идентификатор или имя проекта
- secureFileId
-
string
Уникальный идентификатор защищенного файла
- includeDownloadTicket
-
boolean
Если параметру includeDownloadTicket присвоено значение true и у вызывающей стороны есть разрешения, в ответ включается запрос на скачивание.
- actionFilter
- SecureFileActionFilter
Возвращаемое значение
Promise<SecureFile>
getSecureFiles(string, string, boolean, SecureFileActionFilter)
Получение защищенных файлов
function getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- namePattern
-
string
Имя безопасного файла для сопоставления. Может включать подстановочные знаки для сопоставления нескольких файлов.
- includeDownloadTickets
-
boolean
Если параметру includeDownloadTickets присвоено значение true и у вызывающего объекта есть разрешения, в ответ включается запрос на скачивание для каждого защищенного файла.
- actionFilter
- SecureFileActionFilter
Фильтрация по разрешениям безопасного файла для действия Просмотр, Управление или Использование. Значение по умолчанию — Просмотр.
Возвращаемое значение
Promise<SecureFile[]>
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)
Получение защищенных файлов
function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- secureFileIds
-
string[]
Список идентификаторов защищенных файлов
- includeDownloadTickets
-
boolean
Если параметру includeDownloadTickets присвоено значение true и у вызывающего объекта есть разрешения, в ответ включается запрос на скачивание для каждого защищенного файла.
- actionFilter
- SecureFileActionFilter
Возвращаемое значение
Promise<SecureFile[]>
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)
Получение защищенных файлов
function getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>
Параметры
- project
-
string
Идентификатор или имя проекта
- secureFileNames
-
string[]
Список идентификаторов защищенных файлов
- includeDownloadTickets
-
boolean
Если параметру includeDownloadTickets присвоено значение true и у вызывающего объекта есть разрешения, в ответ включается запрос на скачивание для каждого защищенного файла.
- actionFilter
- SecureFileActionFilter
Возвращаемое значение
Promise<SecureFile[]>
getTaskContentZip(string, string, string[], boolean)
function getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<ArrayBuffer>
Параметры
- taskId
-
string
- versionString
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
Возвращаемое значение
Promise<ArrayBuffer>
getTaskDefinition(string, string, string[], boolean)
function getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskDefinition>
Параметры
- taskId
-
string
- versionString
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
Возвращаемое значение
Promise<TaskDefinition>
getTaskDefinitions(string, string[], boolean, boolean)
function getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskDefinition[]>
Параметры
- taskId
-
string
- visibility
-
string[]
- scopeLocal
-
boolean
- allVersions
-
boolean
Возвращаемое значение
Promise<TaskDefinition[]>
getTaskGroup(string, string, string, TaskGroupExpands)
Получение группы задач.
function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- taskGroupId
-
string
Идентификатор группы задач.
- versionSpec
-
string
спецификация версии группы задач. примеры: 1, 1.0.
- expand
- TaskGroupExpands
Свойства, которые следует развернуть. пример $expand=Tasks развернет вложенные группы задач.
Возвращаемое значение
Promise<TaskGroup>
getTaskGroupHistory(string, string)
function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- taskGroupId
-
string
Возвращаемое значение
Promise<TaskGroupRevision[]>
getTaskGroupRevision(string, string, number)
function getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<string>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- taskGroupId
-
string
- revision
-
number
Возвращаемое значение
Promise<string>
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)
Вывод списка групп задач.
function getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskGroupQueryOrder): Promise<TaskGroup[]>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- taskGroupId
-
string
Идентификатор группы задач.
- expanded
-
boolean
"true", чтобы рекурсивно развернуть группы задач. Значение по умолчанию — false.
- taskIdFilter
-
string
Guid объекта taskId для фильтрации.
- deleted
-
boolean
"true", чтобы включить удаленные группы задач. Значение по умолчанию — false.
- top
-
number
Количество групп задач для получения.
- continuationToken
-
Date
Возвращает группы задач после предоставленного маркера продолжения.
- queryOrder
- TaskGroupQueryOrder
Возвращает результаты в определенном порядке. Значение по умолчанию — CreatedOnDescending.
Возвращаемое значение
Promise<TaskGroup[]>
getTaskHubLicenseDetails(string, boolean, boolean)
function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>
Параметры
- hubName
-
string
- includeEnterpriseUsersCount
-
boolean
- includeHostedAgentMinutesCount
-
boolean
Возвращаемое значение
Promise<TaskHubLicenseDetails>
getVariableGroup(string, number)
Получение группы переменных.
function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- groupId
-
number
Идентификатор группы переменных.
Возвращаемое значение
Promise<VariableGroup>
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)
Получение групп переменных.
function getVariableGroups(project: string, groupName?: string, actionFilter?: VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: VariableGroupQueryOrder): Promise<VariableGroup[]>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- groupName
-
string
Имя группы переменных.
- actionFilter
- VariableGroupActionFilter
Фильтр действий для группы переменных. Он указывает действие, которое может быть выполнено с группами переменных.
- top
-
number
Количество групп переменных для получения.
- continuationToken
-
number
Возвращает группы переменных после предоставленного маркера продолжения.
- queryOrder
- VariableGroupQueryOrder
Возвращает результаты в определенном порядке. Значение по умолчанию — IdDescending.
Возвращаемое значение
Promise<VariableGroup[]>
getVariableGroupsById(string, number[], boolean)
Получение групп переменных по идентификаторам.
function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- groupIds
-
number[]
Разделенный запятыми список идентификаторов групп переменных.
- loadSecrets
-
boolean
Флаг, указывающий, следует ли загружать секреты в группах переменных.
Возвращаемое значение
Promise<VariableGroup[]>
getVirtualMachineGroup(string, number, number)
function getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<VirtualMachineGroup>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- environmentId
-
number
- resourceId
-
number
Возвращаемое значение
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>>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- environmentId
-
number
- resourceId
-
number
- continuationToken
-
string
- name
-
string
- partialNameMatch
-
boolean
- tags
-
string[]
- top
-
number
Возвращаемое значение
Promise<PagedList<VirtualMachine>>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>
Возвращаемое значение
Promise<string>
getYamlSchema(boolean)
ПОЛУЧЕНИЕ схемы Yaml, используемой для проверки файла Yaml.
function getYamlSchema(validateTaskNames?: boolean): Promise<any>
Параметры
- validateTaskNames
-
boolean
Указывает, должна ли схема проверять, действительно ли установлены задачи (полезно для автономных средств, когда проверка не требуется).
Возвращаемое значение
Promise<any>
hasPoolPermissions(number, number)
Проверяет, прошло ли текущее удостоверение разрешения для пула.
function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>
Параметры
- poolId
-
number
Идентификатор пула для проверка
- permissions
-
number
Разрешения на проверка. Несколько разрешений могут быть объединены в одно значение с помощью побитового оператора OR (например, AgentPoolPermissions.Manage | AgentPoolPermissions.View)
Возвращаемое значение
Promise<boolean>
publishTaskGroup(PublishTaskGroupMetadata, string, string)
function publishTaskGroup(taskGroupMetadata: PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskGroup[]>
Параметры
- taskGroupMetadata
- PublishTaskGroupMetadata
- project
-
string
Идентификатор проекта или имя проекта
- parentTaskGroupId
-
string
Возвращаемое значение
Promise<TaskGroup[]>
queryEndpoint(TaskDefinitionEndpoint)
Прокси-сервер для запроса GET, определенного "конечной точкой". Запрос авторизован с помощью подключения к службе. Ответ фильтруется с помощью селектора на основе XPath/Json.
function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>
Параметры
- endpoint
- TaskDefinitionEndpoint
Описывает URL-адрес для получения.
Возвращаемое значение
Promise<string[]>
querySecureFilesByProperties(string, string, string)
Запросите безопасные файлы с помощью шаблона имени и условия для свойств файла.
function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>
Параметры
- condition
-
string
Синтаксис условия main описан здесь. Используйте функцию property('property-name') для доступа к значению указанного свойства защищенного файла. Если свойство не задано, возвращается значение NULL. Например, and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )
- project
-
string
Идентификатор проекта или имя проекта
- namePattern
-
string
Имя безопасного файла для сопоставления. Может включать подстановочные знаки для сопоставления с несколькими файлами.
Возвращаемое значение
Promise<SecureFile[]>
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>
Параметры
- poolId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceJob>
queueAgentRequest(TaskAgentJobRequest, string, number)
function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>
Параметры
- request
- TaskAgentJobRequest
- project
-
string
Идентификатор проекта или имя проекта
- queueId
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest>
queueAgentRequestByPool(TaskAgentJobRequest, number)
function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>
Параметры
- request
- TaskAgentJobRequest
- poolId
-
number
Возвращаемое значение
Promise<TaskAgentJobRequest>
refreshAgent(number, number)
function refreshAgent(poolId: number, agentId: number): Promise<void>
Параметры
- poolId
-
number
- agentId
-
number
Возвращаемое значение
Promise<void>
refreshAgents(number)
function refreshAgents(poolId: number): Promise<void>
Параметры
- poolId
-
number
Возвращаемое значение
Promise<void>
refreshDeploymentMachines(string, number)
function refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Возвращаемое значение
Promise<void>
refreshDeploymentTargets(string, number)
Обновите целевые объекты развертывания в группе развертывания.
function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>
Параметры
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания.
Возвращаемое значение
Promise<void>
replaceAgent(TaskAgent, number, number)
Замена агента. Вероятно, вы не хотите вызывать эту конечную точку напрямую. Вместо этого используйте скрипт конфигурации агента , чтобы удалить и перенастроить агент из организации.
function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>
Параметры
- agent
- TaskAgent
Обновлены сведения о заменяемом агенте
- poolId
-
number
Используемый пул агентов
- agentId
-
number
Агент для замены
Возвращаемое значение
Promise<TaskAgent>
replaceDeploymentMachine(DeploymentMachine, string, number, number)
function replaceDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
- machineId
-
number
Возвращаемое значение
Promise<DeploymentMachine>
replaceDeploymentTarget(DeploymentMachine, string, number, number)
Замена целевого объекта развертывания в группе развертывания. Обычно это вызывается средством настройки агента.
function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
Новый целевой объект развертывания.
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой заменяется целевой объект развертывания.
- targetId
-
number
Идентификатор целевого объекта развертывания, который требуется заменить.
Возвращаемое значение
Promise<DeploymentMachine>
sendMessage(TaskAgentMessage, number, number)
function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>
Параметры
- message
- TaskAgentMessage
- poolId
-
number
- requestId
-
number
Возвращаемое значение
Promise<void>
setAgentPoolMetadata(any, number)
function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>
Параметры
- agentPoolMetadata
-
any
- poolId
-
number
Возвращаемое значение
Promise<void>
shareVariableGroup(VariableGroupProjectReference[], number)
Добавьте группу переменных.
function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>
Параметры
- variableGroupProjectReferences
- variableGroupId
-
number
Возвращаемое значение
Promise<void>
undeleteTaskGroup(TaskGroup, string)
function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>
Параметры
- taskGroup
- TaskGroup
- project
-
string
Идентификатор проекта или имя проекта
Возвращаемое значение
Promise<TaskGroup[]>
updateAgent(TaskAgent, number, number)
Обновление сведений об агенте.
function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>
Параметры
- agent
- TaskAgent
Обновлены сведения об агенте
- poolId
-
number
Используемый пул агентов
- agentId
-
number
Агент для обновления
Возвращаемое значение
Promise<TaskAgent>
updateAgentCloud(TaskAgentCloud, number)
function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>
Параметры
- updatedCloud
- TaskAgentCloud
- agentCloudId
-
number
Возвращаемое значение
Promise<TaskAgentCloud>
updateAgentPool(TaskAgentPool, number)
Обновление свойств в пуле агентов
function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>
Параметры
- pool
- TaskAgentPool
Обновленные сведения о пуле агентов
- poolId
-
number
Пул агентов для обновления
Возвращаемое значение
Promise<TaskAgentPool>
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>
Параметры
- definition
- TaskAgentPoolMaintenanceDefinition
- poolId
-
number
- definitionId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceDefinition>
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>
Параметры
- poolId
-
number
- jobId
-
number
Возвращаемое значение
Promise<TaskAgentPoolMaintenanceJob>
updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)
function updateAgentRequest(request: TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentRequestUpdateOptions): Promise<TaskAgentJobRequest>
Параметры
- request
- TaskAgentJobRequest
- poolId
-
number
- requestId
-
number
- lockToken
-
string
- updateOptions
- TaskAgentRequestUpdateOptions
Возвращаемое значение
Promise<TaskAgentJobRequest>
updateAgentUpdateState(number, number, string)
function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>
Параметры
- poolId
-
number
- agentId
-
number
- currentState
-
string
Возвращаемое значение
Promise<TaskAgent>
updateAgentUserCapabilities({[key: string]: string}, number, number)
function updateAgentUserCapabilities(userCapabilities: {[key: string]: string}, poolId: number, agentId: number): Promise<TaskAgent>
Параметры
- userCapabilities
-
{[key: string]: string}
- poolId
-
number
- agentId
-
number
Возвращаемое значение
Promise<TaskAgent>
updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)
Обновление группы развертывания.
function updateDeploymentGroup(deploymentGroup: DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<DeploymentGroup>
Параметры
- deploymentGroup
- DeploymentGroupUpdateParameter
Обновляемая группа развертывания.
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания.
Возвращаемое значение
Promise<DeploymentGroup>
updateDeploymentMachine(DeploymentMachine, string, number, number)
function updateDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
- machineId
-
number
Возвращаемое значение
Promise<DeploymentMachine>
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
function updateDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string, machineGroupId: number): Promise<DeploymentMachineGroup>
Параметры
- machineGroup
- DeploymentMachineGroup
- project
-
string
Идентификатор проекта или имя проекта
- machineGroupId
-
number
Возвращаемое значение
Promise<DeploymentMachineGroup>
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>
Параметры
- deploymentMachines
- project
-
string
Идентификатор проекта или имя проекта
- machineGroupId
-
number
Возвращаемое значение
Promise<DeploymentMachine[]>
updateDeploymentMachines(DeploymentMachine[], string, number)
function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>
Параметры
- machines
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Возвращаемое значение
Promise<DeploymentMachine[]>
updateDeploymentTarget(DeploymentMachine, string, number, number)
Обновление целевого объекта развертывания и его свойств агента в группе развертывания. Обычно это вызывается средством настройки агента.
function updateDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>
Параметры
- machine
- DeploymentMachine
Целевой объект развертывания для обновления.
- project
-
string
Идентификатор проекта или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой обновляется целевой объект развертывания.
- targetId
-
number
Идентификатор обновляемого целевого объекта развертывания.
Возвращаемое значение
Promise<DeploymentMachine>
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)
Обновление тегов списка целевых объектов развертывания в группе развертывания.
function updateDeploymentTargets(machines: DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>
Параметры
- machines
Целевые объекты развертывания с тегами для udpdate.
- project
-
string
Идентификатор или имя проекта
- deploymentGroupId
-
number
Идентификатор группы развертывания, в которой обновляются целевые объекты развертывания.
Возвращаемое значение
Promise<DeploymentMachine[]>
updateEnvironment(EnvironmentUpdateParameter, string, number)
Обновите указанную среду.
function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>
Параметры
- environmentUpdateParameter
- EnvironmentUpdateParameter
Обновляемая информация среды.
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Идентификатор среды.
Возвращаемое значение
Promise<EnvironmentInstance>
updateSecureFile(SecureFile, string, string)
Обновление имени или свойств существующего защищенного файла
function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>
Параметры
- secureFile
- SecureFile
Безопасный файл с обновленным именем и (или) свойствами
- project
-
string
Идентификатор или имя проекта
- secureFileId
-
string
Уникальный идентификатор защищенного файла
Возвращаемое значение
Promise<SecureFile>
updateSecureFiles(SecureFile[], string)
Обновление свойств и (или) имен набора защищенных файлов. Файлы идентифицируются по их идентификаторам. Предоставленные свойства полностью переопределяют существующий, т. е. не объединяются.
function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>
Параметры
- secureFiles
Список защищенных файловых объектов. Только три поля должны быть заполнены идентификатором, именем и свойствами. Остальные поля в объекте игнорируются.
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<SecureFile[]>
updateTaskGroup(TaskGroupUpdateParameter, string, string)
Обновление группы задач.
function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>
Параметры
- taskGroup
- TaskGroupUpdateParameter
Обновляемая группа задач.
- project
-
string
Идентификатор или имя проекта
- taskGroupId
-
string
Идентификатор обновляемой группы задач.
Возвращаемое значение
Promise<TaskGroup>
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
function updateTaskGroupProperties(taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskGroup[]>
Параметры
- taskGroupUpdateProperties
- TaskGroupUpdatePropertiesBase
- project
-
string
Идентификатор или имя проекта
- taskGroupId
-
string
- disablePriorVersions
-
boolean
Возвращаемое значение
Promise<TaskGroup[]>
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>
Параметры
- taskHubLicenseDetails
- TaskHubLicenseDetails
- hubName
-
string
Возвращаемое значение
Promise<TaskHubLicenseDetails>
updateVariableGroup(VariableGroupParameters, number)
Обновление группы переменных.
function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>
Параметры
- variableGroupParameters
- VariableGroupParameters
- groupId
-
number
Идентификатор обновляемой группы переменных.
Возвращаемое значение
Promise<VariableGroup>
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
function updateVirtualMachineGroup(resource: VirtualMachineGroup, project: string, environmentId: number): Promise<VirtualMachineGroup>
Параметры
- resource
- VirtualMachineGroup
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
Возвращаемое значение
Promise<VirtualMachineGroup>
updateVirtualMachines(VirtualMachine[], string, number, number)
function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>
Параметры
- machines
- project
-
string
Идентификатор или имя проекта
- environmentId
-
number
- resourceId
-
number
Возвращаемое значение
Promise<VirtualMachine[]>
uploadSecureFile(any, string, string, boolean)
Отправка защищенного файла, включение потока файлов в текст запроса
function uploadSecureFile(content: any, project: string, name: string, authorizePipelines?: boolean): Promise<SecureFile>
Параметры
- content
-
any
Содержимое для отправки
- project
-
string
Идентификатор или имя проекта
- name
-
string
Имя файла для отправки
- authorizePipelines
-
boolean
Если параметр authorizePipelines имеет значение true, безопасный файл авторизован для использования всеми конвейерами в проекте.
Возвращаемое значение
Promise<SecureFile>
validateInputs(InputValidationRequest)
function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>
Параметры
- inputValidationRequest
- InputValidationRequest
Возвращаемое значение
Promise<InputValidationRequest>