TaskAgentRestClient class

VSS REST api에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

생성자

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)	배포 대상을 배포 그룹에 등록하세요. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.
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)	ID로 보안 파일 다운로드
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)	에이전트 대기열 목록을 ID별로 확인하세요
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	상담원 대기열 목록을 이름으로 받아보세요
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	풀 ID별 에이전트 대기열 목록을 받아보세요
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)	ID로 배포 그룹을 가져옵니다.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	이름 또는 ID별로 배포 그룹 목록을 가져옵니다.
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)	배포 그룹의 ID로 배포 대상 가져오기
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	배포 그룹의 배포 대상 목록을 가져옵니다.
getEnvironmentById(string, number, EnvironmentExpands)	환경의 ID를 기준으로 얻으세요.
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)	작업 그룹을 나열하세요.
getTaskGroupsByIds({[key: string]: string[]}, string, boolean)	작업 그룹을 ID와 버전 사양으로 받으세요.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	가변 그룹을 만드세요.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	가변 그룹을 만드세요.
getVariableGroupsById(string, number[], boolean)	ID별로 변수 그룹을 얻으세요.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	Yaml 파일 검증에 사용되는 Yaml 스키마를 받아보세요.
hasPoolPermissions(number, number)	현재 신원이 풀에 대한 권한을 통과했는지 확인합니다.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	'엔드포인트'가 정의한 GET 요청의 프록시입니다. 요청은 서비스 연결을 통해 승인됩니다. 응답은 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)	배치 그룹 내에서 배치 대상을 교체합니다. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.
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)	배포 대상 및 배포 그룹 내 에이전트 속성을 업데이트합니다. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	배포 그룹의 배포 대상 목록 태그를 업데이트합니다.
updateEnvironment(EnvironmentUpdateParameter, string, number)	지정된 환경을 업데이트하세요.
updateSecureFile(SecureFile, string, string)	기존 보안 파일의 이름 또는 속성 업데이트
updateSecureFiles(SecureFile[], string)	보안 파일 집합의 속성 및/또는 이름을 업데이트합니다. 파일은 ID로 식별됩니다. 제공된 속성은 기존 속성을 완전히 재정의합니다. 즉, 병합하지 않습니다.
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: "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd" = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

속성 값

"a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

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

프로젝트 ID 또는 프로젝트 이름

authorizePipelines: boolean

YAML을 사용할 때 이 큐를 자동으로 승인하세요

반품

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

배포 그룹을 만듭니다.

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

매개 변수

deploymentGroup: DeploymentGroupCreateParameter

배포 그룹을 생성하세요.

project: string

프로젝트 ID 또는 프로젝트 이름

반품

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

매개 변수

machine: DeploymentMachine

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

반품

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

매개 변수

machineGroup: DeploymentMachineGroup

project: string

프로젝트 ID 또는 프로젝트 이름

반품

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

배포 대상을 배포 그룹에 등록하세요. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.

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

매개 변수

machine: DeploymentMachine

배치 목표를 등록하세요.

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 등록된 배포 그룹의 ID.

반품

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

환경을 만듭니다.

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

매개 변수

environmentCreateParameter: EnvironmentCreateParameter

창작할 수 있는 환경.

project: string

프로젝트 ID 또는 프로젝트 이름

반품

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

매개 변수

createParameters: KubernetesResourceCreateParameters

project: string

프로젝트 ID 또는 프로젝트 이름

environmentId: number

반품

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

작업 그룹을 만드세요.

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

매개 변수

taskGroup: TaskGroupCreateParameter

작업 그룹 객체를 생성할 예정입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

반품

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

반품

Promise<void>

deleteAgent(number, number)

에이전트를 삭제합니다. 이 엔드포인트를 직접 호출하지 않을 수 있습니다. 대신, 에이전트 구성 스크립트를 사용 해 조직에서 에이전트를 제거하세요.

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

매개 변수

poolId: number

에이전트를 제거하기 위한 풀 ID

agentId: number

제거할 에이전트 ID

반품

Promise<void>

deleteAgentCloud(number)

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

매개 변수

agentCloudId: number

