TaskAgentRestClient class

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

TaskAgentRestClient(IVssRestClientOptions)

Свойства

Методы

addAgent(TaskAgent, number)	Добавляет агент в пул. Возможно, вы не хотите напрямую вызывать эту конечную точку. Вместо этого настроить агент с помощью пакета загрузки агента.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Создайте пул агентов.
addAgentQueue(TaskAgentQueue, string, boolean)	Создайте новую очередь агентов для подключения проекта к пулу агентов.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Создайте группу развертывания.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Зарегистрируйте целевой объект развертывания в группе развертывания. Как правило, это вызывается инструментом настройки агента.
addEnvironment(EnvironmentCreateParameter, string)	Создайте среду.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Создайте группу задач.
addVariableGroup(VariableGroupParameters)	Добавьте группу переменных.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Создайте новый командный проект.
deleteAgent(number, number)	Удаление агента. Возможно, вы не хотите напрямую вызывать эту конечную точку. Вместо этого используйте сценарий настройки агента , чтобы удалить агента из организации.
deleteAgentCloud(number)
deleteAgentPool(number)	Удалите пул агентов.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Удаляет очередь агентов из проекта.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Удалите группу развертывания.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Удаление целевого объекта развертывания в группе развертывания. При этом агент также будет удален из связанного пула развертывания.
deleteEnvironment(string, number)	Удалите указанную среду.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Как удалить защищенный файл
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Удаление группы задач.
deleteVariableGroup(number, string[])	Удаление группы переменных
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Скачать защищенный файл по идентификатору
generateDeploymentGroupAccessToken(string, number)	Получите токен PAT для управления (настройки, удаления, добавления тегов) целями развертывания в группе развертывания.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	Получите токен PAT для управления (настройки, удаления, добавления тегов) агентами развертывания в пуле развертывания.
getAgent(number, number, boolean, boolean, boolean, string[])	Получение сведений об агенте.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Получите типы облаков агентов.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Получите информацию о пуле агентов.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Получите список пулов агентов.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Получите список пулов агентов.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Получите информацию об очереди агентов.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Получите список очередей операторов.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Получение списка очередей операторов по их идентификаторам
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Получение списка очередей операторов по их именам
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Получение списка очередей агентов по идентификаторам пула
getAgentRequest(number, number, boolean)
getAgentRequests(number, number, string)
getAgentRequestsForAgent(number, number, number)
getAgentRequestsForAgents(number, number[], number)
getAgentRequestsForDeploymentMachine(string, number, number, number)
getAgentRequestsForDeploymentMachines(string, number, number[], number)
getAgentRequestsForDeploymentTarget(string, number, number, number)	Получение запросов агента для целевого объекта развертывания.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Получение запросов агента для списка целей развертывания.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Получение списка агентов.
getAzureManagementGroups()	Возвращает список подписок Azure
getAzureSubscriptions()	Возвращает список подписок Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Получите группу развертывания по идентификатору.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Получение списка групп развертывания по имени или идентификаторам.
getDeploymentGroupsMetrics(string, string, string, number)	Получите список метрик группы развертывания.
getDeploymentMachine(string, number, number, DeploymentMachineExpands)
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
getDeploymentMachineGroupMachines(string, number, string[])
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])	Получите список сводок пула развертывания.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Получение целевого объекта развертывания по идентификатору в группе развертывания
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Получение списка целевых объектов развертывания в группе развертывания.
getEnvironmentById(string, number, EnvironmentExpands)	Получите окружение по его идентификатору.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Получение журнала выполнения развертывания среды
getEnvironments(string, string, string, number)	Получите доступ ко всем средам.
getKubernetesResource(string, number, number)
getMessage(number, string, number)
getPackage(string, string, string)
getPackages(string, string, number)
getResourceLimits()
getResourceUsage(string, boolean, boolean)
getSecureFile(string, string, boolean, SecureFileActionFilter)	Получите защищенный файл
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Получите защищенные файлы
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Получите защищенные файлы
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Получите защищенные файлы
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Получить группу задач.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Список групп задач.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Получите группу переменных.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Получение групп переменных.
getVariableGroupsById(string, number[], boolean)	Получение групп переменных по идентификаторам.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	GET — схема Yaml, используемая для проверки файла Yaml.
hasPoolPermissions(number, number)	Проверяет, передали ли текущее удостоверение разрешения на пул.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Прокси для запроса GET, определяемого 'endpoint'. Запрос авторизуется с помощью подключения к службе. Ответ фильтруется с помощью селектора на основе XPath/Json.
querySecureFilesByProperties(string, string, string)	Запрашивайте защищенные файлы с помощью шаблона имени и условия для свойств файла.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Обновите целевые объекты развертывания в группе развертывания.
replaceAgent(TaskAgent, number, number)	Замените агент. Возможно, вы не хотите напрямую вызывать эту конечную точку. Вместо этого использовать скрипт конфигурации агента для удаления и перенастройки агента из организации.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Замена целевого объекта развертывания в группе развертывания. Как правило, это вызывается инструментом настройки агента.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Добавьте группу переменных.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Обновление сведений об агенте.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Обновление свойств в пуле агентов
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)
updateAgentUpdateState(number, number, string)
updateAgentUserCapabilities({[key: string]: string}, number, number)
updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)	Обновите группу развертывания.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Обновите целевой объект развертывания и свойства его агента в группе развертывания. Как правило, это вызывается инструментом настройки агента.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Обновление тегов списка целевых объектов развертывания в группе развертывания.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Обновите указанную среду.
updateSecureFile(SecureFile, string, string)	Обновление имени или свойств существующего защищенного файла
updateSecureFiles(SecureFile[], string)	Обновление свойств и/или имен набора защищенных файлов. Файлы идентифицируются по их идентификаторам. Предоставленные свойства полностью перекрывают существующее, т.е. не объединяются.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Обновление группы задач.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Обновите группу переменных.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Загрузите защищенный файл, включите поток файлов в тело запроса
validateInputs(InputValidationRequest)

