TaskAgentRestClient class

Paket:: azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends: RestClientBase

Oluşturucular

TaskAgentRestClient(IVssRestClientOptions)

Özellikler

Yöntemler

addAgent(TaskAgent, number)	Havuza aracı ekler. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracı indirme paketini kullanarak aracı yapılandırın.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Aracı havuzu oluşturma.
addAgentQueue(TaskAgentQueue, string, boolean)	Projeyi aracı havuzuna bağlamak için yeni bir aracı kuyruğu oluşturun.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Dağıtım grubu oluşturun.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Dağıtım hedeflerini bir dağıtım grubuna kaydetme. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.
addEnvironment(EnvironmentCreateParameter, string)	Ortam oluşturma.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Bir görev grubu oluşturun.
addVariableGroup(VariableGroupParameters)	Değişken grubu ekleyin.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Yeni bir takım projesi oluşturun.
deleteAgent(number, number)	Aracıyı silme. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracı yapılandırma betiğini kullanarak aracıyı kuruluşunuzdan kaldırın.
deleteAgentCloud(number)
deleteAgentPool(number)	Aracı havuzunu silme.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Bir projeden aracı kuyruğu kaldırır.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Dağıtım grubunu silme.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Dağıtım grubundaki dağıtım hedeflerini silme. Bu işlem aracıyı ilişkili dağıtım havuzundan da siler.
deleteEnvironment(string, number)	Belirtilen ortamı silin.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Güvenli dosyayı silme
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Görev grubunu silme.
deleteVariableGroup(number, string[])	Değişken grubunu silme
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Kimliğine göre güvenli bir dosya indirme
generateDeploymentGroupAccessToken(string, number)	Dağıtım grubundaki dağıtım hedeflerini yönetmek (yapılandırma, kaldırma, etiketleme) için pat belirteci alma.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	Dağıtım havuzundaki dağıtım aracılarını yönetmek (yapılandırma, kaldırma, etiketleme) için bir PAT belirteci alın.
getAgent(number, number, boolean, boolean, boolean, string[])	Bir aracı hakkında bilgi alın.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Aracı bulut türlerini alma.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Aracı havuzu hakkında bilgi edinin.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Aracı havuzlarının listesini alın.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Aracı havuzlarının listesini alın.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Aracı kuyruğu hakkında bilgi alın.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Aracı kuyruklarının listesini alın.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Kimliklerine göre aracı kuyruklarının listesini alma
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Aracı kuyruklarının adlarının listesini alma
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Havuz kimliklerine göre aracı kuyruklarının listesini alma
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)	Dağıtım hedefi için aracı isteklerini alma.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Liste dağıtım hedefleri için aracı isteklerini alma.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Aracıların listesini alın.
getAzureManagementGroups()	Azure aboneliklerinin listesini döndürür
getAzureSubscriptions()	Azure aboneliklerinin listesini döndürür
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Kimliğine göre bir dağıtım grubu alın.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Ada veya kimliklere göre dağıtım gruplarının listesini alın.
getDeploymentGroupsMetrics(string, string, string, number)	Dağıtım grubu ölçümlerinin listesini alın.
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[])	Dağıtım havuzu özetlerinin listesini alın.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Dağıtım grubundaki kimliğine göre dağıtım hedefi alma
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Dağıtım grubundaki dağıtım hedeflerinin listesini alın.
getEnvironmentById(string, number, EnvironmentExpands)	Kimliğine göre bir ortam alın.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Ortam dağıtımı yürütme geçmişini alma
getEnvironments(string, string, string, number)	Tüm ortamları edinin.
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)	Güvenli bir dosya alma
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Güvenli dosyaları alma
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Güvenli dosyaları alma
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Güvenli dosyaları alma
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Görev grubunu alma.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Görev gruplarını listeleyin.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Değişken grubu alma.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Değişken gruplarını alma.
getVariableGroupsById(string, number[], boolean)	Kimliklere göre değişken grupları alma.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	Yaml dosya doğrulaması için kullanılan Yaml şemasını ALMA.
hasPoolPermissions(number, number)	Geçerli kimliğin havuz üzerindeki izinleri geçirip geçirmediğini denetler.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Bir 'uç nokta' tarafından tanımlanan get isteğinin ara sunucusu. İstek, bir hizmet bağlantısı kullanılarak yetkilendirilmiştir. Yanıt, XPath/Json tabanlı seçici kullanılarak filtrelenmiştir.
querySecureFilesByProperties(string, string, string)	Dosya özelliklerinde bir ad deseni ve koşul kullanarak güvenli dosyaları sorgular.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Dağıtım grubundaki dağıtım hedeflerini yükseltin.
replaceAgent(TaskAgent, number, number)	Aracıyı değiştirin. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracıyı kuruluşunuzdan kaldırmak ve yeniden yapılandırmak için aracı yapılandırma betiğini kullanın.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Dağıtım grubundaki dağıtım hedeflerini değiştirin. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Değişken grubu ekleyin.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Aracı ayrıntılarını güncelleştirin.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aracı havuzundaki özellikleri güncelleştirme
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)	Dağıtım grubunu güncelleştirme.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Dağıtım grubundaki dağıtım hedefini ve aracı özelliklerini güncelleştirin. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Dağıtım grubundaki dağıtım hedefleri listesinin etiketlerini güncelleştirin.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Belirtilen ortamı güncelleştirin.
updateSecureFile(SecureFile, string, string)	Mevcut bir güvenli dosyanın adını veya özelliklerini güncelleştirme
updateSecureFiles(SecureFile[], string)	Bir dizi güvenli dosya için özellikleri ve/veya adları güncelleştirin. Dosyalar kimlikleriyle tanımlanır. Sağlanan özellikler mevcut olanı tamamen geçersiz kılar; yani birleştirmez.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Görev grubunu güncelleştirme.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Değişken grubunu güncelleştirme.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Güvenli bir dosyayı karşıya yükleyin, dosya akışını istek gövdesine ekleyin
validateInputs(InputValidationRequest)

