TaskAgentRestClient class

Referensi

Paket:: azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Extends: RestClientBase

Konstruktor

TaskAgentRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

addAgent(TaskAgent, number)	Menambahkan agen ke kumpulan. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, konfigurasikan agen menggunakan paket unduhan agen.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create kumpulan agen.
addAgentQueue(TaskAgentQueue, string, boolean)	Create antrean agen baru untuk menyambungkan proyek ke kumpulan agen.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create grup penyebaran.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Daftarkan target penyebaran ke grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.
addEnvironment(EnvironmentCreateParameter, string)	Create lingkungan.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create grup tugas.
addVariableGroup(VariableGroupParameters)	Tambahkan grup variabel.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create proyek tim baru.
deleteAgent(number, number)	Menghapus agen. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, gunakan skrip konfigurasi agen untuk menghapus agen dari organisasi Anda.
deleteAgentCloud(number)
deleteAgentPool(number)	Menghapus kumpulan agen.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Menghapus antrean agen dari proyek.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Menghapus grup penyebaran.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Menghapus target penyebaran dalam grup penyebaran. Ini juga menghapus agen dari kumpulan penyebaran terkait.
deleteEnvironment(string, number)	Hapus lingkungan yang ditentukan.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Menghapus file aman
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Menghapus grup tugas.
deleteVariableGroup(number, string[])	Menghapus grup variabel
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Mengunduh file aman menurut Id
generateDeploymentGroupAccessToken(string, number)	DAPATKAN token PAT untuk mengelola (mengonfigurasi, menghapus, menandai) target penyebaran dalam grup penyebaran.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	DAPATKAN token PAT untuk mengelola (mengonfigurasi, menghapus, menandai) agen penyebaran di kumpulan penyebaran.
getAgent(number, number, boolean, boolean, boolean, string[])	Dapatkan informasi tentang agen.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Mendapatkan jenis cloud agen.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Dapatkan informasi tentang kumpulan agen.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Dapatkan daftar kumpulan agen.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Dapatkan daftar kumpulan agen.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Dapatkan informasi tentang antrean agen.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Dapatkan daftar antrean agen.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Mendapatkan daftar antrean agen berdasarkan ID mereka
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Mendapatkan daftar antrean agen berdasarkan namanya
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Mendapatkan daftar antrean agen menurut id kumpulan
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)	Mendapatkan permintaan agen untuk target penyebaran.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Mendapatkan permintaan agen untuk target penyebaran daftar.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Dapatkan daftar agen.
getAzureManagementGroups()	Mengembalikan daftar langganan azure
getAzureSubscriptions()	Mengembalikan daftar langganan azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Dapatkan grup penyebaran berdasarkan ID-nya.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Dapatkan daftar grup penyebaran berdasarkan nama atau ID.
getDeploymentGroupsMetrics(string, string, string, number)	Mendapatkan daftar metrik grup penyebaran.
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[])	Dapatkan daftar ringkasan kumpulan penyebaran.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Mendapatkan target penyebaran berdasarkan ID-nya dalam grup penyebaran
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Dapatkan daftar target penyebaran dalam grup penyebaran.
getEnvironmentById(string, number, EnvironmentExpands)	Dapatkan lingkungan dengan ID-nya.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Mendapatkan riwayat eksekusi penyebaran lingkungan
getEnvironments(string, string, string, number)	Dapatkan semua lingkungan.
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)	Mendapatkan file aman
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Mendapatkan file aman
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Mendapatkan file aman
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Mendapatkan file aman
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Dapatkan grup tugas.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Mencantumkan grup tugas.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Dapatkan grup variabel.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Mendapatkan grup variabel.
getVariableGroupsById(string, number[], boolean)	Mendapatkan grup variabel menurut id.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	DAPATKAN skema Yaml yang digunakan untuk validasi file Yaml.
hasPoolPermissions(number, number)	Memeriksa apakah identitas saat ini telah meneruskan izin pada kumpulan.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Proksi untuk permintaan GET yang ditentukan oleh 'titik akhir'. Permintaan diotorisasi menggunakan koneksi layanan. Respons difilter menggunakan pemilih berbasis JalurX/Json.
querySecureFilesByProperties(string, string, string)	Kueri file aman menggunakan pola nama dan kondisi pada properti file.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Tingkatkan target penyebaran dalam grup penyebaran.
replaceAgent(TaskAgent, number, number)	Ganti agen. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, gunakan skrip konfigurasi agen untuk menghapus dan mengonfigurasi ulang agen dari organisasi Anda.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Ganti target penyebaran dalam grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Tambahkan grup variabel.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Perbarui detail agen.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Memperbarui properti pada kumpulan agen
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)	Memperbarui grup penyebaran.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Memperbarui target penyebaran dan properti agennya dalam grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Memperbarui tag daftar target penyebaran dalam grup penyebaran.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Perbarui lingkungan yang ditentukan.
updateSecureFile(SecureFile, string, string)	Memperbarui nama atau properti file aman yang ada
updateSecureFiles(SecureFile[], string)	Perbarui properti dan/atau nama sekumpulan file aman. File diidentifikasi oleh ID mereka. Properti yang disediakan mengambil alih properti yang ada sepenuhnya, yaitu jangan gabungkan.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Memperbarui grup tugas.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Memperbarui grup variabel.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Unggah file aman, sertakan aliran file dalam isi permintaan
validateInputs(InputValidationRequest)

