TaskAgentRestClient class

Reference

Balíček:: azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends: RestClientBase

Konstruktory

TaskAgentRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addAgent(TaskAgent, number)	Přidá agenta do fondu. Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho nakonfigurujte agenta pomocí balíčku pro stažení agenta.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create fondu agentů.
addAgentQueue(TaskAgentQueue, string, boolean)	Create novou frontu agenta pro připojení projektu k fondu agentů.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create skupinu nasazení.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Registrace cíle nasazení do skupiny nasazení Obecně se nazývá nástroj pro konfiguraci agenta.
addEnvironment(EnvironmentCreateParameter, string)	Create prostředí.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create skupinu úloh.
addVariableGroup(VariableGroupParameters)	Přidejte skupinu proměnných.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create nový týmový projekt.
deleteAgent(number, number)	Odstranění agenta Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho použijte konfigurační skript agenta k odebrání agenta z vaší organizace.
deleteAgentCloud(number)
deleteAgentPool(number)	Odstranění fondu agentů
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Odebere z projektu frontu agenta.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Odstranění skupiny nasazení
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Odstranění cíle nasazení ve skupině nasazení Tím se agent odstraní také z přidruženého fondu nasazení.
deleteEnvironment(string, number)	Odstraňte zadané prostředí.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Odstranění zabezpečeného souboru
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Odstranění skupiny úloh
deleteVariableGroup(number, string[])	Odstranění skupiny proměnných
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Stažení zabezpečeného souboru podle ID
generateDeploymentGroupAccessToken(string, number)	ZÍSKEJTE token PAT pro správu (konfiguraci, odebírání, označování) cílů nasazení ve skupině nasazení.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	ZÍSKEJTE token PAT pro správu agentů nasazení (konfiguraci, odebírání, označování) ve fondu nasazení.
getAgent(number, number, boolean, boolean, boolean, string[])	Získejte informace o agentech.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Získejte typy cloudu agentů.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Získejte informace o fondu agentů.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Získejte seznam fondů agentů.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Získejte seznam fondů agentů.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Získejte informace o frontě agenta.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Získejte seznam front agentů.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Získání seznamu front agentů podle jejich ID
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Získání seznamu front agentů podle jejich názvů
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Získání seznamu front agentů podle ID fondu
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)	Získání požadavků agenta pro cíl nasazení
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Získání požadavků agenta pro seznam cílů nasazení
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Získejte seznam agentů.
getAzureManagementGroups()	Vrátí seznam předplatných Azure.
getAzureSubscriptions()	Vrátí seznam předplatných Azure.
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Získejte skupinu nasazení podle jejího ID.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Získejte seznam skupin nasazení podle názvu nebo ID.
getDeploymentGroupsMetrics(string, string, string, number)	Získejte seznam metrik skupiny nasazení.
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[])	Získejte seznam souhrnů fondu nasazení.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Získání cíle nasazení podle jeho ID ve skupině nasazení
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Získání seznamu cílů nasazení ve skupině nasazení
getEnvironmentById(string, number, EnvironmentExpands)	Získejte prostředí podle jeho ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Získání historie spouštění nasazení prostředí
getEnvironments(string, string, string, number)	Získejte všechna prostředí.
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)	Získání zabezpečeného souboru
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Získání zabezpečených souborů
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Získání zabezpečených souborů
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Získání zabezpečených souborů
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Získat skupinu úkolů.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Vypsat skupiny úkolů.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Získání skupiny proměnných
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Získání skupin proměnných
getVariableGroupsById(string, number[], boolean)	Získání skupin proměnných podle ID
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	ZÍSKEJTE schéma Yaml používané pro ověření souboru Yaml.
hasPoolPermissions(number, number)	Zkontroluje, jestli aktuální identita předala oprávnění k fondu.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy pro požadavek GET definovaný koncovým bodem. Žádost je autorizována pomocí připojení služby. Odpověď se filtruje pomocí selektoru založeného na XPath/JSON.
querySecureFilesByProperties(string, string, string)	Dotazování zabezpečených souborů pomocí vzoru názvů a podmínky pro vlastnosti souboru.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Upgradujte cíle nasazení ve skupině nasazení.
replaceAgent(TaskAgent, number, number)	Nahrazení agenta Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho pomocí konfiguračního skriptu agenta odeberte agenta z vaší organizace a překonfigurujte ho.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Nahraďte cíl nasazení ve skupině nasazení. Obecně se nazývá nástroj pro konfiguraci agenta.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Přidejte skupinu proměnných.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Podrobnosti o agentu aktualizace
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aktualizace vlastností fondu agentů
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)	Aktualizace skupiny nasazení
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Aktualizujte cíl nasazení a jeho vlastnosti agenta ve skupině nasazení. Obecně se nazývá nástroj pro konfiguraci agenta.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Aktualizujte značky seznamu cílů nasazení ve skupině nasazení.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Aktualizujte zadané prostředí.
updateSecureFile(SecureFile, string, string)	Aktualizace názvu nebo vlastností existujícího zabezpečeného souboru
updateSecureFiles(SecureFile[], string)	Aktualizujte vlastnosti nebo názvy sady zabezpečených souborů. Soubory jsou identifikované podle jejich ID. Zadané vlastnosti zcela přepíší existující vlastnost, tj. nesloučí.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Aktualizace skupiny úloh
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Aktualizujte skupinu proměnných.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Nahrajte zabezpečený soubor a zahrňte datový proud souboru do textu požadavku.
validateInputs(InputValidationRequest)