Oluşturucu Ayrıntıları

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametreler

options: IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

addAgent(TaskAgent, number)

Havuza aracı ekler. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracı indirme paketini kullanarak aracı yapılandırın.

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

Parametreler

agent: TaskAgent

Eklenen aracıyla ilgili ayrıntılar

poolId: number

Aracının ekleneceği aracı havuzu

Döndürülenler

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parametreler

agentCloud: TaskAgentCloud

Döndürülenler

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Aracı havuzu oluşturma.

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

Parametreler

pool: TaskAgentPool

Yeni aracı havuzu hakkındaki ayrıntılar

Döndürülenler

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Projeyi aracı havuzuna bağlamak için yeni bir aracı kuyruğu oluşturun.

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

Parametreler

queue: TaskAgentQueue

Oluşturulacak kuyrukla ilgili ayrıntılar

project: string

Proje kimliği veya proje adı

authorizePipelines: boolean

YAML kullanırken bu kuyruğu otomatik olarak yetkile

Döndürülenler

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Dağıtım grubu oluşturun.

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

Parametreler

deploymentGroup: DeploymentGroupCreateParameter

Oluşturulacak dağıtım grubu.

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parametreler

machine: DeploymentMachine

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Döndürülenler

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parametreler

machineGroup: DeploymentMachineGroup

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Dağıtım hedeflerini bir dağıtım grubuna kaydetme. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.

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

Parametreler

machine: DeploymentMachine

Kaydedilecek dağıtım hedefi.

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedefinin kaydedildiği dağıtım grubunun kimliği.

Döndürülenler

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Ortam oluşturma.

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

Parametreler

environmentCreateParameter: EnvironmentCreateParameter

Oluşturulacak ortam.

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parametreler

createParameters: KubernetesResourceCreateParameters

project: string

Proje kimliği veya proje adı

environmentId: number

Döndürülenler

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Bir görev grubu oluşturun.

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

Parametreler

taskGroup: TaskGroupCreateParameter

Oluşturulacak görev grubu nesnesi.

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Değişken grubu ekleyin.

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

Parametreler

variableGroupParameters: VariableGroupParameters

Döndürülenler

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parametreler

createParameters: VirtualMachineGroupCreateParameters

project: string

Proje kimliği veya proje adı

environmentId: number

Döndürülenler

Promise<VirtualMachineGroup>

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

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

Parametreler

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Döndürülenler

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parametreler

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parametreler

session: TaskAgentSession

poolId: number

Döndürülenler

Promise<TaskAgentSession>

createTeamProject(string)

Yeni bir takım projesi oluşturun.

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

Parametreler

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

deleteAgent(number, number)

Aracıyı silme. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracı yapılandırma betiğini kullanarak aracıyı kuruluşunuzdan kaldırın.

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

Parametreler

poolId: number

Aracıyı kaldırılacak havuz kimliği

agentId: number

Kaldırılacak aracı kimliği

Döndürülenler

Promise<void>

deleteAgentCloud(number)

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

Parametreler

agentCloudId: number

Döndürülenler

Promise<TaskAgentCloud>

deleteAgentPool(number)

Aracı havuzunu silme.

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

Parametreler

poolId: number

Silinecek aracı havuzunun kimliği

Döndürülenler

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parametreler

poolId: number

definitionId: number

Döndürülenler

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parametreler

poolId: number

jobId: number

Döndürülenler

Promise<void>

deleteAgentQueue(number, string)

Bir projeden aracı kuyruğu kaldırır.

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

Parametreler

queueId: number

Kaldırılacak aracı kuyruğu

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

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

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

Parametreler

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Döndürülenler

Promise<void>

deleteAgentSession(number, string)

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

Parametreler

poolId: number