Detail Konstruktor

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addAgent(TaskAgent, number)

Menambahkan agen ke kumpulan. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, konfigurasikan agen menggunakan paket unduhan agen.

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

Parameter

agent: TaskAgent

Detail tentang agen yang ditambahkan

poolId: number

Kumpulan agen untuk menambahkan agen

Mengembalikan

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parameter

agentCloud: TaskAgentCloud

Mengembalikan

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create kumpulan agen.

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

Parameter

pool: TaskAgentPool

Detail tentang kumpulan agen baru

Mengembalikan

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create antrean agen baru untuk menyambungkan proyek ke kumpulan agen.

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

Parameter

queue: TaskAgentQueue

Detail tentang antrean yang akan dibuat

project: string

ID proyek atau nama proyek

authorizePipelines: boolean

Otorisasi antrean ini secara otomatis saat menggunakan YAML

Mengembalikan

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create grup penyebaran.

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

Parameter

deploymentGroup: DeploymentGroupCreateParameter

Grup penyebaran untuk dibuat.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parameter

machine: DeploymentMachine

project: string

ID proyek atau nama proyek

deploymentGroupId: number

Mengembalikan

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parameter

machineGroup: DeploymentMachineGroup

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Daftarkan target penyebaran ke grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.

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

Parameter

machine: DeploymentMachine

Target penyebaran untuk mendaftar.

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran didaftarkan.

Mengembalikan

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Create lingkungan.

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

Parameter

environmentCreateParameter: EnvironmentCreateParameter

Lingkungan untuk dibuat.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parameter

createParameters: KubernetesResourceCreateParameters

project: string

ID proyek atau nama proyek

environmentId: number

Mengembalikan

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create grup tugas.

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

Parameter

taskGroup: TaskGroupCreateParameter

Objek grup tugas yang akan dibuat.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Tambahkan grup variabel.

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

Parameter

variableGroupParameters: VariableGroupParameters

Mengembalikan

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parameter

createParameters: VirtualMachineGroupCreateParameters

project: string

ID proyek atau nama proyek

environmentId: number

Mengembalikan

Promise<VirtualMachineGroup>

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

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

Parameter

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Mengembalikan

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parameter

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parameter

session: TaskAgentSession

poolId: number

Mengembalikan

Promise<TaskAgentSession>

createTeamProject(string)

Create proyek tim baru.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

deleteAgent(number, number)

Menghapus agen. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, gunakan skrip konfigurasi agen untuk menghapus agen dari organisasi Anda.

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

Parameter

poolId: number

ID kumpulan untuk menghapus agen dari

agentId: number

ID agen yang akan dihapus

Mengembalikan

Promise<void>

deleteAgentCloud(number)

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

Parameter

agentCloudId: number

Mengembalikan

Promise<TaskAgentCloud>

deleteAgentPool(number)

Menghapus kumpulan agen.

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

Parameter

poolId: number

ID kumpulan agen yang akan dihapus

Mengembalikan

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parameter

poolId: number

definitionId: number

Mengembalikan

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parameter

poolId: number

jobId: number

Mengembalikan

Promise<void>

deleteAgentQueue(number, string)

Menghapus antrean agen dari proyek.

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

Parameter

queueId: number

Antrean agen yang akan dihapus

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

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

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

Parameter

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Mengembalikan

Promise<void>

deleteAgentSession(number, string)

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

Parameter

poolId: number

sessionId: string

Mengembalikan

Promise<void>

deleteDeploymentGroup(string, number)

Menghapus grup penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran yang akan dihapus.

Mengembalikan

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineId: number

Mengembalikan

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parameter

project: string

ID proyek atau nama proyek