Podrobnosti konstruktoru

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addAgent(TaskAgent, number)

Přidá agenta do fondu. Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho nakonfigurujte agenta pomocí balíčku pro stažení agenta.

function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>

Parametry

agent: TaskAgent

Podrobnosti o přidaném agentu

poolId: number

Fond agentů, do kterého chcete přidat agenta

Návraty

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>

Parametry

agentCloud: TaskAgentCloud

Návraty

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create fondu agentů.

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

Parametry

pool: TaskAgentPool

Podrobnosti o novém fondu agentů

Návraty

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create novou frontu agenta pro připojení projektu k fondu agentů.

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

Parametry

queue: TaskAgentQueue

Podrobnosti o frontě, která se má vytvořit

project: string

ID projektu nebo název projektu

authorizePipelines: boolean

Automatická autorizace této fronty při použití YAML

Návraty

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create skupinu nasazení.

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

Parametry

deploymentGroup: DeploymentGroupCreateParameter

Skupinu nasazení, kterou chcete vytvořit.

project: string

ID projektu nebo název projektu

Návraty

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parametry

machine: DeploymentMachine

project: string

ID projektu nebo název projektu

deploymentGroupId: number

Návraty

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parametry

machineGroup: DeploymentMachineGroup

project: string

ID projektu nebo název projektu

Návraty

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Registrace cíle nasazení do skupiny nasazení Obecně se nazývá nástroj pro konfiguraci agenta.

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

Parametry

machine: DeploymentMachine

Cíl nasazení, který se má zaregistrovat.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, do které je cíl nasazení zaregistrovaný.

Návraty

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Create prostředí.

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

Parametry

environmentCreateParameter: EnvironmentCreateParameter

Prostředí, které se má vytvořit.

project: string

ID projektu nebo název projektu

Návraty

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parametry

createParameters: KubernetesResourceCreateParameters

project: string

ID projektu nebo název projektu

environmentId: number

Návraty

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create skupinu úloh.

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

Parametry

taskGroup: TaskGroupCreateParameter

Objekt skupiny úloh, který se má vytvořit.

project: string

ID projektu nebo název projektu

Návraty

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Přidejte skupinu proměnných.

function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>

Parametry

variableGroupParameters: VariableGroupParameters

Návraty

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

function addVirtualMachineGroup(createParameters: VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<VirtualMachineGroup>

Parametry

createParameters: VirtualMachineGroupCreateParameters

project: string

ID projektu nebo název projektu

environmentId: number

Návraty

Promise<VirtualMachineGroup>

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

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

Parametry

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Návraty

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parametry

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Návraty

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>

Parametry

session: TaskAgentSession

poolId: number

Návraty

Promise<TaskAgentSession>

createTeamProject(string)

Create nový týmový projekt.

function createTeamProject(project?: string): Promise<void>

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteAgent(number, number)

Odstranění agenta Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho použijte konfigurační skript agenta k odebrání agenta z vaší organizace.

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

Parametry

poolId: number

ID fondu, ze které se má agent odebrat

agentId: number

ID agenta, který se má odebrat

Návraty

Promise<void>

deleteAgentCloud(number)

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

Parametry

agentCloudId: number

Návraty

Promise<TaskAgentCloud>

deleteAgentPool(number)

Odstranění fondu agentů

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

Parametry

poolId: number

ID fondu agentů, který se má odstranit

Návraty

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>

Parametry

poolId: number

definitionId: number

Návraty

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>

Parametry

poolId: number

jobId: number

Návraty

Promise<void>

deleteAgentQueue(number, string)

Odebere z projektu frontu agenta.

function deleteAgentQueue(queueId: number, project?: string): Promise<void>

Parametry

queueId: number

Fronta agenta, která se má odebrat

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteAgentRequest(number, number, string, TaskResult, boolean)

function deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskResult, agentShuttingDown?: boolean): Promise<void>

Parametry

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Návraty

Promise<void>

deleteAgentSession(number, string)