sessionId: string

Döndürülenler

Promise<void>

deleteDeploymentGroup(string, number)

Dağıtım grubunu silme.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Silinecek dağıtım grubunun kimliği.

Döndürülenler

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineId: number

Döndürülenler

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

machineGroupId: number

Döndürülenler

Promise<void>

deleteDeploymentTarget(string, number, number)

Dağıtım grubundaki dağıtım hedeflerini silme. Bu işlem aracıyı ilişkili dağıtım havuzundan da siler.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedefinin silindiği dağıtım grubunun kimliği.

targetId: number

Silinecek dağıtım hedefinin kimliği.

Döndürülenler

Promise<void>

deleteEnvironment(string, number)

Belirtilen ortamı silin.

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

Ortamın kimliği.

Döndürülenler

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

Döndürülenler

Promise<void>

deleteMessage(number, number, string)

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

Parametreler

poolId: number

messageId: number

sessionId: string

Döndürülenler

Promise<void>

deleteSecureFile(string, string)

Güvenli dosyayı silme

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

Parametreler

project: string

Proje kimliği veya proje adı

secureFileId: string

Benzersiz güvenli dosya kimliği

Döndürülenler

Promise<void>

deleteTaskDefinition(string)

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

Parametreler

taskId: string

Döndürülenler

Promise<void>

deleteTaskGroup(string, string, string)

Görev grubunu silme.

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

Parametreler

project: string

Proje kimliği veya proje adı

taskGroupId: string

Silinecek görev grubunun kimliği.

comment: string

Silinecek açıklamalar.

Döndürülenler

Promise<void>

deleteVariableGroup(number, string[])

Değişken grubunu silme

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

Parametreler

groupId: number

Değişken grubunun kimliği.

projectIds: string[]

Döndürülenler

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

Döndürülenler

Promise<void>

downloadSecureFile(string, string, string, boolean)

Kimliğine göre güvenli bir dosya indirme

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

Parametreler

project: string

Proje kimliği veya proje adı

secureFileId: string

Benzersiz güvenli dosya kimliği

ticket: string

Geçerli bir indirme bileti

download: boolean

İndirme doğruysa, dosya yanıt gövdesinde ek olarak gönderilir. İndirme false ise, yanıt gövdesi dosya akışını içerir.

Döndürülenler

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

Dağıtım grubundaki dağıtım hedeflerini yönetmek (yapılandırma, kaldırma, etiketleme) için pat belirteci alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedeflerinin yönetildiği dağıtım grubunun kimliği.

Döndürülenler

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

machineGroupId: number

Döndürülenler

Promise<string>

generateDeploymentPoolAccessToken(number)

Dağıtım havuzundaki dağıtım aracılarını yönetmek (yapılandırma, kaldırma, etiketleme) için bir PAT belirteci alın.

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

Parametreler

poolId: number

Dağıtım aracılarının yönetildiği dağıtım havuzunun kimliği.

Döndürülenler

Promise<string>

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

Bir aracı hakkında bilgi alın.

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

Parametreler

poolId: number

Aracıyı içeren aracı havuzu

agentId: number

Hakkında bilgi almak için aracı kimliği

includeCapabilities: boolean

Aracının yeteneklerinin yanıta eklenip eklenmeyeceği

includeAssignedRequest: boolean

Aracının geçerli çalışması hakkında ayrıntıların eklenip eklenmeyeceği

includeLastCompletedRequest: boolean

Aracıların en son tamamlanan çalışmalarıyla ilgili ayrıntıların eklenip eklenmeyeceği

propertyFilters: string[]

Hangi özel özelliklerin döndürüleceğini filtreleyin

Döndürülenler

Promise<TaskAgent>

getAgentCloud(number)

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

Parametreler

agentCloudId: number

Döndürülenler

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parametreler

agentCloudId: number

Döndürülenler

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Döndürülenler

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Aracı bulut türlerini alma.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Döndürülenler

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Aracı havuzu hakkında bilgi edinin.

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

Parametreler

poolId: number

Aracı havuzu kimliği

properties: string[]

Aracı havuzu özellikleri (virgülle ayrılmış)

actionFilter: TaskAgentPoolActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parametreler

poolId: number

definitionId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parametreler

poolId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parametreler

poolId: number

jobId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parametreler

poolId: number

jobId: number

Döndürülenler

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parametreler

poolId: number

definitionId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parametreler

poolId: number

Döndürülenler

Promise<string>

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

Aracı havuzlarının listesini alın.

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

Parametreler

poolName: string

Ada göre filtrele

properties: string[]

Aracı havuzu özelliklerine göre filtreleme (virgülle ayrılmış)

poolType: TaskAgentPoolType

Havuz türüne göre filtrele

actionFilter: TaskAgentPoolActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Aracı havuzlarının listesini alın.

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

Parametreler

poolIds: number[]