machineGroupId: number

Mengembalikan

Promise<void>

deleteDeploymentTarget(string, number, number)

Menghapus target penyebaran dalam grup penyebaran. Ini juga menghapus agen dari kumpulan penyebaran terkait.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran dihapus.

targetId: number

ID target penyebaran yang akan dihapus.

Mengembalikan

Promise<void>

deleteEnvironment(string, number)

Hapus lingkungan yang ditentukan.

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

ID lingkungan.

Mengembalikan

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

Mengembalikan

Promise<void>

deleteMessage(number, number, string)

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

Parameter

poolId: number

messageId: number

sessionId: string

Mengembalikan

Promise<void>

deleteSecureFile(string, string)

Menghapus file aman

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

Parameter

project: string

ID proyek atau nama proyek

secureFileId: string

Id file aman yang unik

Mengembalikan

Promise<void>

deleteTaskDefinition(string)

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

Parameter

taskId: string

Mengembalikan

Promise<void>

deleteTaskGroup(string, string, string)

Menghapus grup tugas.

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

Parameter

project: string

ID proyek atau nama proyek

taskGroupId: string

Id grup tugas yang akan dihapus.

comment: string

Komentar yang akan dihapus.

Mengembalikan

Promise<void>

deleteVariableGroup(number, string[])

Menghapus grup variabel

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

Parameter

groupId: number

Id grup variabel.

projectIds: string[]

Mengembalikan

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

Mengembalikan

Promise<void>

downloadSecureFile(string, string, string, boolean)

Mengunduh file aman menurut Id

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

Parameter

project: string

ID proyek atau nama proyek

secureFileId: string

Id file aman yang unik

ticket: string

Tiket unduhan yang valid

download: boolean

Jika unduhan benar, file dikirim sebagai lampiran dalam isi respons. Jika unduhan salah, isi respons berisi aliran file.

Mengembalikan

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

DAPATKAN token PAT untuk mengelola (mengonfigurasi, menghapus, menandai) target penyebaran dalam grup penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran dikelola.

Mengembalikan

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parameter

project: string

ID proyek atau nama proyek

machineGroupId: number

Mengembalikan

Promise<string>

generateDeploymentPoolAccessToken(number)

DAPATKAN token PAT untuk mengelola (mengonfigurasi, menghapus, menandai) agen penyebaran di kumpulan penyebaran.

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

Parameter

poolId: number

ID kumpulan penyebaran tempat agen penyebaran dikelola.

Mengembalikan

Promise<string>

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

Dapatkan informasi tentang agen.

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

Parameter

poolId: number

Kumpulan agen yang berisi agen

agentId: number

ID agen untuk mendapatkan informasi tentang

includeCapabilities: boolean

Apakah akan menyertakan kemampuan agen dalam respons

includeAssignedRequest: boolean

Apakah akan menyertakan detail tentang pekerjaan agen saat ini

includeLastCompletedRequest: boolean

Apakah akan menyertakan detail tentang pekerjaan agen yang terakhir selesai

propertyFilters: string[]

Filter properti kustom mana yang akan dikembalikan

Mengembalikan

Promise<TaskAgent>

getAgentCloud(number)

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

Parameter

agentCloudId: number

Mengembalikan

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parameter

agentCloudId: number

Mengembalikan

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Mengembalikan

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Mendapatkan jenis cloud agen.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Mengembalikan

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Dapatkan informasi tentang kumpulan agen.

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

Parameter

poolId: number

ID kumpulan agen

properties: string[]

Properti kumpulan agen (dipisahkan koma)

actionFilter: TaskAgentPoolActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parameter

poolId: number

definitionId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parameter

poolId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parameter

poolId: number

jobId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parameter

poolId: number

jobId: number

Mengembalikan

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parameter

poolId: number

definitionId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parameter

poolId: number

Mengembalikan

Promise<string>

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

Dapatkan daftar kumpulan agen.

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

Parameter

poolName: string

Filter berdasarkan nama

properties: string[]

Filter menurut properti kumpulan agen (dipisahkan koma)

poolType: TaskAgentPoolType

Filter menurut jenis kumpulan

actionFilter: TaskAgentPoolActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Dapatkan daftar kumpulan agen.

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

Parameter

poolIds: number[]

id kumpulan untuk diambil

actionFilter: TaskAgentPoolActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Dapatkan informasi tentang antrean agen.

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

Parameter

queueId: number

Antrean agen untuk mendapatkan informasi tentang

project: string

ID proyek atau nama proyek