Сведения о конструкторе

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Параметры

options: 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)

Создайте пул агентов.

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

Параметры

pool: TaskAgentPool

Подробнее о новом пуле агентов

Возвращаемое значение

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Создайте новую очередь агентов для подключения проекта к пулу агентов.

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

Параметры

queue: TaskAgentQueue

Подробная информация об очереди для создания

project: string

Идентификатор проекта или имя проекта

authorizePipelines: boolean

Автоматическая авторизация этой очереди при использовании YAML

Возвращаемое значение

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Создайте группу развертывания.

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)

Создайте среду.

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)

Создайте группу задач.

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)

Создайте новый командный проект.

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

Если значение download равно true, файл отправляется в качестве вложения в теле ответа. Если значение load равно 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

Datetime для возврата запроса по истечении этого времени.

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

Получение групп развертывания с именами больше, чем это продолжениеToken лексографически.

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

Получение целевых объектов развертывания с именами больше, чем это продолжениеToken лексикографически.

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

Возвращаемое значение

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

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

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

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=Задачи расширят вложенные группы задач.

Возвращаемое значение

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

Получает переменную groups после предоставленного токена продолжения.

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)

GET — схема 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

ID бассейна для проверки

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, определяемого 'endpoint'. Запрос авторизуется с помощью подключения к службе. Ответ фильтруется с помощью селектора на основе 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

Основной синтаксис условия описан здесь. Используйте функцию 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>

Параметры

job: 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: VariableGroupProjectReference[]

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>

Параметры

job: 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: DeploymentMachine[]

project: string

Идентификатор проекта или имя проекта

machineGroupId: number

Возвращаемое значение

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Параметры

machines: DeploymentMachine[]

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: DeploymentTargetUpdateParameter[]

Целевые объекты развертывания с тегами для 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: SecureFile[]

Список защищенных файловых объектов. Должны быть заполнены только три поля: Id, Name и Properties. Остальные поля в объекте игнорируются.

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: VirtualMachine[]

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>

Обратная связь

Была ли эта страница полезна?

Поделиться через

TaskAgentRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

TaskAgentRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

addAgent(TaskAgent, number)

Параметры

Возвращаемое значение

addAgentCloud(TaskAgentCloud)

Параметры

Возвращаемое значение

addAgentPool(TaskAgentPool)

Параметры

Возвращаемое значение

addAgentQueue(TaskAgentQueue, string, boolean)

Параметры

Возвращаемое значение

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Параметры

Возвращаемое значение

addDeploymentMachine(DeploymentMachine, string, number)

Параметры

Возвращаемое значение

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Параметры

Возвращаемое значение

addDeploymentTarget(DeploymentMachine, string, number)

Параметры

Возвращаемое значение

addEnvironment(EnvironmentCreateParameter, string)

Параметры

Возвращаемое значение

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Параметры

Возвращаемое значение

addTaskGroup(TaskGroupCreateParameter, string)

Параметры

Возвращаемое значение

addVariableGroup(VariableGroupParameters)

Параметры

Возвращаемое значение

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Параметры

Возвращаемое значение

createAgentSession(TaskAgentSession, number)

Параметры

Возвращаемое значение

createTeamProject(string)

Параметры

Возвращаемое значение

deleteAgent(number, number)

Параметры

Возвращаемое значение

deleteAgentCloud(number)

Параметры

Возвращаемое значение

deleteAgentPool(number)

Параметры

Возвращаемое значение

deleteAgentPoolMaintenanceDefinition(number, number)

Параметры

Возвращаемое значение

deleteAgentPoolMaintenanceJob(number, number)

Параметры

Возвращаемое значение

deleteAgentQueue(number, string)

Параметры