getirilecek havuz kimlikleri

actionFilter: TaskAgentPoolActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Aracı kuyruğu hakkında bilgi alın.

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

Parametreler

queueId: number

Hakkında bilgi almak için aracı kuyruğu

project: string

Proje kimliği veya proje adı

actionFilter: TaskAgentQueueActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Aracı kuyruklarının listesini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

queueName: string

Aracı kuyruğu adına göre filtreleme

actionFilter: TaskAgentQueueActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Kimliklerine göre aracı kuyruklarının listesini alma

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

Parametreler

queueIds: number[]

Alınacak aracı kuyruğu kimliklerinin virgülle ayrılmış listesi

project: string

Proje kimliği veya proje adı

actionFilter: TaskAgentQueueActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Aracı kuyruklarının adlarının listesini alma

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

Parametreler

queueNames: string[]

Alınacak aracı adlarının virgülle ayrılmış listesi

project: string

Proje kimliği veya proje adı

actionFilter: TaskAgentQueueActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Havuz kimliklerine göre aracı kuyruklarının listesini alma

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

Parametreler

poolIds: number[]

İlgili kuyrukları almak için virgülle ayrılmış havuz kimlikleri listesi

project: string

Proje kimliği veya proje adı

actionFilter: TaskAgentQueueActionFilter

Çağıran kullanıcının kullanım veya yönetme izinlerine göre filtreleme

Döndürülenler

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parametreler

poolId: number

requestId: number

includeStatus: boolean

Döndürülenler

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parametreler

poolId: number

top: number

continuationToken: string

Döndürülenler

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parametreler

poolId: number

agentId: number

completedRequestCount: number

Döndürülenler

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parametreler

poolId: number

agentIds: number[]

completedRequestCount: number

Döndürülenler

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineId: number

completedRequestCount: number

Döndürülenler

Promise<TaskAgentJobRequest[]>

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

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Döndürülenler

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Dağıtım hedefi için aracı isteklerini alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Hedefin ait olduğu dağıtım grubunun kimliği.

targetId: number

Dağıtım hedefinin kimliği.

completedRequestCount: number

Döndürülecek en fazla tamamlanmış istek sayısı. Varsayılan değer 50

Döndürülenler

Promise<TaskAgentJobRequest[]>

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

Liste dağıtım hedefleri için aracı isteklerini alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Hedeflerin ait olduğu dağıtım grubunun kimliği.

targetIds: number[]

Dağıtım hedeflerinin kimliklerinin virgülle ayrılmış listesi.

ownerId: number

Aracı işi isteğinin sahibinin kimliği.

completedOn: Date

Bu saatten sonra isteğin döndürüleceği tarih saat.

completedRequestCount: number

Her hedef için döndürülecek en fazla tamamlanmış istek sayısı. Varsayılan değer 50

Döndürülenler

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parametreler

poolId: number

planId: string

jobId: string

Döndürülenler

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parametreler

project: string

Proje kimliği veya proje adı

queueId: number

top: number

continuationToken: string

Döndürülenler

Promise<PagedList<TaskAgentJobRequest>>

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

Aracıların listesini alın.

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

Parametreler

poolId: number

Aracıları içeren aracı havuzu

agentName: string

Aracı adına göre filtreleme

includeCapabilities: boolean

Aracıların yeteneklerinin yanıta dahil edilip edilmeyeceği

includeAssignedRequest: boolean

Aracıların geçerli çalışmalarıyla ilgili ayrıntıların eklenip eklenmeyeceği

includeLastCompletedRequest: boolean

Aracıların en son tamamlanan çalışmalarıyla ilgili ayrıntıların eklenip eklenmeyeceği

propertyFilters: string[]

Hangi özel özelliklerin döndürüleceğini filtreleyin

demands: string[]

Aracıların karşıladığı taleplere göre filtreleme

Döndürülenler

Promise<TaskAgent[]>

getAzureManagementGroups()

Azure aboneliklerinin listesini döndürür

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Döndürülenler

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Azure aboneliklerinin listesini döndürür

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Döndürülenler

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Kimliğine göre bir dağıtım grubu alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım grubunun kimliği.

actionFilter: DeploymentGroupActionFilter

Dağıtım grubunu yalnızca bu eylem üzerinde gerçekleştirilebiliyorsa alın.

expand: DeploymentGroupExpands

Bu ek ayrıntıları döndürülen nesneye ekleyin.

Döndürülenler

Promise<DeploymentGroup>

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

Ada veya kimliklere göre dağıtım gruplarının listesini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

name: string

Dağıtım grubunun adı.

actionFilter: DeploymentGroupActionFilter

Yalnızca bu eylemin gerçekleştirilebileceği dağıtım gruplarını alın.

expand: DeploymentGroupExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

continuationToken: string

Bu continuationToken sözcük temellinden daha büyük adlara sahip dağıtım gruplarını alın.