actionFilter: TaskAgentQueueActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Dapatkan daftar antrean agen.

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

Parameter

project: string

ID proyek atau nama proyek

queueName: string

Filter pada nama antrean agen

actionFilter: TaskAgentQueueActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Mendapatkan daftar antrean agen berdasarkan ID mereka

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

Parameter

queueIds: number[]

Daftar ID antrean agen yang dipisahkan koma untuk diambil

project: string

ID proyek atau nama proyek

actionFilter: TaskAgentQueueActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Mendapatkan daftar antrean agen berdasarkan namanya

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

Parameter

queueNames: string[]

Daftar nama agen yang dipisahkan koma untuk diambil

project: string

ID proyek atau nama proyek

actionFilter: TaskAgentQueueActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Mendapatkan daftar antrean agen menurut id kumpulan

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

Parameter

poolIds: number[]

Daftar id kumpulan yang dipisahkan koma untuk mendapatkan antrean yang sesuai untuk

project: string

ID proyek atau nama proyek

actionFilter: TaskAgentQueueActionFilter

Filter berdasarkan apakah pengguna panggilan telah menggunakan atau mengelola izin

Mengembalikan

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parameter

poolId: number

requestId: number

includeStatus: boolean

Mengembalikan

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parameter

poolId: number

top: number

continuationToken: string

Mengembalikan

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parameter

poolId: number

agentId: number

completedRequestCount: number

Mengembalikan

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parameter

poolId: number

agentIds: number[]

completedRequestCount: number

Mengembalikan

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineId: number

completedRequestCount: number

Mengembalikan

Promise<TaskAgentJobRequest[]>

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

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Mengembalikan

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Mendapatkan permintaan agen untuk target penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target berada.

targetId: number

ID target penyebaran.

completedRequestCount: number

Jumlah maksimum permintaan yang diselesaikan untuk dikembalikan. Defaultnya adalah 50

Mengembalikan

Promise<TaskAgentJobRequest[]>

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

Mendapatkan permintaan agen untuk target penyebaran daftar.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target berada.

targetIds: number[]

Daftar ID target penyebaran yang dipisahkan koma.

ownerId: number

Id pemilik permintaan pekerjaan agen.

completedOn: Date

Tanggalwaktu untuk mengembalikan permintaan setelah waktu ini.

completedRequestCount: number

Jumlah maksimum permintaan yang diselesaikan untuk dikembalikan untuk setiap target. Defaultnya adalah 50

Mengembalikan

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parameter

poolId: number

planId: string

jobId: string

Mengembalikan

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parameter

project: string

ID proyek atau nama proyek

queueId: number

top: number

continuationToken: string

Mengembalikan

Promise<PagedList<TaskAgentJobRequest>>

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

Dapatkan daftar agen.

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

Parameter

poolId: number

Kumpulan agen yang berisi agen

agentName: string

Filter pada nama agen

includeCapabilities: boolean

Apakah akan menyertakan kemampuan agen dalam respons

includeAssignedRequest: boolean

Apakah akan menyertakan detail tentang pekerjaan agen saat ini

includeLastCompletedRequest: boolean

Apakah akan menyertakan detail tentang pekerjaan agen yang terakhir selesai

propertyFilters: string[]

Filter properti kustom mana yang akan dikembalikan

demands: string[]

Filter menurut permintaan yang dapat dipenuhi agen

Mengembalikan

Promise<TaskAgent[]>

getAzureManagementGroups()

Mengembalikan daftar langganan azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Mengembalikan

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Mengembalikan daftar langganan azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Mengembalikan

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Dapatkan grup penyebaran berdasarkan ID-nya.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran.

actionFilter: DeploymentGroupActionFilter

Dapatkan grup penyebaran hanya jika tindakan ini dapat dilakukan di atasnya.

expand: DeploymentGroupExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

Mengembalikan

Promise<DeploymentGroup>

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

Dapatkan daftar grup penyebaran berdasarkan nama atau ID.

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

Parameter

project: string

ID proyek atau nama proyek

name: string

Nama grup penyebaran.

actionFilter: DeploymentGroupActionFilter

Hanya dapatkan grup penyebaran tempat tindakan ini dapat dilakukan.

expand: DeploymentGroupExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

continuationToken: string

Dapatkan grup penyebaran dengan nama yang lebih besar dari leksikografis continuationToken ini.

top: number

Jumlah maksimum grup penyebaran yang akan dikembalikan. Defaultnya adalah 1000.

ids: number[]

Daftar ID grup penyebaran yang dipisahkan koma.