반품

Promise<TaskAgentCloud>

deleteAgentPool(number)

에이전트 풀을 삭제합니다.

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

매개 변수

poolId: number

삭제할 에이전트 풀의 ID

반품

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

프로젝트 ID 또는 프로젝트 이름

반품

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

삭제할 배포 그룹의 ID입니다.

반품

Promise<void>

deleteDeploymentMachine(string, number, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

machineId: number

반품

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

machineGroupId: number

반품

Promise<void>

deleteDeploymentTarget(string, number, number)

배포 그룹 내 배포 대상을 삭제하세요. 이렇게 하면 에이전트가 연관된 배포 풀에서도 삭제됩니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 삭제되는 배포 그룹의 ID.

targetId: number

삭제할 배포 대상의 ID입니다.

반품

Promise<void>

deleteEnvironment(string, number)

지정된 환경을 삭제하세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

environmentId: number

환경의 ID입니다.

반품

Promise<void>

deleteKubernetesResource(string, number, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

secureFileId: string

고유한 보안 파일 ID

반품

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

프로젝트 ID 또는 프로젝트 이름

taskGroupId: string

삭제할 작업 그룹의 신분증.

comment: string

댓글은 삭제해야 합니다.

반품

Promise<void>

deleteVariableGroup(number, string[])

변수 그룹 삭제

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

매개 변수

groupId: number

변수 그룹의 ID입니다.

projectIds: string[]

반품

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

environmentId: number

resourceId: number

반품

Promise<void>

downloadSecureFile(string, string, string, boolean)

ID로 보안 파일 다운로드

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

secureFileId: string

고유한 보안 파일 ID

ticket: string

유효한 다운로드 티켓

download: boolean

다운로드가 true이면 파일이 응답 본문에 첨부 파일로 전송됩니다. 다운로드가 false이면 응답 본문에 파일 스트림이 포함됩니다.

반품

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

배포 그룹 내에서 배포 대상 관리를 (구성, 제거, 태깅) 위한 PAT 토큰을 받으세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 관리되는 배포 그룹의 ID.

반품

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

정보를 가져올 에이전트 ID

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

에이전트 풀 ID

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

풀 ID 가져오기

actionFilter: TaskAgentPoolActionFilter

호출 사용자가 사용 권한 또는 관리 권한 중 하나로 필터링하세요

반품

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

에이전트 대기열에 대한 정보를 얻으세요.

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

매개 변수

queueId: number

정보를 얻기 위한 에이전트 큐

project: string

프로젝트 ID 또는 프로젝트 이름

actionFilter: TaskAgentQueueActionFilter

호출 사용자가 사용 권한 또는 관리 권한 중 하나로 필터링하세요

반품

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

에이전트 대기열 목록을 받아보세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

queueName: string

에이전트 큐 이름에 필터 적용

actionFilter: TaskAgentQueueActionFilter

호출 사용자가 사용 권한 또는 관리 권한 중 하나로 필터링하세요

반품

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

에이전트 대기열 목록을 ID별로 확인하세요

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

매개 변수

queueIds: number[]

검색할 에이전트 큐 ID 목록은 쉼표로 구분되어 있습니다

project: string

프로젝트 ID 또는 프로젝트 이름

actionFilter: TaskAgentQueueActionFilter

호출 사용자가 사용 권한 또는 관리 권한 중 하나로 필터링하세요

반품

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

상담원 대기열 목록을 이름으로 받아보세요

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

매개 변수

queueNames: string[]

검색할 에이전트 이름 목록은 쉼표로 구분되어 있습니다

project: string

프로젝트 ID 또는 프로젝트 이름

actionFilter: TaskAgentQueueActionFilter

호출 사용자가 사용 권한 또는 관리 권한 중 하나로 필터링하세요

반품

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

풀 ID별 에이전트 대기열 목록을 받아보세요

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

매개 변수

poolIds: number[]

해당 큐를 얻기 위한 쉼표로 구분된 풀 ID 목록

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

목표가 속한 배치 그룹의 식별.

targetIds: number[]

쉼표는 배치 대상 ID 목록을 구분했습니다.

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

프로젝트 ID 또는 프로젝트 이름

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)

ID로 배포 그룹을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 그룹의 ID입니다.

actionFilter: DeploymentGroupActionFilter

이 작업을 수행할 수 있는 경우에만 배포 그룹을 가져옵니다.

expand: DeploymentGroupExpands

반환된 개체에 이러한 추가 세부 정보를 포함합니다.

반품

Promise<DeploymentGroup>

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

이름 또는 ID별로 배포 그룹 목록을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

name: string

배포 그룹의 이름입니다.

actionFilter: DeploymentGroupActionFilter

이 작업을 수행할 수 있는 배포 그룹만 가져옵니다.

expand: DeploymentGroupExpands

반환된 개체에 이러한 추가 세부 정보를 포함합니다.

continuationToken: string

이 continuationToken보다 큰 이름의 배포 그룹을 사전순으로 가져옵니다.

top: number

반환할 최대 배포 그룹 수입니다. 기본값은 1000.

ids: number[]

배포 그룹의 쉼표로 구분된 ID 목록입니다.

반품

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

배포 그룹 지표 목록을 받아보세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupName: string

배포 그룹의 이름입니다.

continuationToken: string

이 연속보다 큰 배포 그룹의 메트릭을 사전식으로 얻습니다.

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

반품

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

machineGroupId: number

actionFilter: MachineGroupActionFilter

반품

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

machineGroupId: number

tagFilters: string[]

반품

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

배치 풀 ID 목록.

반품

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

배포 그룹의 ID로 배포 대상 가져오기

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 속한 배포 그룹의 ID입니다.

targetId: number

반환할 배포 대상의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 그룹의 ID입니다.

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)