top: number

Döndürülecek dağıtım grubu sayısı üst sınırı. Varsayılan değer 1000.

ids: number[]

Dağıtım gruplarının kimliklerinin virgülle ayrılmış listesi.

Döndürülenler

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Dağıtım grubu ölçümlerinin listesini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupName: string

Dağıtım grubunun adı.

continuationToken: string

Bu continuationToken sözcük temellinden daha büyük adlara sahip dağıtım grupları için ölçümler alın.

top: number

Döndürülecek dağıtım grubu ölçüm sayısı üst sınırı. Varsayılan değer 50' dir.

Döndürülenler

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Döndürülenler

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parametreler

project: string

Proje kimliği veya proje adı

machineGroupId: number

actionFilter: MachineGroupActionFilter

Döndürülenler

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parametreler

project: string

Proje kimliği veya proje adı

machineGroupId: number

tagFilters: string[]

Döndürülenler

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parametreler

project: string

Proje kimliği veya proje adı

machineGroupName: string

actionFilter: MachineGroupActionFilter

Döndürülenler

Promise<DeploymentMachineGroup[]>

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

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Döndürülenler

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Dağıtım havuzu özetlerinin listesini alın.

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

Parametreler

poolName: string

Dağıtım havuzunun adı.

expands: DeploymentPoolSummaryExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

poolIds: number[]

Dağıtım havuzu kimliklerinin listesi.

Döndürülenler

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Dağıtım grubundaki kimliğine göre dağıtım hedefi alma

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedefinin ait olduğu dağıtım grubunun kimliği.

targetId: number

Döndürülecek dağıtım hedefinin kimliği.

expand: DeploymentTargetExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

Döndürülenler

Promise<DeploymentMachine>

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

Dağıtım grubundaki dağıtım hedeflerinin listesini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım grubunun kimliği.

tags: string[]

Yalnızca tüm bu virgülle ayrılmış etiket listesini içeren dağıtım hedeflerini alın.

name: string

Döndürülecek dağıtım hedeflerinin ad düzeni.

partialNameMatch: boolean

true olarak ayarlandığında, adı desen olarak ele alır. Aksi halde mutlak eşleşme olarak ele alır. Varsayılan değer false.

expand: DeploymentTargetExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

agentStatus: TaskAgentStatusFilter

Yalnızca bu duruma sahip dağıtım hedeflerini alın.

agentJobResult: TaskAgentJobResultFilter

Yalnızca bu son iş sonucuna sahip dağıtım hedeflerini alın.

continuationToken: string

Bu continuationToken sözcük bilgisinden daha büyük adlara sahip dağıtım hedeflerini alın.

top: number

Döndürülecek dağıtım hedefi sayısı üst sınırı. Varsayılan değer 1000.

enabled: boolean

Yalnızca etkinleştirilmiş veya devre dışı bırakılmış dağıtım hedeflerini alın. Varsayılan değer, tüm hedefleri döndüren 'null' değeridir.

propertyFilters: string[]

Döndürülenler

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Kimliğine göre bir ortam alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

Ortamın kimliği.

expands: EnvironmentExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

Döndürülenler

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Ortam dağıtımı yürütme geçmişini alma

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

continuationToken: string

top: number

Döndürülenler

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Tüm ortamları edinin.

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

Parametreler

project: string

Proje kimliği veya proje adı

name: string

continuationToken: string

top: number

Döndürülenler

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

Döndürülenler

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parametreler

poolId: number

sessionId: string

lastMessageId: number

Döndürülenler

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parametreler

packageType: string

platform: string

version: string

Döndürülenler

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parametreler

packageType: string

platform: string

top: number

Döndürülenler

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Döndürülenler

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parametreler

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Döndürülenler

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Güvenli bir dosya alma

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

Parametreler

project: string

Proje kimliği veya proje adı

secureFileId: string

Benzersiz güvenli dosya kimliği

includeDownloadTicket: boolean

includeDownloadTicket true ise ve arayan izinlere sahipse, yanıta bir indirme bileti eklenir.

actionFilter: SecureFileActionFilter

Döndürülenler

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Güvenli dosyaları alma

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

Parametreler

project: string

Proje kimliği veya proje adı

namePattern: string

Eşleşecek güvenli dosyanın adı. Birden çok dosyayla eşleşmesi için joker karakterler içerebilir.

includeDownloadTickets: boolean

includeDownloadTickets true ise ve çağıranın izinleri varsa, yanıta her güvenli dosya için bir indirme bileti eklenir.

actionFilter: SecureFileActionFilter

Görüntüleme, Yönetme veya Kullanma eylemi için güvenli dosya izinlerine göre filtreleyin. Varsayılan olarak Görünüm'ü kullanır.

Döndürülenler

Promise<SecureFile[]>

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

Güvenli dosyaları alma

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

Parametreler

project: string