Mengembalikan

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Mendapatkan daftar metrik grup penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupName: string

Nama grup penyebaran.

continuationToken: string

Dapatkan metrik untuk grup penyebaran dengan nama yang lebih besar dari continuationToken ini secara leksikografis.

top: number

Jumlah maksimum metrik grup penyebaran yang akan dikembalikan. Defaultnya adalah 50.

Mengembalikan

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Mengembalikan

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parameter

project: string

ID proyek atau nama proyek

machineGroupId: number

actionFilter: MachineGroupActionFilter

Mengembalikan

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parameter

project: string

ID proyek atau nama proyek

machineGroupId: number

tagFilters: string[]

Mengembalikan

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parameter

project: string

ID proyek atau nama proyek

machineGroupName: string

actionFilter: MachineGroupActionFilter

Mengembalikan

Promise<DeploymentMachineGroup[]>

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

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Mengembalikan

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Dapatkan daftar ringkasan kumpulan penyebaran.

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

Parameter

poolName: string

Nama kumpulan penyebaran.

expands: DeploymentPoolSummaryExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

poolIds: number[]

Daftar id kumpulan penyebaran.

Mengembalikan

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Mendapatkan target penyebaran berdasarkan ID-nya dalam grup penyebaran

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran berada.

targetId: number

ID target penyebaran yang akan dikembalikan.

expand: DeploymentTargetExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

Mengembalikan

Promise<DeploymentMachine>

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

Dapatkan daftar target penyebaran dalam grup penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran.

tags: string[]

Hanya dapatkan target penyebaran yang berisi semua daftar tag yang dipisahkan koma ini.

name: string

Pola nama target penyebaran yang akan dikembalikan.

partialNameMatch: boolean

Ketika diatur ke true, memperlakukan nama sebagai pola. Lain memperlakukannya sebagai kecocokan absolut. Default adalah salah.

expand: DeploymentTargetExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

agentStatus: TaskAgentStatusFilter

Hanya dapatkan target penyebaran yang memiliki status ini.

agentJobResult: TaskAgentJobResultFilter

Hanya dapatkan target penyebaran yang memiliki hasil pekerjaan terakhir ini.

continuationToken: string

Dapatkan target penyebaran dengan nama yang lebih besar dari leksikografis continuationToken ini.

top: number

Jumlah maksimum target penyebaran yang akan dikembalikan. Defaultnya adalah 1000.

enabled: boolean

Hanya dapatkan target penyebaran yang diaktifkan atau dinonaktifkan. Defaultnya adalah 'null' yang mengembalikan semua target.

propertyFilters: string[]

Mengembalikan

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Dapatkan lingkungan dengan ID-nya.

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

ID lingkungan.

expands: EnvironmentExpands

Sertakan detail tambahan ini di objek yang dikembalikan.

Mengembalikan

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Mendapatkan riwayat eksekusi penyebaran lingkungan

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

continuationToken: string

top: number

Mengembalikan

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Dapatkan semua lingkungan.

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

Parameter

project: string

ID proyek atau nama proyek

name: string

continuationToken: string

top: number

Mengembalikan

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

Mengembalikan

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parameter

poolId: number

sessionId: string

lastMessageId: number

Mengembalikan

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parameter

packageType: string

platform: string

version: string

Mengembalikan

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parameter

packageType: string

platform: string

top: number

Mengembalikan

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Mengembalikan

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parameter

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Mengembalikan

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Mendapatkan file aman

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

Parameter

project: string

ID proyek atau nama proyek

secureFileId: string

Id file aman yang unik

includeDownloadTicket: boolean

Jika includeDownloadTicket benar dan penelepon memiliki izin, tiket unduhan disertakan dalam respons.

actionFilter: SecureFileActionFilter

Mengembalikan

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Mendapatkan file aman

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

Parameter

project: string

ID proyek atau nama proyek

namePattern: string

Nama file aman yang akan dicocokkan. Dapat menyertakan kartubebas untuk mencocokkan beberapa file.

includeDownloadTickets: boolean

Jika includeDownloadTickets benar dan pemanggil memiliki izin, tiket unduhan untuk setiap file aman disertakan dalam respons.

actionFilter: SecureFileActionFilter

Filter menurut izin file aman untuk tindakan Tampilkan, Kelola, atau Gunakan. Default ke Tampilan.

Mengembalikan

Promise<SecureFile[]>

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

Mendapatkan file aman

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

Parameter

project: string

ID proyek atau nama proyek

secureFileIds: string[]

Daftar Id file aman