환경의 ID를 기준으로 얻으세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

environmentId: number

환경의 ID입니다.

expands: EnvironmentExpands

반환된 개체에 이러한 추가 세부 정보를 포함합니다.

반품

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

환경 배포 실행 기록 확인

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

secureFileId: string

고유한 보안 파일 ID

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

secureFileIds: string[]

보안 파일 ID 목록

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

프로젝트 ID 또는 프로젝트 이름

secureFileNames: string[]

보안 파일 ID 목록

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

taskGroupId: string

반품

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

taskGroupId: string

태스크 그룹의 신분증.

expanded: boolean

'참'은 태스크 그룹을 재귀적으로 확장하는 데 사용됩니다. 기본값은 'false'입니다.

taskIdFilter: string

필터링할 taskId의 가이드.

deleted: boolean

삭제된 작업 그룹을 포함할 때 'true'입니다. 기본값은 'false'입니다.

top: number

작업 그룹을 수로 채우는 것.

continuationToken: Date

연속 토큰이 제공된 후 작업 그룹을 받습니다.

queryOrder: TaskGroupQueryOrder

정의된 순서로 결과를 가져옵니다. 기본값은 'CreatedOnDescending'입니다.

반품

Promise<TaskGroup[]>

getTaskGroupsByIds({[key: string]: string[]}, string, boolean)

작업 그룹을 ID와 버전 사양으로 받으세요.

function getTaskGroupsByIds(groupsVersionsMap: {[key: string]: string[]}, project: string, expand?: boolean): Promise<{[key: string]: TaskAgent.TaskGroup[]}>

매개 변수

groupsVersionsMap: {[key: string]: string[]}

그룹 ID를 버전 지도로 연결하세요.

project: string

프로젝트 ID 또는 프로젝트 이름

expand: boolean

확장해야 할 속성들. 예시 $expand=작업은 중첩된 작업 그룹을 확장합니다.

반품