function deleteAgentSession(poolId: number, sessionId: string): Promise<void>

Parametry

poolId: number

sessionId: string

Návraty

Promise<void>

deleteDeploymentGroup(string, number)

Odstranění skupiny nasazení

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, která se má odstranit.

Návraty

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineId: number

Návraty

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

machineGroupId: number

Návraty

Promise<void>

deleteDeploymentTarget(string, number, number)

Odstranění cíle nasazení ve skupině nasazení Tím se agent odstraní také z přidruženého fondu nasazení.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které je cíl nasazení odstraněn.

targetId: number

ID cíle nasazení, který se má odstranit.

Návraty

Promise<void>

deleteEnvironment(string, number)

Odstraňte zadané prostředí.

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

ID prostředí.

Návraty

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

Návraty

Promise<void>

deleteMessage(number, number, string)

function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>

Parametry

poolId: number

messageId: number

sessionId: string

Návraty

Promise<void>

deleteSecureFile(string, string)

Odstranění zabezpečeného souboru

function deleteSecureFile(project: string, secureFileId: string): Promise<void>

Parametry

project: string

ID projektu nebo název projektu

secureFileId: string

Jedinečné ID zabezpečeného souboru

Návraty

Promise<void>

deleteTaskDefinition(string)

function deleteTaskDefinition(taskId: string): Promise<void>

Parametry

taskId: string

Návraty

Promise<void>

deleteTaskGroup(string, string, string)

Odstranění skupiny úloh

function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

ID skupiny úloh, která se má odstranit.

comment: string

Komentáře, které se mají odstranit.

Návraty

Promise<void>

deleteVariableGroup(number, string[])

Odstranění skupiny proměnných

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

Parametry

groupId: number

ID skupiny proměnných

projectIds: string[]

Návraty

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

Návraty

Promise<void>

downloadSecureFile(string, string, string, boolean)

Stažení zabezpečeného souboru podle ID

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

Parametry

project: string

ID projektu nebo název projektu

secureFileId: string

Jedinečné ID zabezpečeného souboru

ticket: string

Platný lístek ke stažení

download: boolean

Pokud má stahování hodnotu true, soubor se odešle jako připojení v textu odpovědi. Pokud stahování není pravdivé, tělo odpovědi obsahuje datový proud souboru.

Návraty

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

ZÍSKEJTE token PAT pro správu (konfiguraci, odebírání, označování) cílů nasazení ve skupině nasazení.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které se spravují cíle nasazení.

Návraty

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

machineGroupId: number

Návraty

Promise<string>

generateDeploymentPoolAccessToken(number)

ZÍSKEJTE token PAT pro správu agentů nasazení (konfiguraci, odebírání, označování) ve fondu nasazení.

function generateDeploymentPoolAccessToken(poolId: number): Promise<string>

Parametry

poolId: number

ID fondu nasazení, ve kterém se spravují agenti nasazení.

Návraty

Promise<string>

getAgent(number, number, boolean, boolean, boolean, string[])

Získejte informace o agentech.

function getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgent>

Parametry

poolId: number

Fond agentů obsahující agenta

agentId: number

ID agenta pro získání informací o

includeCapabilities: boolean

Jestli se mají do odpovědi zahrnout schopnosti agenta

includeAssignedRequest: boolean

Zda zahrnout podrobnosti o aktuální práci agenta

includeLastCompletedRequest: boolean

Zda zahrnout podrobnosti o poslední dokončené práci agentů

propertyFilters: string[]

Filtrování vlastních vlastností, které se vrátí

Návraty

Promise<TaskAgent>

getAgentCloud(number)

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

Parametry

agentCloudId: number

Návraty

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>

Parametry

agentCloudId: number

Návraty

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Návraty

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Získejte typy cloudu agentů.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Návraty

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Získejte informace o fondu agentů.

function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>

Parametry

poolId: number

ID fondu agentů

properties: string[]

Vlastnosti fondu agentů (oddělené čárkami)

actionFilter: TaskAgentPoolActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parametry

poolId: number

definitionId: number

Návraty

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>

Parametry

poolId: number

Návraty

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

Parametry

poolId: number

jobId: number

Návraty

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>

Parametry

poolId: number

jobId: number

Návraty

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>

Parametry

poolId: number

definitionId: number

Návraty

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

function getAgentPoolMetadata(poolId: number): Promise<string>

Parametry

poolId: number

Návraty

Promise<string>

getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)

Získejte seznam fondů agentů.

function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

Parametry

poolName: string

Filtrovat podle názvu

properties: string[]

Filtrovat podle vlastností fondu agentů (oddělených čárkami)

poolType: TaskAgentPoolType

Filtrovat podle typu fondu

actionFilter: TaskAgentPoolActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Získejte seznam fondů agentů.