Proje kimliği veya proje adı

secureFileIds: string[]

Güvenli dosya kimliklerinin listesi

includeDownloadTickets: boolean

includeDownloadTickets true ise ve çağıranın izinleri varsa, yanıta her güvenli dosya için bir indirme bileti eklenir.

actionFilter: SecureFileActionFilter

Döndürülenler

Promise<SecureFile[]>

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

Güvenli dosyaları alma

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

Parametreler

project: string

Proje kimliği veya proje adı

secureFileNames: string[]

Güvenli dosya kimliklerinin listesi

includeDownloadTickets: boolean

includeDownloadTickets true ise ve çağıranın izinleri varsa, yanıta her güvenli dosya için bir indirme bileti eklenir.

actionFilter: SecureFileActionFilter

Döndürülenler

Promise<SecureFile[]>

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

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

Parametreler

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Döndürülenler

Promise<ArrayBuffer>

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

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

Parametreler

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Döndürülenler

Promise<TaskDefinition>

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

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

Parametreler

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Döndürülenler

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Görev grubunu alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

taskGroupId: string

Görev grubunun kimliği.

versionSpec: string

görev grubunun sürüm belirtimi. örnekler: 1, 1.0.

expand: TaskGroupExpands

Genişletilmesi gereken özellikler. örnek $expand=Görevler iç içe görev gruplarını genişletir.

Döndürülenler

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parametreler

project: string

Proje kimliği veya proje adı

taskGroupId: string

Döndürülenler

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

taskGroupId: string

revision: number

Döndürülenler

Promise<string>

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

Görev gruplarını listeleyin.

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

Parametreler

project: string

Proje kimliği veya proje adı

taskGroupId: string

Görev grubunun kimliği.

expanded: boolean

Görev gruplarını özyinelemeli olarak genişletmek için 'true'. Varsayılan değer 'false'tur.

taskIdFilter: string

Filtre uygulamak için görev kimliğinin guid'i.

deleted: boolean

Silinen görev gruplarını eklemek için 'true'. Varsayılan değer 'false'tur.

top: number

Alınacak görev grubu sayısı.

continuationToken: Date

Sağlanan devamlılık belirtecinin ardından görev gruplarını alır.

queryOrder: TaskGroupQueryOrder

Sonuçları tanımlı sırada alır. Varsayılan değer :'CreatedOnDescending'.

Döndürülenler

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parametreler

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Döndürülenler

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Değişken grubu alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

groupId: number

Değişken grubunun kimliği.

Döndürülenler

Promise<VariableGroup>

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

Değişken gruplarını alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

groupName: string

Değişken grubunun adı.

actionFilter: VariableGroupActionFilter

Değişken grubu için eylem filtresi. Değişken gruplarında gerçekleştirilebilecek eylemi belirtir.

top: number

Alınacak değişken gruplarının sayısı.

continuationToken: number

Sağlanan devamlılık belirtecinin ardından değişken gruplarını alır.

queryOrder: VariableGroupQueryOrder

Sonuçları tanımlı sırada alır. Varsayılan değer :'IdDescending'.

Döndürülenler

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Kimliklere göre değişken grupları alma.

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

Parametreler

project: string

Proje kimliği veya proje adı

groupIds: number[]

Değişken gruplarının kimliklerinin virgülle ayrılmış listesi.

loadSecrets: boolean

Değişken grupları içindeki gizli dizilerin yüklenmesi gerekip gerekmediğini gösteren bayrak.

Döndürülenler

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

Döndürülenler

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

Parametreler

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Döndürülenler

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Döndürülenler

Promise<string>

getYamlSchema(boolean)

Yaml dosya doğrulaması için kullanılan Yaml şemasını ALMA.

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

Parametreler

validateTaskNames: boolean

Şemanın görevlerin gerçekten yüklendiğini doğrulaması gerekip gerekmediği (doğrulama istemediğiniz çevrimdışı araçlar için kullanışlıdır).

Döndürülenler

Promise<any>

hasPoolPermissions(number, number)

Geçerli kimliğin havuz üzerindeki izinleri geçirip geçirmediğini denetler.

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

Parametreler

poolId: number

Denetlenecek havuzun kimliği

permissions: number

