TaskAgentRestClient class

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

Konstruktory

TaskAgentRestClient(IVssRestClientOptions)

Vlastnosti

Metody

addAgent(TaskAgent, number)	Přidá agenta do fondu. Pravděpodobně nechcete volat tento koncový bod přímo. Místo toho nakonfigurovat agenta pomocí balíčku pro stažení agenta.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Vytvořte skupinu agentů.
addAgentQueue(TaskAgentQueue, string, boolean)	Vytvořte novou frontu agentů pro propojení projektu s agentním poolem.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Vytvořte skupinu nasazení.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Zaregistrujte cíl nasazení do skupiny nasazení. Obecně se tomu říká nástroj pro konfiguraci agentů.
addEnvironment(EnvironmentCreateParameter, string)	Vytvořte prostředí.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Vytvořte pracovní skupinu.
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)	Vytvořte nový týmový projekt.
deleteAgent(number, number)	Odstranění agenta Pravděpodobně nechcete volat tento koncový bod přímo. Místo toho použijte skript pro konfiguraci agenta k odstranění agenta z vaší organizace.
deleteAgentCloud(number)
deleteAgentPool(number)	Odstraňte fond agentů.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Odstraní frontu agentů z projektu.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Smažte skupinu nasazení.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Smažte cíl nasazení ve skupině nasazení. Tím se agent také smaže z přidruženého deployment poolu.
deleteEnvironment(string, number)	Smaž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)	Smažte task group.
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 PAT token pro správu (konfigurace, odstraňování, tagování) cílů nasazení ve skupině nasazení.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	ZÍSKEJTE PAT token pro správu (konfigurace, odstraňování, označování) nasazovacích agentů v rámci nasazení.
getAgent(number, number, boolean, boolean, boolean, string[])	Získejte informace o agentu.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Získejte typy agentů cloud.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Získejte informace o agentském poolu.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Získejte seznam agentů.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Získejte seznam agentů.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Získejte informace o frontě agentů.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Získejte seznam fronty agentů.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Získejte seznam fronty agentů podle jejich ID
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Získejte seznam fronty agentů podle jejich jmen
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Získejte seznam fronty agentů podle ID poolu
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ískejte žádosti agentů o cíl nasazení.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Získejte žádosti agentů o 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ácení seznamu předplatného Azure
getAzureSubscriptions()	Vrácení seznamu předplatného Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Získejte skupinu nasazení podle 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 skupin 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ů 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ískejte seznam cílů nasazení ve skupině nasazení.
getEnvironmentById(string, number, EnvironmentExpands)	Získejte prostředí podle jeho ID.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Získejte historii provádě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ískejte pracovní skupinu.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Vyjmenujte pracovní skupiny.
getTaskGroupsByIds({[key: string]: string[]}, string, boolean)	Získejte task groups podle jejich ID a specifikací verzí.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Získejte proměnnou skupinu.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Získejte variabilní skupiny.
getVariableGroupsById(string, number[], boolean)	Získejte skupiny proměnných podle ID.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	ZÍSKEJTE Yaml schéma používané pro validaci Yaml souborů.
hasPoolPermissions(number, number)	Kontroluje, zda aktuální identita předala oprávnění na poolu.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proxy pro GET požadavek definovaný "endpointem". Požadavek je autorizován pomocí servisního připojení. Odpověď se filtruje pomocí selektoru založeného na XPathu nebo Json.
querySecureFilesByProperties(string, string, string)	Dotazování zabezpečených souborů pomocí vzoru názvu a podmínky vlastností souboru
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Vylepšujte cíle nasazení ve skupině nasazení.
replaceAgent(TaskAgent, number, number)	Nahraďte agenta. Pravděpodobně nechcete volat tento koncový bod přímo. Místo toho použít konfigurační skript agenta k odebrání a změně konfigurace agenta z vaší organizace.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Nahraďte cíl nasazení ve skupině nasazení. Obecně se tomu říká nástroj pro konfiguraci agentů.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Přidejte skupinu proměnných.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Aktualizace podrobností agenta
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aktualizace vlastností v agentní skupině
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)	Aktualizujte skupinu 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 tomu říká nástroj pro konfiguraci agentů.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Aktualizujte značky seznamu cílů nasazení ve skupině nasazení.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Aktualizujte specifikované prostředí.
updateQueueRestrictedImageLabels(TaskAgentQueueRestrictions, string, number)	Aktualizujte omezené štítky obrázků pro frontu agentů.
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é jejich ID. Zadané vlastnosti přepíší existující zcela, tj. nesloučit.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Aktualizujte pracovní skupinu.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Aktualizace skupiny proměnných
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Nahrání zabezpečeného souboru, zahrnutí streamu souboru do textu požadavku
validateInputs(InputValidationRequest)

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd" = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