includeDownloadTickets: boolean

Jika includeDownloadTickets benar dan pemanggil memiliki izin, tiket unduhan untuk setiap file aman disertakan dalam respons.

actionFilter: SecureFileActionFilter

Mengembalikan

Promise<SecureFile[]>

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

Mendapatkan file aman

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

Parameter

project: string

ID proyek atau nama proyek

secureFileNames: string[]

Daftar Id file aman

includeDownloadTickets: boolean

Jika includeDownloadTickets benar dan pemanggil memiliki izin, tiket unduhan untuk setiap file aman disertakan dalam respons.

actionFilter: SecureFileActionFilter

Mengembalikan

Promise<SecureFile[]>

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

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

Parameter

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Mengembalikan

Promise<ArrayBuffer>

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

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

Parameter

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Mengembalikan

Promise<TaskDefinition>

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

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

Parameter

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Mengembalikan

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Dapatkan grup tugas.

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

Parameter

project: string

ID proyek atau nama proyek

taskGroupId: string

Id grup tugas.

versionSpec: string

spesifikasi versi grup tugas. contoh: 1, 1,0.

expand: TaskGroupExpands

Properti yang harus diperluas. contoh $expand=Tugas akan memperluas grup tugas berlapis.

Mengembalikan

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parameter

project: string

ID proyek atau nama proyek

taskGroupId: string

Mengembalikan

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parameter

project: string

ID proyek atau nama proyek

taskGroupId: string

revision: number

Mengembalikan

Promise<string>

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

Mencantumkan grup tugas.

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

Parameter

project: string

ID proyek atau nama proyek

taskGroupId: string

Id grup tugas.

expanded: boolean

'true' untuk memperluas grup tugas secara rekursif. Defaultnya adalah 'false'.

taskIdFilter: string

Panduan taskId untuk memfilter.

deleted: boolean

'true'untuk menyertakan grup tugas yang dihapus. Defaultnya adalah 'false'.

top: number

Jumlah grup tugas yang akan didapatkan.

continuationToken: Date

Mendapatkan grup tugas setelah token kelanjutan disediakan.

queryOrder: TaskGroupQueryOrder

Mendapatkan hasil dalam urutan yang ditentukan. Defaultnya adalah 'CreatedOnDescending'.

Mengembalikan

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parameter

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Mengembalikan

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Dapatkan grup variabel.

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

Parameter

project: string

ID proyek atau nama proyek

groupId: number

Id grup variabel.

Mengembalikan

Promise<VariableGroup>

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

Mendapatkan grup variabel.

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

Parameter

project: string

ID proyek atau nama proyek

groupName: string

Nama grup variabel.

actionFilter: VariableGroupActionFilter

Filter tindakan untuk grup variabel. Ini menentukan tindakan yang dapat dilakukan pada grup variabel.

top: number

Jumlah grup variabel yang akan didapatkan.

continuationToken: number

Mendapatkan grup variabel setelah token kelanjutan disediakan.

queryOrder: VariableGroupQueryOrder

Mendapatkan hasil dalam urutan yang ditentukan. Defaultnya adalah 'IdDescending'.

Mengembalikan

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Mendapatkan grup variabel menurut id.

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

Parameter

project: string

ID proyek atau nama proyek

groupIds: number[]

Daftar Id grup variabel yang dipisahkan koma.

loadSecrets: boolean

Bendera yang menunjukkan apakah rahasia dalam grup variabel harus dimuat.

Mengembalikan

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

Mengembalikan

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

Parameter

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Mengembalikan

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Mengembalikan

Promise<string>

getYamlSchema(boolean)

DAPATKAN skema Yaml yang digunakan untuk validasi file Yaml.

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

Parameter

validateTaskNames: boolean

Apakah skema harus memvalidasi bahwa tugas benar-benar diinstal (berguna untuk alat offline di mana Anda tidak ingin validasi).

Mengembalikan

Promise<any>

hasPoolPermissions(number, number)

Memeriksa apakah identitas saat ini telah meneruskan izin pada kumpulan.

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

Parameter

poolId: number

Id kumpulan untuk diperiksa

permissions: number