function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

Parametry

poolIds: number[]

ID fondu, která se mají načíst

actionFilter: TaskAgentPoolActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Získejte informace o frontě agenta.

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

Parametry

queueId: number

Fronta agenta pro získání informací o

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Získejte seznam front agentů.

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

Parametry

project: string

ID projektu nebo název projektu

queueName: string

Vyfiltrujte název fronty agentů.

actionFilter: TaskAgentQueueActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Získání seznamu front agentů podle jejich ID

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

Parametry

queueIds: number[]

Seznam ID front agentů oddělených čárkami, který se má načíst

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Získání seznamu front agentů podle jejich názvů

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

Parametry

queueNames: string[]

Seznam názvů agentů oddělených čárkami k načtení

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Získání seznamu front agentů podle ID fondu

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

Parametry

poolIds: number[]

Seznam ID fondů oddělený čárkami pro získání odpovídajících front pro

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrovat podle toho, jestli volající uživatel má oprávnění k používání nebo správě.

Návraty

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>

Parametry

poolId: number

requestId: number

includeStatus: boolean

Návraty

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

Parametry

poolId: number

top: number

continuationToken: string

Návraty

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

poolId: number

agentId: number

completedRequestCount: number

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

poolId: number

agentIds: number[]

completedRequestCount: number

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

function getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineId: number

completedRequestCount: number

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachines(string, number, number[], number)

function getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Získání požadavků agenta pro cíl nasazení

function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, do které cíl patří.

targetId: number

ID cíle nasazení.

completedRequestCount: number

Maximální počet dokončených žádostí k vrácení Výchozí hodnota je 50.

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)

Získání požadavků agenta pro seznam cílů nasazení

function getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, do které cíle patří.

targetIds: number[]

Čárkami oddělený seznam ID cílů nasazení.

ownerId: number

ID vlastníka žádosti o úlohu agenta

completedOn: Date

Datum a čas pro vrácení žádosti po této době.

completedRequestCount: number

Maximální počet dokončených požadavků, které se mají vrátit pro každý cíl. Výchozí hodnota je 50.

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>

Parametry

poolId: number

planId: string

jobId: string

Návraty

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

function getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

Parametry

project: string

ID projektu nebo název projektu

queueId: number

top: number

continuationToken: string

Návraty

Promise<PagedList<TaskAgentJobRequest>>

getAgents(number, string, boolean, boolean, boolean, string[], string[])

Získejte seznam agentů.

function getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgent[]>

Parametry

poolId: number

Fond agentů obsahující agenty

agentName: string

Filtrování názvu agenta

includeCapabilities: boolean

Zda se mají do odpovědi zahrnout schopnosti agentů

includeAssignedRequest: boolean

Zda zahrnout podrobnosti o aktuální práci agentů

includeLastCompletedRequest: boolean

Zda zahrnout podrobnosti o poslední dokončené práci agentů

propertyFilters: string[]

Filtrování vlastních vlastností, které se vrátí

demands: string[]

Filtrovat podle požadavků, které agenti mohou splnit

Návraty

Promise<TaskAgent[]>

getAzureManagementGroups()

Vrátí seznam předplatných Azure.

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Návraty

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Vrátí seznam předplatných Azure.

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Návraty

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Získejte skupinu nasazení podle jejího ID.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení.

actionFilter: DeploymentGroupActionFilter

Skupinu nasazení získejte jenom v případě, že se s ní dá tato akce provést.

expand: DeploymentGroupExpands

Do vráceného objektu zahrňte tyto další podrobnosti.

Návraty

Promise<DeploymentGroup>

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

Získejte seznam skupin nasazení podle názvu nebo ID.

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

Parametry

project: string

ID projektu nebo název projektu

name: string

Název skupiny nasazení.

actionFilter: DeploymentGroupActionFilter

Získejte pouze skupiny nasazení, u kterých je možné tuto akci provést.

expand: DeploymentGroupExpands

Do vrácených objektů zahrňte tyto další podrobnosti.

continuationToken: string

Získejte skupiny nasazení s názvy většími než tento název continuationToken lexicograficky.

top: number

Maximální počet skupin nasazení, které se mají vrátit. Výchozí hodnota je 1000.

ids: number[]

Čárkami oddělený seznam ID skupin nasazení

Návraty

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Získejte seznam metrik skupiny nasazení.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupName: string

Název skupiny nasazení.

continuationToken: string

Získejte metriky pro skupiny nasazení s názvy většími než tento název continuationToken lexiograficky.

top: number

Maximální počet metrik skupiny nasazení, které se mají vrátit. Výchozí hodnota je 50.

Návraty

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

function getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: DeploymentMachineExpands): Promise<DeploymentMachine>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Návraty

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parametry

project: string