Hodnota vlastnosti

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

addAgent(TaskAgent, number)

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

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

Parametry

agent: TaskAgent

Podrobnosti o agentovi, který je přidáván

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)

Vytvořte skupinu agentů.

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

Parametry

pool: TaskAgentPool

Podrobnosti o nové agentské skupině

Návraty

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Vytvořte novou frontu agentů pro propojení projektu s agentním poolem.

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

Parametry

queue: TaskAgentQueue

Podrobnosti o frontě k vytvoření

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)

Vytvořte skupinu nasazení.

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

Parametry

deploymentGroup: DeploymentGroupCreateParameter

Skupina nasazení k vytvoření.

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)

Zaregistrujte cíl nasazení do skupiny nasazení. Obecně se tomu říká nástroj pro konfiguraci agentů.

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

Parametry

machine: DeploymentMachine

Cíl nasazení se registruje.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, do které je cíl nasazení registrován.

Návraty

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Vytvořte prostředí.

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

Parametry

environmentCreateParameter: EnvironmentCreateParameter

Prostředí k tvorbě.

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)

Vytvořte pracovní skupinu.

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

Parametry

taskGroup: TaskGroupCreateParameter

Objekt skupiny úloh pro vytvoření.

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)

Vytvořte 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 volat tento koncový bod přímo. Místo toho použijte skript pro konfiguraci agenta k odstranění agenta z vaší organizace.

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

Parametry

poolId: number

ID poolu pro odstranění agenta

agentId: number

Identifikace agenta k odstranění

Návraty

Promise<void>

deleteAgentCloud(number)

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

Parametry

agentCloudId: number

Návraty

Promise<TaskAgentCloud>

deleteAgentPool(number)

Odstraňte fond agentů.

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

Parametry

poolId: number

ID agentního poolu k odstranění

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)

Odstraní frontu agentů z projektu.

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

Parametry

queueId: number

Fronta agentů pro odstranění

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)

Smažte skupinu nasazení.

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

Parametry

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, která má být smazána.

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)

Smažte cíl nasazení ve skupině nasazení. Tím se agent také smaže z přidruženého deployment poolu.

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í smazán.

targetId: number

ID cíle nasazení ke smazání.

Návraty

Promise<void>

deleteEnvironment(string, number)

Smaž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)

Smažte task group.

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

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

ID úkolové skupiny, která má být smazána.

comment: string

Komentáře ke smazání.

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 je stahování pravdivé, soubor se odešle jako attachement v textu odpovědi. Pokud je stahování false, text odpovědi obsahuje datový proud souboru.

Návraty

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