Izin untuk memeriksa. Beberapa izin mungkin digabungkan ke dalam nilai tunggal menggunakan operator BITWISE OR (misalnya AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Mengembalikan

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parameter

taskGroupMetadata: PublishTaskGroupMetadata

project: string

ID proyek atau nama proyek

parentTaskGroupId: string

Mengembalikan

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Proksi untuk permintaan GET yang ditentukan oleh 'titik akhir'. Permintaan diotorisasi menggunakan koneksi layanan. Respons difilter menggunakan pemilih berbasis JalurX/Json.

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

Parameter

endpoint: TaskDefinitionEndpoint

Menjelaskan URL yang akan diambil.

Mengembalikan

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Kueri file aman menggunakan pola nama dan kondisi pada properti file.

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

Parameter

condition: string

Sintaks kondisi utama dijelaskan di sini. Gunakan fungsi property('property-name') untuk mengakses nilai properti yang ditentukan dari file aman. Ini mengembalikan null jika properti tidak diatur. Misalnya and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

ID proyek atau nama proyek

namePattern: string

Nama file aman yang akan dicocokkan. Dapat menyertakan kartubebas untuk mencocokkan beberapa file.

Mengembalikan

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parameter

job: TaskAgentPoolMaintenanceJob

poolId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parameter

request: TaskAgentJobRequest

project: string

ID proyek atau nama proyek

queueId: number

Mengembalikan

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parameter

request: TaskAgentJobRequest

poolId: number

Mengembalikan

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parameter

poolId: number

agentId: number

Mengembalikan

Promise<void>

refreshAgents(number)

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

Parameter

poolId: number

Mengembalikan

Promise<void>

refreshDeploymentMachines(string, number)

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

Mengembalikan

Promise<void>

refreshDeploymentTargets(string, number)

Tingkatkan target penyebaran dalam grup penyebaran.

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

Parameter

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran.

Mengembalikan

Promise<void>

replaceAgent(TaskAgent, number, number)

Ganti agen. Anda mungkin tidak ingin memanggil titik akhir ini secara langsung. Sebagai gantinya, gunakan skrip konfigurasi agen untuk menghapus dan mengonfigurasi ulang agen dari organisasi Anda.

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

Parameter

agent: TaskAgent

Detail yang diperbarui tentang agen ganti

poolId: number

Kumpulan agen yang akan digunakan

agentId: number

Agen yang akan diganti

Mengembalikan

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameter

machine: DeploymentMachine

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineId: number

Mengembalikan

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Ganti target penyebaran dalam grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.

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

Parameter

machine: DeploymentMachine

Target penyebaran baru.

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran diganti.

targetId: number

ID target penyebaran untuk diganti.

Mengembalikan

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parameter

message: TaskAgentMessage

poolId: number

requestId: number

Mengembalikan

Promise<void>

setAgentPoolMetadata(any, number)

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

Parameter

agentPoolMetadata: any

poolId: number

Mengembalikan

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Tambahkan grup variabel.

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

Parameter

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Mengembalikan

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parameter

taskGroup: TaskGroup

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Perbarui detail agen.

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

Parameter

agent: TaskAgent

Detail terbaru tentang agen

poolId: number

Kumpulan agen yang akan digunakan

agentId: number

Agen yang akan diperbarui

Mengembalikan

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parameter

updatedCloud: TaskAgentCloud

agentCloudId: number

Mengembalikan

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Memperbarui properti pada kumpulan agen

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

Parameter

pool: TaskAgentPool

Detail kumpulan agen yang diperbarui

poolId: number

Kumpulan agen untuk diperbarui

Mengembalikan

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parameter

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parameter

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Mengembalikan

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parameter

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Mengembalikan

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parameter

poolId: number

agentId: number

currentState: string

Mengembalikan

Promise<TaskAgent>

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

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

Parameter

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Mengembalikan

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Memperbarui grup penyebaran.

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

Parameter

deploymentGroup: DeploymentGroupUpdateParameter

Grup penyebaran untuk diperbarui.

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran.

Mengembalikan

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parameter

machine: DeploymentMachine

project: string

ID proyek atau nama proyek

deploymentGroupId: number

machineId: number

Mengembalikan

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parameter

machineGroup: DeploymentMachineGroup

project: string

ID proyek atau nama proyek

machineGroupId: number

Mengembalikan

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parameter

deploymentMachines: DeploymentMachine[]

project: string

ID proyek atau nama proyek

machineGroupId: number

Mengembalikan

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parameter

machines: DeploymentMachine[]

project: string

ID proyek atau nama proyek

deploymentGroupId: number

Mengembalikan

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Memperbarui target penyebaran dan properti agennya dalam grup penyebaran. Umumnya ini dipanggil oleh alat konfigurasi agen.

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

Parameter

machine: DeploymentMachine

Target penyebaran untuk diperbarui.

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran diperbarui.

targetId: number

ID target penyebaran untuk diperbarui.

Mengembalikan

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Memperbarui tag daftar target penyebaran dalam grup penyebaran.

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

Parameter

machines: DeploymentTargetUpdateParameter[]

Target penyebaran dengan tag untuk di-udpdate.

project: string

ID proyek atau nama proyek

deploymentGroupId: number

ID grup penyebaran tempat target penyebaran diperbarui.

Mengembalikan

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Perbarui lingkungan yang ditentukan.

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

Parameter

environmentUpdateParameter: EnvironmentUpdateParameter

Data lingkungan yang akan diperbarui.

project: string

ID proyek atau nama proyek

environmentId: number

ID lingkungan.

Mengembalikan

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Memperbarui nama atau properti file aman yang ada

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

Parameter

secureFile: SecureFile

File aman dengan nama dan/atau properti yang diperbarui

project: string

ID proyek atau nama proyek

secureFileId: string

Id file aman yang unik

Mengembalikan

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Perbarui properti dan/atau nama sekumpulan file aman. File diidentifikasi oleh ID mereka. Properti yang disediakan mengambil alih properti yang ada sepenuhnya, yaitu jangan gabungkan.

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

Parameter

secureFiles: SecureFile[]

Daftar objek file aman. Hanya tiga bidang yang harus diisi Id, Nama, dan Properti. Bidang lainnya dalam objek diabaikan.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Memperbarui grup tugas.

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

Parameter

taskGroup: TaskGroupUpdateParameter

Grup tugas yang akan diperbarui.

project: string

ID proyek atau nama proyek

taskGroupId: string

Id grup tugas yang akan diperbarui.

Mengembalikan

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parameter

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

ID proyek atau nama proyek

taskGroupId: string

disablePriorVersions: boolean

Mengembalikan

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parameter

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Mengembalikan

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Memperbarui grup variabel.

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

Parameter

variableGroupParameters: VariableGroupParameters

groupId: number

Id grup variabel yang akan diperbarui.

Mengembalikan

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parameter

resource: VirtualMachineGroup

project: string

ID proyek atau nama proyek

environmentId: number

Mengembalikan

Promise<VirtualMachineGroup>

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

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

Parameter

machines: VirtualMachine[]

project: string

ID proyek atau nama proyek

environmentId: number

resourceId: number

Mengembalikan

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Unggah file aman, sertakan aliran file dalam isi permintaan

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

Parameter

content: any

Konten yang akan diunggah

project: string

ID proyek atau nama proyek

name: string

Nama file yang akan diunggah

authorizePipelines: boolean

Jika authorizePipelines benar, maka file aman diotorisasi untuk digunakan oleh semua alur dalam proyek.

Mengembalikan

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parameter

inputValidationRequest: InputValidationRequest

Mengembalikan

Promise<InputValidationRequest>

Saran dan Komentar

Apakah halaman ini membantu?

Bagikan melalui

TaskAgentRestClient class

Konstruktor

Properti

Metode

Detail Konstruktor

TaskAgentRestClient(IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

Nilai Properti

Detail Metode

addAgent(TaskAgent, number)

Parameter

Mengembalikan

addAgentCloud(TaskAgentCloud)

Parameter

Mengembalikan

addAgentPool(TaskAgentPool)

Parameter

Mengembalikan

addAgentQueue(TaskAgentQueue, string, boolean)

Parameter

Mengembalikan

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parameter

Mengembalikan

addDeploymentMachine(DeploymentMachine, string, number)

Parameter

Mengembalikan

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parameter

Mengembalikan

addDeploymentTarget(DeploymentMachine, string, number)

Parameter

Mengembalikan

addEnvironment(EnvironmentCreateParameter, string)

Parameter

Mengembalikan

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parameter

Mengembalikan

addTaskGroup(TaskGroupCreateParameter, string)

Parameter

Mengembalikan

addVariableGroup(VariableGroupParameters)

Parameter

Mengembalikan

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parameter

Mengembalikan

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

Parameter

Mengembalikan

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parameter

Mengembalikan

createAgentSession(TaskAgentSession, number)

Parameter

Mengembalikan

createTeamProject(string)

Parameter

Mengembalikan

deleteAgent(number, number)

Parameter

Mengembalikan

deleteAgentCloud(number)

Parameter

Mengembalikan

deleteAgentPool(number)

Parameter

Mengembalikan

deleteAgentPoolMaintenanceDefinition(number, number)

Parameter

Mengembalikan

deleteAgentPoolMaintenanceJob(number, number)

Parameter

Mengembalikan

deleteAgentQueue(number, string)

Parameter