ID projektu nebo název projektu

machineGroupId: number

actionFilter: MachineGroupActionFilter

Návraty

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parametry

project: string

ID projektu nebo název projektu

machineGroupId: number

tagFilters: string[]

Návraty

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parametry

project: string

ID projektu nebo název projektu

machineGroupName: string

actionFilter: MachineGroupActionFilter

Návraty

Promise<DeploymentMachineGroup[]>

getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)

function getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: DeploymentMachineExpands): Promise<DeploymentMachine[]>

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Návraty

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Získejte seznam souhrnů fondu nasazení.

function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>

Parametry

poolName: string

Název fondu nasazení.

expands: DeploymentPoolSummaryExpands

Do vrácených objektů zahrňte tyto další podrobnosti.

poolIds: number[]

Seznam ID fondu nasazení

Návraty

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Získání cíle nasazení podle jeho ID ve skupině nasazení

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, do které patří cíl nasazení.

targetId: number

ID cíle nasazení, který se má vrátit.

expand: DeploymentTargetExpands

Do vrácených objektů zahrňte tyto další podrobnosti.

Návraty

Promise<DeploymentMachine>

getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])

Získání seznamu cílů nasazení ve skupině nasazení

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení.

tags: string[]

Získejte pouze cíle nasazení, které obsahují všechny tyto čárky separovaný seznam značek.

name: string

Vzor názvů cílů nasazení, které se mají vrátit.

partialNameMatch: boolean

Pokud je nastavená hodnota true, zachází s názvem jako se vzorem. Else ji považuje za absolutní shodu. Výchozí hodnota je false.

expand: DeploymentTargetExpands

Do vrácených objektů zahrňte tyto další podrobnosti.

agentStatus: TaskAgentStatusFilter

Získejte pouze cíle nasazení, které mají tento stav.

agentJobResult: TaskAgentJobResultFilter

Získejte pouze cíle nasazení, které mají výsledek poslední úlohy.

continuationToken: string

Získejte cíle nasazení s názvy většími než tento název continuationToken lexiograficky.

top: number

Maximální počet cílů nasazení, které se mají vrátit. Výchozí hodnota je 1000.

enabled: boolean

Získá jenom cíle nasazení, které jsou povolené nebo zakázané. Výchozí hodnota je null, která vrací všechny cíle.

propertyFilters: string[]

Návraty

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Získejte prostředí podle jeho ID.

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

ID prostředí.

expands: EnvironmentExpands

Do vrácených objektů zahrňte tyto další podrobnosti.

Návraty

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Získání historie spouštění nasazení prostředí

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

continuationToken: string

top: number

Návraty

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Získejte všechna prostředí.

function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>

Parametry

project: string

ID projektu nebo název projektu

name: string

continuationToken: string

top: number

Návraty

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

function getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<KubernetesResource>

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

Návraty

Promise<KubernetesResource>

getMessage(number, string, number)

function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>

Parametry

poolId: number

sessionId: string

lastMessageId: number

Návraty

Promise<TaskAgentMessage>

getPackage(string, string, string)

function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>

Parametry

packageType: string

platform: string

version: string

Návraty

Promise<PackageMetadata>

getPackages(string, string, number)

function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>

Parametry

packageType: string

platform: string

top: number

Návraty

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Návraty

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>

Parametry

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Návraty

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Získání zabezpečeného souboru

function getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile>

Parametry

project: string

ID projektu nebo název projektu

secureFileId: string

Jedinečné ID zabezpečeného souboru

includeDownloadTicket: boolean

Pokud má includeDownloadTicket hodnotu true a volající má oprávnění, je součástí odpovědi lístek stažení.

actionFilter: SecureFileActionFilter

Návraty

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Získání zabezpečených souborů

function getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parametry

project: string

ID projektu nebo název projektu

namePattern: string

Název zabezpečeného souboru, který se má shodovat. Může obsahovat zástupné cardy, které odpovídají více souborům.

includeDownloadTickets: boolean

Pokud má includeDownloadTickets hodnotu true a volající má oprávnění, je součástí odpovědi lístek stažení pro každý zabezpečený soubor.

actionFilter: SecureFileActionFilter

Filtrovat podle zabezpečených oprávnění k souborům pro akci Zobrazit, Spravovat nebo Použít. Výchozí hodnota je Zobrazení.

Návraty

Promise<SecureFile[]>

getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)

Získání zabezpečených souborů

function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parametry

project: string

ID projektu nebo název projektu

secureFileIds: string[]

Seznam ID zabezpečených souborů

includeDownloadTickets: boolean

Pokud má includeDownloadTickets hodnotu true a volající má oprávnění, je součástí odpovědi lístek stažení pro každý zabezpečený soubor.

actionFilter: SecureFileActionFilter