ZÍSKEJTE PAT token pro správu (konfigurace, odstraňování, tagová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é jsou spravovány 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 PAT token pro správu (konfigurace, odstraňování, označování) nasazovacích agentů v rámci nasazení.

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

Parametry

poolId: number

ID poolu nasazení, ve kterém jsou spravováni agenti nasazení.

Návraty

Promise<string>

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

Získejte informace o agentu.

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

Parametry

poolId: number

Fond agentů obsahujícího agenta

agentId: number

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

includeCapabilities: boolean

Zda zahrnout možnosti agenta do odpovědi

includeAssignedRequest: boolean

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

includeLastCompletedRequest: boolean

Zda zahrnout podrobnosti o nejnovější dokončené práci agentů

propertyFilters: string[]

Filtrování, které vlastní vlastnosti 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 agentů cloud.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Návraty

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Získejte informace o agentském poolu.

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

Parametry

poolId: number

ID agentní skupiny

properties: string[]

Vlastnosti agentního poolu (oddělené čárkou)

actionFilter: TaskAgentPoolActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

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 agentů.

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

Parametry

poolName: string

Filtrovat podle názvu

properties: string[]

Filtr podle vlastností agentního poolu (oddělený čárkou)

poolType: TaskAgentPoolType

Filtr podle typu bazénu

actionFilter: TaskAgentPoolActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Získejte seznam agentů.

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

Parametry

poolIds: number[]

pool Ids pro načtení

actionFilter: TaskAgentPoolActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Získejte informace o frontě agentů.

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

Parametry

queueId: number

Fronta agentů pro získání informací o

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Získejte seznam fronty agentů.

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

Parametry

project: string

ID projektu nebo název projektu

queueName: string

Filtr na jméno fronty agenta

actionFilter: TaskAgentQueueActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Získejte seznam fronty agentů podle jejich ID

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

Parametry

queueIds: number[]

Seznam ID fronty agentů oddělený čárkami pro získání

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Získejte seznam fronty agentů podle jejich jmen

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

Parametry

queueNames: string[]

Seznam jmen agentů oddělený čárkou

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

Návraty

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Získejte seznam fronty agentů podle ID poolu

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

Parametry

poolIds: number[]

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

project: string

ID projektu nebo název projektu

actionFilter: TaskAgentQueueActionFilter

Filtrujte podle toho, zda volající uživatel má oprávnění používat nebo spravovat

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ískejte žádosti agentů o 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 požadavků k vrácení. Výchozí hodnota je 50

Návraty

Promise<TaskAgentJobRequest[]>

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

Získejte žádosti agentů o 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[]

Seznam ID cílů nasazení rozdělený čárkou.

ownerId: number

ID žádosti o práci majitele agenta.

completedOn: Date

Datum pro vrácení žádosti po tomto čase.

completedRequestCount: number

Maximální počet dokončených požadavků 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 zahrnout možnosti agentů do odpovědi

includeAssignedRequest: boolean

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

includeLastCompletedRequest: boolean

Zda zahrnout podrobnosti o nejnovější dokončené práci agentů

propertyFilters: string[]

Filtrování, které vlastní vlastnosti se vrátí

demands: string[]

Filtrování podle požadavků, které mohou agenti splnit

Návraty

Promise<TaskAgent[]>

getAzureManagementGroups()

Vrácení seznamu předplatného Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Návraty

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Vrácení seznamu předplatného Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Návraty

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Získejte skupinu nasazení podle 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

Získejte skupinu nasazení jenom v případě, že s ní lze provést tuto akci.

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í, pro které lze 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ž tato lexicografická lexika.

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 skupin 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 continuationToken lexikograficky.

top: number

Maximální počet metrik skupin nasazení, které je třeba 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ů nasazení.

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

Parametry

poolName: string

Název poolu nasazení.

expands: DeploymentPoolSummaryExpands

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

poolIds: number[]

Seznam ID nasadovacích poolů.

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é cíl nasazení patří.

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ískejte seznam 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 separted seznam značek.

name: string

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

partialNameMatch: boolean

Pokud je nastavená hodnota true, považuje název jako se vzorem. Jinak 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í tento poslední výsledek úlohy.

continuationToken: string

Získejte cíle nasazení s názvy většími než tato lexikografická funkceToken.

top: number

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

enabled: boolean

Získejte pouze 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ískejte historii provádě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 je argument includeDownloadTicket pravdivý a volající má oprávnění, do odpovědi se zahrne lístek pro 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é kóty, které odpovídají více souborům.

includeDownloadTickets: boolean

Pokud je argument includeDownloadTickets pravdivý a volající má oprávnění, do odpovědi se zahrne lístek stahování pro každý zabezpečený soubor.

actionFilter: SecureFileActionFilter

Umožňuje filtrovat podle zabezpečených oprávnění k souborům pro akci Zobrazení, 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 zabezpečených ID souborů

includeDownloadTickets: boolean

Pokud je argument includeDownloadTickets pravdivý a volající má oprávnění, do odpovědi se zahrne lístek stahování 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 zabezpečených ID souborů

includeDownloadTickets: boolean

Pokud je argument includeDownloadTickets pravdivý a volající má oprávnění, do odpovědi se zahrne lístek stahování 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ískejte pracovní skupinu.

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

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

ID pracovní skupiny.

versionSpec: string

specifikace verze taskgroup. Příklady: 1, 1.0.

expand: TaskGroupExpands

Vlastnosti, které by měly být rozšířeny. příklad $expand=Úkoly rozšíří 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)

Vyjmenujte pracovní skupiny.

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 pracovní skupiny.

expanded: boolean

'pravda' rekurzivně rozšiřuje úkolové skupiny. Výchozí hodnota je false.

taskIdFilter: string

Guid taskId pro filtrování.

deleted: boolean

'true' zahrnuje i smazané úkolové skupiny. Výchozí hodnota je false.

top: number

Počet úkolových skupin k získání.

continuationToken: Date

Skupiny úkolů získá po poskytnutém tokenu pokračování.

queryOrder: TaskGroupQueryOrder

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

Návraty

Promise<TaskGroup[]>

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

Získejte task groups podle jejich ID a specifikací verzí.

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

Parametry

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

Skupinové ID na mapování verzí.

project: string

ID projektu nebo název projektu

expand: boolean

Vlastnosti, které by měly být rozšířeny. příklad $expand=Úkoly rozšíří vnořené skupiny úloh.