Promise<{[key: string]: 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

프로젝트 ID 또는 프로젝트 이름

groupId: number

변수 그룹의 ID입니다.

반품

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

프로젝트 ID 또는 프로젝트 이름

groupName: string

변수 그룹 이름.

actionFilter: VariableGroupActionFilter

변수 그룹에 대한 작업 필터입니다. 변수 그룹에서 수행할 수 있는 작업을 지정합니다.

top: number

가져올 변수 그룹의 수입니다.

continuationToken: number

제공된 연속 토큰 이후의 변수 그룹을 가져옵니다.

queryOrder: VariableGroupQueryOrder

정의된 순서로 결과를 가져옵니다. 기본값은 'IdDescending'입니다.

반품

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

ID별로 변수 그룹을 얻으세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

groupIds: number[]

변수 그룹의 Id를 쉼표로 분리한 목록.

loadSecrets: boolean

변수 그룹 내 비밀을 로드해야 하는지 나타내는 플래그.

반품

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

주 조건 구문은 여기에 설명되어 있습니다. 속성('property-name') 함수를 사용하여 보안 파일의 지정된 속성 값에 액세스합니다. 속성이 설정되지 않은 경우 null을 반환합니다. 예: and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

반품

Promise<void>

refreshDeploymentTargets(string, number)

배포 그룹 내 배치 타겟을 업그레이드하세요.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 그룹의 ID입니다.

반품

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

machineId: number

반품

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

배치 그룹 내에서 배치 대상을 교체합니다. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.

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

매개 변수

machine: DeploymentMachine

새로운 배치 목표.

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배치 대상이 교체되는 배포 그룹의 ID.

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

프로젝트 ID 또는 프로젝트 이름

반품

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

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 그룹의 ID입니다.

반품

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

매개 변수

machine: DeploymentMachine

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

machineId: number

반품

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

매개 변수

machineGroup: DeploymentMachineGroup

project: string

프로젝트 ID 또는 프로젝트 이름

machineGroupId: number

반품

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

매개 변수

deploymentMachines: DeploymentMachine[]

project: string

프로젝트 ID 또는 프로젝트 이름

machineGroupId: number

반품

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

매개 변수

machines: DeploymentMachine[]

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

반품

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

배포 대상 및 배포 그룹 내 에이전트 속성을 업데이트합니다. 일반적으로 이를 에이전트 구성 도구(agent configuration tool)라고 부릅니다.

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

매개 변수

machine: DeploymentMachine

배치 목표 업데이트 예정.

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 업데이트되는 배포 그룹의 ID.

targetId: number

업데이트할 배포 대상 식별자.

반품

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

배포 그룹의 배포 대상 목록 태그를 업데이트합니다.

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

매개 변수

machines: DeploymentTargetUpdateParameter[]

udpdate할 태그가 있는 배포 대상입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

deploymentGroupId: number

배포 대상이 업데이트되는 배포 그룹의 ID입니다.

반품

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

지정된 환경을 업데이트하세요.

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

매개 변수

environmentUpdateParameter: EnvironmentUpdateParameter

환경 데이터를 업데이트해야 합니다.

project: string

프로젝트 ID 또는 프로젝트 이름

environmentId: number

환경의 ID입니다.

반품

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

기존 보안 파일의 이름 또는 속성 업데이트

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

매개 변수

secureFile: SecureFile

업데이트된 이름 및/또는 속성이 포함된 보안 파일

project: string

프로젝트 ID 또는 프로젝트 이름

secureFileId: string

고유한 보안 파일 ID

반품

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

보안 파일 집합의 속성 및/또는 이름을 업데이트합니다. 파일은 ID로 식별됩니다. 제공된 속성은 기존 속성을 완전히 재정의합니다. 즉, 병합하지 않습니다.

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

매개 변수

secureFiles: SecureFile[]

보안 파일 개체 목록입니다. ID, 이름 및 속성은 세 필드만 채워야 합니다. 개체의 나머지 필드는 무시됩니다.

project: string

프로젝트 ID 또는 프로젝트 이름

반품

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

작업 그룹을 업데이트하세요.

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

매개 변수

taskGroup: TaskGroupUpdateParameter

작업 그룹에 업데이트가 필요합니다.

project: string

프로젝트 ID 또는 프로젝트 이름

taskGroupId: string

작업 그룹 ID를 업데이트하세요.

반품

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

매개 변수

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

프로젝트 ID 또는 프로젝트 이름

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

업데이트할 변수 그룹의 ID입니다.

반품

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

매개 변수

resource: VirtualMachineGroup

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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)

매개 변수

반품