Návraty

Promise<SecureFile[]>

getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)

Získání zabezpečených souborů

function getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

Parametry

project: string

ID projektu nebo název projektu

secureFileNames: string[]

Seznam ID zabezpečených souborů

includeDownloadTickets: boolean

Pokud má includeDownloadTickets hodnotu true a volající má oprávnění, je součástí odpovědi lístek stažení pro každý zabezpečený soubor.

actionFilter: SecureFileActionFilter

Návraty

Promise<SecureFile[]>

getTaskContentZip(string, string, string[], boolean)

function getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<ArrayBuffer>

Parametry

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Návraty

Promise<ArrayBuffer>

getTaskDefinition(string, string, string[], boolean)

function getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskDefinition>

Parametry

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Návraty

Promise<TaskDefinition>

getTaskDefinitions(string, string[], boolean, boolean)

function getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskDefinition[]>

Parametry

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Návraty

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Získat skupinu úkolů.

function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

ID skupiny úloh.

versionSpec: string

specifikace verze skupiny úloh. příklady: 1, 1.0.

expand: TaskGroupExpands

Vlastnosti, které by měly být rozbalené. example $expand=Tasks rozbalí vnořené skupiny úloh.

Návraty

Promise<TaskGroup>

getTaskGroupHistory(string, string)

function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

Návraty

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

revision: number

Návraty

Promise<string>

getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)

Vypsat skupiny úkolů.

function getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskGroupQueryOrder): Promise<TaskGroup[]>

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

ID skupiny úloh.

expanded: boolean

Hodnota true pro rekurzivní rozšíření skupin úloh Výchozí hodnota je false.

taskIdFilter: string

Guid id úkolu, který se má filtrovat.

deleted: boolean

"true", pokud chcete zahrnout odstraněné skupiny úloh. Výchozí hodnota je false.

top: number

Počet skupin úkolů, které chcete získat

continuationToken: Date

Získá skupiny úloh po poskytnutém tokenu pokračování.

queryOrder: TaskGroupQueryOrder

Získá výsledky v definovaném pořadí. Výchozí hodnota je CreatedOnDescending.

Návraty

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>

Parametry

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Návraty

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Získání skupiny proměnných

function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>

Parametry

project: string

ID projektu nebo název projektu

groupId: number

ID skupiny proměnných

Návraty

Promise<VariableGroup>

getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)

Získání skupin proměnných

function getVariableGroups(project: string, groupName?: string, actionFilter?: VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: VariableGroupQueryOrder): Promise<VariableGroup[]>

Parametry

project: string

ID projektu nebo název projektu

groupName: string

Název skupiny proměnných.

actionFilter: VariableGroupActionFilter

Filtr akcí pro skupinu proměnných. Určuje akci, kterou lze provést se skupinami proměnných.

top: number

Počet skupin proměnných, které chcete získat.

continuationToken: number

Získá skupiny proměnných po poskytnutém tokenu pokračování.

queryOrder: VariableGroupQueryOrder

Získá výsledky v definovaném pořadí. Výchozí hodnota je IdDescending.

Návraty

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Získání skupin proměnných podle ID

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

Parametry

project: string

ID projektu nebo název projektu

groupIds: number[]

Čárkami oddělený seznam ID skupin proměnných

loadSecrets: boolean

Příznak označující, jestli se mají načíst tajné kódy v rámci skupin proměnných.

Návraty

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

Návraty

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

Parametry

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Návraty

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Návraty

Promise<string>

getYamlSchema(boolean)

ZÍSKEJTE schéma Yaml používané pro ověření souboru Yaml.

function getYamlSchema(validateTaskNames?: boolean): Promise<any>

Parametry

validateTaskNames: boolean

Určuje, jestli má schéma ověřit, že jsou úlohy skutečně nainstalované (užitečné pro offline nástroje, u kterých nechcete ověření).

Návraty

Promise<any>

hasPoolPermissions(number, number)

Zkontroluje, jestli aktuální identita předala oprávnění k fondu.

function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>

Parametry

poolId: number

ID fondu, který chcete zkontrolovat

permissions: number