Denetlenecek izinler. Bit düzeyinde OR işleci kullanılarak birden çok izin tek bir değerde birleştirilebilir (örn. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Döndürülenler

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parametreler

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Proje kimliği veya proje adı

parentTaskGroupId: string

Döndürülenler

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Bir 'uç nokta' tarafından tanımlanan get isteğinin ara sunucusu. İstek, bir hizmet bağlantısı kullanılarak yetkilendirilmiştir. Yanıt, XPath/Json tabanlı seçici kullanılarak filtrelenmiştir.

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

Parametreler

endpoint: TaskDefinitionEndpoint

Getirilmeye yönelik URL'yi açıklar.

Döndürülenler

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Dosya özelliklerinde bir ad deseni ve koşul kullanarak güvenli dosyaları sorgular.

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

Parametreler

condition: string

Ana koşul söz dizimi buradaaçıklanmıştır. Güvenli bir dosyanın belirtilen özelliğinin değerine erişmek için özelliği ('property-name') işlevini kullanın. Özellik ayarlanmadıysa null döndürür. Örneğin and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Proje kimliği veya proje adı

namePattern: string

Eşleşecek güvenli dosyanın adı. Birden çok dosyayla eşleşmesi için joker karakterler içerebilir.

Döndürülenler

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parametreler

job: TaskAgentPoolMaintenanceJob

poolId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parametreler

request: TaskAgentJobRequest

project: string

Proje kimliği veya proje adı

queueId: number

Döndürülenler

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parametreler

request: TaskAgentJobRequest

poolId: number

Döndürülenler

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parametreler

poolId: number

agentId: number

Döndürülenler

Promise<void>

refreshAgents(number)

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

Parametreler

poolId: number

Döndürülenler

Promise<void>

refreshDeploymentMachines(string, number)

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Döndürülenler

Promise<void>

refreshDeploymentTargets(string, number)

Dağıtım grubundaki dağıtım hedeflerini yükseltin.

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

Parametreler

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım grubunun kimliği.

Döndürülenler

Promise<void>

replaceAgent(TaskAgent, number, number)

Aracıyı değiştirin. Bu uç noktayı doğrudan çağırmak istemeyebilirsiniz. Bunun yerine aracıyı kuruluşunuzdan kaldırmak ve yeniden yapılandırmak için aracı yapılandırma betiğini kullanın.

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

Parametreler

agent: TaskAgent

Aracı değiştirme hakkındaki ayrıntılar güncelleştirildi

poolId: number

Kullanılacak aracı havuzu

agentId: number

Değiştirilecek aracı

Döndürülenler

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametreler

machine: DeploymentMachine

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineId: number

Döndürülenler

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Dağıtım grubundaki dağıtım hedeflerini değiştirin. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.

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

Parametreler

machine: DeploymentMachine

Yeni dağıtım hedefi.

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedefinin değiştirildiği dağıtım grubunun kimliği.

targetId: number

Değiştirecek dağıtım hedefinin kimliği.

Döndürülenler

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parametreler

message: TaskAgentMessage

poolId: number

requestId: number

Döndürülenler

Promise<void>

setAgentPoolMetadata(any, number)

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

Parametreler

agentPoolMetadata: any

poolId: number

Döndürülenler

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Değişken grubu ekleyin.

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

Parametreler

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Döndürülenler

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parametreler

taskGroup: TaskGroup

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Aracı ayrıntılarını güncelleştirin.

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

Parametreler

agent: TaskAgent

Aracı hakkındaki ayrıntılar güncelleştirildi

poolId: number

Kullanılacak aracı havuzu

agentId: number

Güncelleştirilecek aracı

Döndürülenler

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parametreler

updatedCloud: TaskAgentCloud

agentCloudId: number

Döndürülenler

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Aracı havuzundaki özellikleri güncelleştirme

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

Parametreler

pool: TaskAgentPool

Güncelleştirilmiş aracı havuzu ayrıntıları

poolId: number

Güncelleştirilecek aracı havuzu

Döndürülenler

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parametreler

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parametreler

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Döndürülenler

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parametreler

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Döndürülenler

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parametreler

poolId: number

agentId: number

currentState: string

Döndürülenler

Promise<TaskAgent>

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

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

Parametreler

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Döndürülenler

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Dağıtım grubunu güncelleştirme.

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

Parametreler

deploymentGroup: DeploymentGroupUpdateParameter

Güncelleştirilecek dağıtım grubu.

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım grubunun kimliği.

Döndürülenler

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametreler

machine: DeploymentMachine

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

machineId: number

Döndürülenler

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parametreler

machineGroup: DeploymentMachineGroup

project: string

Proje kimliği veya proje adı

machineGroupId: number

Döndürülenler

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parametreler

deploymentMachines: DeploymentMachine[]

project: string

Proje kimliği veya proje adı

machineGroupId: number

Döndürülenler

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parametreler

machines: DeploymentMachine[]

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Döndürülenler

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Dağıtım grubundaki dağıtım hedefini ve aracı özelliklerini güncelleştirin. Bu genellikle aracı yapılandırma aracı tarafından çağrılır.

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

Parametreler

machine: DeploymentMachine

Güncelleştirilecek dağıtım hedefi.

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedefinin güncelleştirildiği dağıtım grubunun kimliği.

targetId: number

Güncelleştirilecek dağıtım hedefinin kimliği.

Döndürülenler

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Dağıtım grubundaki dağıtım hedefleri listesinin etiketlerini güncelleştirin.

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

Parametreler

machines: DeploymentTargetUpdateParameter[]

Udpdate etiketleriyle dağıtım hedefleri.

project: string

Proje kimliği veya proje adı

deploymentGroupId: number

Dağıtım hedeflerinin güncelleştirildiği dağıtım grubunun kimliği.

Döndürülenler

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Belirtilen ortamı güncelleştirin.

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

Parametreler

environmentUpdateParameter: EnvironmentUpdateParameter

Güncelleştirilecek ortam verileri.

project: string

Proje kimliği veya proje adı

environmentId: number

Ortamın kimliği.

Döndürülenler

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Mevcut bir güvenli dosyanın adını veya özelliklerini güncelleştirme

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

Parametreler

secureFile: SecureFile

Güncelleştirilmiş ad ve/veya özelliklere sahip güvenli dosya

project: string

Proje kimliği veya proje adı

secureFileId: string

Benzersiz güvenli dosya kimliği

Döndürülenler

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Bir dizi güvenli dosya için özellikleri ve/veya adları güncelleştirin. Dosyalar kimlikleriyle tanımlanır. Sağlanan özellikler mevcut olanı tamamen geçersiz kılar; yani birleştirmez.

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

Parametreler

secureFiles: SecureFile[]

Güvenli dosya nesnelerinin listesi. Kimlik, Ad ve Özellikler alanlarından yalnızca üç tane doldurulmalıdır. Nesnedeki diğer alanlar yoksayılır.

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Görev grubunu güncelleştirme.

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

Parametreler

taskGroup: TaskGroupUpdateParameter

Güncelleştirilecek görev grubu.

project: string

Proje kimliği veya proje adı

taskGroupId: string

Güncelleştirilecek görev grubunun kimliği.

Döndürülenler

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parametreler

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Proje kimliği veya proje adı

taskGroupId: string

disablePriorVersions: boolean

Döndürülenler

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parametreler

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Döndürülenler

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Değişken grubunu güncelleştirme.

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

Parametreler

variableGroupParameters: VariableGroupParameters

groupId: number

Güncelleştirilecek değişken grubunun kimliği.

Döndürülenler

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parametreler

resource: VirtualMachineGroup

project: string

Proje kimliği veya proje adı

environmentId: number

Döndürülenler

Promise<VirtualMachineGroup>

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

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

Parametreler

machines: VirtualMachine[]

project: string

Proje kimliği veya proje adı

environmentId: number

resourceId: number

Döndürülenler

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Güvenli bir dosyayı karşıya yükleyin, dosya akışını istek gövdesine ekleyin

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

Parametreler

content: any

Karşıya yüklenecek içerik

project: string

Proje kimliği veya proje adı

name: string

Karşıya yüklenecek dosyanın adı

authorizePipelines: boolean

authorizePipelines true ise, güvenli dosya projedeki tüm işlem hatları tarafından kullanılmak üzere yetkilendirilmiştir.

Döndürülenler

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parametreler

inputValidationRequest: InputValidationRequest

Döndürülenler

Promise<InputValidationRequest>

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Aracılığıyla paylaş

TaskAgentRestClient class

Oluşturucular

Özellikler

Yöntemler

Oluşturucu Ayrıntıları

TaskAgentRestClient(IVssRestClientOptions)

Parametreler

Özellik Ayrıntıları

RESOURCE_AREA_ID

Özellik Değeri

Yöntem Ayrıntıları

addAgent(TaskAgent, number)

Parametreler

Döndürülenler

addAgentCloud(TaskAgentCloud)

Parametreler

Döndürülenler

addAgentPool(TaskAgentPool)

Parametreler

Döndürülenler

addAgentQueue(TaskAgentQueue, string, boolean)

Parametreler

Döndürülenler

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parametreler

Döndürülenler

addDeploymentMachine(DeploymentMachine, string, number)

Parametreler

Döndürülenler

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parametreler

Döndürülenler

addDeploymentTarget(DeploymentMachine, string, number)

Parametreler

Döndürülenler

addEnvironment(EnvironmentCreateParameter, string)

Parametreler

Döndürülenler

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parametreler

Döndürülenler

addTaskGroup(TaskGroupCreateParameter, string)

Parametreler

Döndürülenler

addVariableGroup(VariableGroupParameters)

Parametreler

Döndürülenler

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parametreler

Döndürülenler

createAgentSession(TaskAgentSession, number)

Parametreler

Döndürülenler

createTeamProject(string)

Parametreler

Döndürülenler

deleteAgent(number, number)

Parametreler

Döndürülenler

deleteAgentCloud(number)

Parametreler

Döndürülenler

deleteAgentPool(number)

Parametreler

Döndürülenler

deleteAgentPoolMaintenanceDefinition(number, number)

Parametreler

Döndürülenler

deleteAgentPoolMaintenanceJob(number, number)

Parametreler

Döndürülenler

deleteAgentQueue(number, string)

Parametreler