Návraty

Promise<{[key: string]: 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ískejte proměnnou skupinu.

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ískejte variabilní skupiny.

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 u skupin 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 pro pokračování.

queryOrder: VariableGroupQueryOrder

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

Návraty

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Získejte skupiny 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[]

Seznam Id proměnných oddělený čárkou.

loadSecrets: boolean

Příznak označující, zda by měla být načtena tajemství 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 Yaml schéma používané pro validaci Yaml souborů.

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

Parametry

validateTaskNames: boolean

Zda by schéma mělo ověřovat, že úkoly jsou skutečně nainstalované (užitečné pro offline nástroje, kde nechcete validaci).

Návraty

Promise<any>

hasPoolPermissions(number, number)

Kontroluje, zda aktuální identita předala oprávnění na poolu.

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

Parametry

poolId: number

Identifikaci bazénu k ověření

permissions: number

Oprávnění ke kontrole. Více oprávnění lze sloučit do jedné hodnoty pomocí bitově zdatné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 GET požadavek definovaný "endpointem". Požadavek je autorizován pomocí servisního připojení. Odpověď se filtruje pomocí selektoru založeného na XPathu nebo Json.

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

Parametry

endpoint: TaskDefinitionEndpoint

Popisuje URL, kterou je třeba načítat.

Návraty

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Dotazování zabezpečených souborů pomocí vzoru názvu a podmínky vlastností souboru

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

Parametry

condition: string

Tady je popsaná syntaxe hlavní podmínky. Pomocí funkce property('property-name') získejte přístup 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é kóty, 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)

Vylepšujte 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)

Nahraďte agenta. Pravděpodobně nechcete volat tento koncový bod přímo. Místo toho použít konfigurační skript agenta k odebrání a změně konfigurace agenta z vaší organizace.

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

Parametry

agent: TaskAgent

Aktualizované informace o náhradním agentu

poolId: number

Pool 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 tomu říká nástroj pro konfiguraci agentů.

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é je cíl nasazení nahrazen.

targetId: number

ID nasazeného cíle k nahrazení.

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)

Aktualizace podrobností agenta

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

Parametry

agent: TaskAgent

Aktuální informace o agentovi

poolId: number

Pool 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í v agentní skupině

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

Parametry

pool: TaskAgentPool

Aktualizované podrobnosti o agentském poolu

poolId: number

Agent pool k aktualizaci

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)

Aktualizujte skupinu nasazení.

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

Parametry

deploymentGroup: DeploymentGroupUpdateParameter

Skupina nasazení pro aktualizaci.

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 tomu říká nástroj pro konfiguraci agentů.

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

Parametry

machine: DeploymentMachine

Cíl nasazení bude aktualizován.

project: string

ID projektu nebo název projektu

deploymentGroupId: number

ID skupiny nasazení, ve které je aktualizován cíl nasazení.

targetId: number

ID cíle nasazení k aktualizaci.

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 specifikované prostředí.

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

Parametry

environmentUpdateParameter: EnvironmentUpdateParameter

Data prostředí k aktualizaci.

project: string

ID projektu nebo název projektu

environmentId: number

ID prostředí.

Návraty

Promise<EnvironmentInstance>

updateQueueRestrictedImageLabels(TaskAgentQueueRestrictions, string, number)

Aktualizujte omezené štítky obrázků pro frontu agentů.

function updateQueueRestrictedImageLabels(restriction: TaskAgentQueueRestrictions, project: string, queueId: number): Promise<TaskAgentQueueRestrictions>

Parametry

restriction: TaskAgentQueueRestrictions

Obal omezených obrazových štítků

project: string

ID projektu nebo název projektu

queueId: number

Fronta agentů pro aktualizaci

Návraty

Promise<TaskAgentQueueRestrictions>

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 a/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é jejich ID. Zadané vlastnosti přepíší existující zcela, tj. nesloučit.

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ěno 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)

Aktualizujte pracovní skupinu.

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

Parametry

taskGroup: TaskGroupUpdateParameter

Pracovní skupina pro aktualizaci.

project: string

ID projektu nebo název projektu

taskGroupId: string

ID pracovní skupiny k aktualizaci.

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)

Aktualizace skupiny proměnných

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

Parametry

variableGroupParameters: VariableGroupParameters

groupId: number

ID skupiny proměnných k aktualizaci.

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)

Nahrání zabezpečeného souboru, zahrnutí streamu 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, který se má nahrát

authorizePipelines: boolean

Pokud je hodnota authorizePipelines pravdivá, 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>

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

Návraty