Oprávnění ke kontrole. Více oprávnění může být sloučeno do jedné hodnoty pomocí bitového operátoru OR (např. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Návraty

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

function publishTaskGroup(taskGroupMetadata: PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskGroup[]>

Parametry

taskGroupMetadata: PublishTaskGroupMetadata

project: string

ID projektu nebo název projektu

parentTaskGroupId: string

Návraty

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proxy pro požadavek GET definovaný koncovým bodem. Žádost je autorizována pomocí připojení služby. Odpověď se filtruje pomocí selektoru založeného na XPath/JSON.

function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>

Parametry

endpoint: TaskDefinitionEndpoint

Popisuje adresu URL, která se má načíst.

Návraty

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Dotazování zabezpečených souborů pomocí vzoru názvů a podmínky pro vlastnosti souboru.

function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>

Parametry

condition: string

Syntaxe hlavní podmínky je popsaná tady. Funkce property('property-name') slouží k přístupu k hodnotě zadané vlastnosti zabezpečeného souboru. Pokud vlastnost není nastavená, vrátí hodnotu null. Např. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

ID projektu nebo název projektu

namePattern: string

Název zabezpečeného souboru, který se má shodovat. Může obsahovat zástupné cardy, které odpovídají více souborům.

Návraty

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>

Parametry

job: TaskAgentPoolMaintenanceJob

poolId: number

Návraty

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>

Parametry

request: TaskAgentJobRequest

project: string

ID projektu nebo název projektu

queueId: number

Návraty

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>

Parametry

request: TaskAgentJobRequest

poolId: number

Návraty

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parametry

poolId: number

agentId: number

Návraty

Promise<void>

refreshAgents(number)

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

Parametry

poolId: number

Návraty

Promise<void>

refreshDeploymentMachines(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

Návraty

Promise<void>

refreshDeploymentTargets(string, number)

Upgradujte cíle nasazení ve skupině nasazení.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení.

Návraty

Promise<void>

replaceAgent(TaskAgent, number, number)

Nahrazení agenta Pravděpodobně nechcete tento koncový bod volat přímo. Místo toho pomocí konfiguračního skriptu agenta odeberte agenta z vaší organizace a překonfigurujte ho.

function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

Parametry

agent: TaskAgent

Aktualizace podrobností o nahrazování agenta

poolId: number

Fond agentů, který se má použít

agentId: number

Agent, který se má nahradit

Návraty

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametry

machine: DeploymentMachine

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineId: number

Návraty

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Nahraďte cíl nasazení ve skupině nasazení. Obecně se nazývá nástroj pro konfiguraci agenta.

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

Parametry

machine: DeploymentMachine

Nový cíl nasazení.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které se cíl nasazení nahrazuje.

targetId: number

ID cíle nasazení, který se má nahradit.

Návraty

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>

Parametry

message: TaskAgentMessage

poolId: number

requestId: number

Návraty

Promise<void>

setAgentPoolMetadata(any, number)

function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>

Parametry

agentPoolMetadata: any

poolId: number

Návraty

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Přidejte skupinu proměnných.

function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>

Parametry

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Návraty

Promise<void>

undeleteTaskGroup(TaskGroup, string)

function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>

Parametry

taskGroup: TaskGroup

project: string

ID projektu nebo název projektu

Návraty

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Podrobnosti o agentu aktualizace

function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

Parametry

agent: TaskAgent

Aktualizace podrobností o agentu

poolId: number

Fond agentů, který se má použít

agentId: number

Agent, který se má aktualizovat

Návraty

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>

Parametry

updatedCloud: TaskAgentCloud

agentCloudId: number

Návraty

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Aktualizace vlastností fondu agentů

function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>

Parametry

pool: TaskAgentPool

Aktualizace podrobností o fondu agentů

poolId: number

Fond agentů, který se má aktualizovat

Návraty

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

Parametry

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Návraty

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

Parametry

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Návraty

Promise<TaskAgentPoolMaintenanceJob>

updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)

function updateAgentRequest(request: TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentRequestUpdateOptions): Promise<TaskAgentJobRequest>

Parametry

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Návraty

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>

Parametry

poolId: number

agentId: number

currentState: string

Návraty

Promise<TaskAgent>

updateAgentUserCapabilities({[key: string]: string}, number, number)

function updateAgentUserCapabilities(userCapabilities: {[key: string]: string}, poolId: number, agentId: number): Promise<TaskAgent>

Parametry

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Návraty

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Aktualizace skupiny nasazení

function updateDeploymentGroup(deploymentGroup: DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<DeploymentGroup>

Parametry

deploymentGroup: DeploymentGroupUpdateParameter

Skupina nasazení, která se má aktualizovat.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení.

Návraty

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametry

machine: DeploymentMachine

project: string

ID projektu nebo název projektu

deploymentGroupId: number

machineId: number

Návraty

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parametry

machineGroup: DeploymentMachineGroup

project: string

ID projektu nebo název projektu

machineGroupId: number

Návraty

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parametry

deploymentMachines: DeploymentMachine[]

project: string

ID projektu nebo název projektu

machineGroupId: number

Návraty

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parametry

machines: DeploymentMachine[]

project: string

ID projektu nebo název projektu

deploymentGroupId: number

Návraty

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Aktualizujte cíl nasazení a jeho vlastnosti agenta ve skupině nasazení. Obecně se nazývá nástroj pro konfiguraci agenta.

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

Parametry

machine: DeploymentMachine

Cíl nasazení, který se má aktualizovat.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které se cíl nasazení aktualizuje.

targetId: number

ID cíle nasazení, který se má aktualizovat.

Návraty

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Aktualizujte značky seznamu cílů nasazení ve skupině nasazení.

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

Parametry

machines: DeploymentTargetUpdateParameter[]

Cíle nasazení se značkami pro udpdate.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které se aktualizují cíle nasazení.

Návraty

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Aktualizujte zadané prostředí.

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

Parametry

environmentUpdateParameter: EnvironmentUpdateParameter

Data prostředí, která se mají aktualizovat.

project: string

ID projektu nebo název projektu

environmentId: number

ID prostředí.

Návraty

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Aktualizace názvu nebo vlastností existujícího zabezpečeného souboru

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

Parametry

secureFile: SecureFile

Zabezpečený soubor s aktualizovaným názvem nebo vlastnostmi

project: string

ID projektu nebo název projektu

secureFileId: string

Jedinečné ID zabezpečeného souboru

Návraty

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Aktualizujte vlastnosti nebo názvy sady zabezpečených souborů. Soubory jsou identifikované podle jejich ID. Zadané vlastnosti zcela přepíší existující vlastnost, tj. nesloučí.

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

Parametry

secureFiles: SecureFile[]

Seznam zabezpečených objektů souborů. Id, Název a Vlastnosti musí být vyplněna pouze tři pole. Zbývající pole v objektu se ignorují.

project: string

ID projektu nebo název projektu

Návraty

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Aktualizace skupiny úloh

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

Parametry

taskGroup: TaskGroupUpdateParameter

Skupina úkolů, kterou chcete aktualizovat.

project: string

ID projektu nebo název projektu

taskGroupId: string

ID skupiny úloh, kterou chcete aktualizovat.

Návraty

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parametry

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

ID projektu nebo název projektu

taskGroupId: string

disablePriorVersions: boolean

Návraty

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>

Parametry

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Návraty

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Aktualizujte skupinu proměnných.

function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>

Parametry

variableGroupParameters: VariableGroupParameters

groupId: number

ID skupiny proměnných, která se má aktualizovat.

Návraty

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parametry

resource: VirtualMachineGroup

project: string

ID projektu nebo název projektu

environmentId: number

Návraty

Promise<VirtualMachineGroup>

updateVirtualMachines(VirtualMachine[], string, number, number)

function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>

Parametry

machines: VirtualMachine[]

project: string

ID projektu nebo název projektu

environmentId: number

resourceId: number

Návraty

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Nahrajte zabezpečený soubor a zahrňte datový proud souboru do textu požadavku.

function uploadSecureFile(content: any, project: string, name: string, authorizePipelines?: boolean): Promise<SecureFile>

Parametry

content: any

Obsah k nahrání

project: string

ID projektu nebo název projektu

name: string

Název souboru k nahrání

authorizePipelines: boolean

Pokud má authorizePipelines hodnotu true, pak je zabezpečený soubor autorizovaný pro použití všemi kanály v projektu.

Návraty

Promise<SecureFile>

validateInputs(InputValidationRequest)

function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>

Parametry

inputValidationRequest: InputValidationRequest

Návraty

Promise<InputValidationRequest>

Sdílet prostřednictvím

TaskAgentRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

TaskAgentRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

addAgent(TaskAgent, number)

Parametry

Návraty

addAgentCloud(TaskAgentCloud)

Parametry

Návraty

addAgentPool(TaskAgentPool)

Parametry

Návraty

addAgentQueue(TaskAgentQueue, string, boolean)

Parametry

Návraty

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parametry

Návraty

addDeploymentMachine(DeploymentMachine, string, number)

Parametry

Návraty

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parametry

Návraty

addDeploymentTarget(DeploymentMachine, string, number)

Parametry

Návraty

addEnvironment(EnvironmentCreateParameter, string)

Parametry

Návraty

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parametry

Návraty

addTaskGroup(TaskGroupCreateParameter, string)

Parametry

Návraty

addVariableGroup(VariableGroupParameters)

Parametry

Návraty

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parametry

Návraty

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

Parametry

Návraty

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parametry

Návraty

createAgentSession(TaskAgentSession, number)

Parametry

Návraty

createTeamProject(string)

Parametry

Návraty

deleteAgent(number, number)

Parametry

Návraty

deleteAgentCloud(number)

Parametry

Návraty

deleteAgentPool(number)

Parametry

Návraty

deleteAgentPoolMaintenanceDefinition(number, number)

Parametry

Návraty

deleteAgentPoolMaintenanceJob(number, number)

Parametry

Návraty

deleteAgentQueue(number, string)

Parametry