TaskAgentRestClient class

Referencia

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatása) kell használni

Extends: RestClientBase

Konstruktorok

TaskAgentRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

addAgent(TaskAgent, number)	Ügynököt ad hozzá egy készlethez. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett konfiguráljon egy ügynököt az ügynök letöltési csomagjának használatával.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	ügynökkészlet Létrehozás.
addAgentQueue(TaskAgentQueue, string, boolean)	Létrehozás egy új ügynöksort egy projekt ügynökkészlethez való csatlakoztatásához.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	üzembe helyezési csoport Létrehozás.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Üzembehelyezési cél regisztrálása egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.
addEnvironment(EnvironmentCreateParameter, string)	környezet Létrehozás.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	feladatcsoport Létrehozás.
addVariableGroup(VariableGroupParameters)	Adjon hozzá egy változócsoportot.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Létrehozás új csapatprojektet.
deleteAgent(number, number)	Ügynök törlése. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett az ügynökkonfigurációs szkripttel távolítson el egy ügynököt a szervezetből.
deleteAgentCloud(number)
deleteAgentPool(number)	Ügynökkészlet törlése.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Eltávolít egy ügynöksort egy projektből.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Üzembehelyezési csoport törlése.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Központi telepítési cél törlése egy üzembehelyezési csoportban. Ezzel az ügynököt is törli a társított üzembehelyezési készletből.
deleteEnvironment(string, number)	Törölje a megadott környezetet.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Biztonságos fájl törlése
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Tevékenységcsoport törlése.
deleteVariableGroup(number, string[])	Változócsoport törlése
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Biztonságos fájl letöltése azonosító alapján
generateDeploymentGroupAccessToken(string, number)	PAT-jogkivonat lekérése az üzembehelyezési célok kezeléséhez (konfigurálásához, eltávolításához, címkézéséhez) egy üzembehelyezési csoportban.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	PAT-jogkivonat lekérése az üzembehelyezési ügynökök kezeléséhez (konfigurálásához, eltávolításához, címkézéséhez) az üzembehelyezési készletben.
getAgent(number, number, boolean, boolean, boolean, string[])	Információk lekérése egy ügynökről.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Ügynökfelhő-típusok lekérése.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Információk lekérése egy ügynökkészletről.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Az ügynökkészletek listájának lekérése.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Az ügynökkészletek listájának lekérése.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Információk lekérése egy ügynök üzenetsoráról.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Az ügynöksorok listájának lekérése.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Ügynöksorok listájának lekérése az azonosítójuk alapján
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Ügynöksorok listájának lekérése a nevük alapján
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Ügynöksorok listájának lekérése készletazonosítók alapján
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)	Ügynökkérelmek lekérése egy üzembehelyezési célhoz.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Ügynökkérelmek lekérése listatelepítési célokhoz.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Ügynökök listájának lekérése.
getAzureManagementGroups()	Az Azure-előfizetések listáját adja vissza
getAzureSubscriptions()	Az Azure-előfizetések listáját adja vissza
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Üzembehelyezési csoport lekérése az azonosító alapján.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Az üzembehelyezési csoportok listájának lekérése név vagy azonosító alapján.
getDeploymentGroupsMetrics(string, string, string, number)	Az üzembehelyezési csoport metrikáinak listájának lekérése.
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[])	Lekérheti az üzembehelyezési készlet összefoglalóinak listáját.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Üzembehelyezési cél lekérése az azonosító alapján egy üzembehelyezési csoportban
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Lekérheti az üzembehelyezési csoportok üzembehelyezési céljainak listáját.
getEnvironmentById(string, number, EnvironmentExpands)	Környezet lekérése az azonosító alapján.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	A környezet üzembe helyezésének végrehajtási előzményeinek lekérése
getEnvironments(string, string, string, number)	Az összes környezet lekérése.
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)	Biztonságos fájl lekérése
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Biztonságos fájlok lekérése
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Biztonságos fájlok lekérése
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Biztonságos fájlok lekérése
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Feladatcsoport lekérése.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Feladatcsoportok listázása.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Változócsoport lekérése.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Változócsoportok lekérése.
getVariableGroupsById(string, number[], boolean)	Változócsoportok lekérése azonosítók alapján.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	Szerezze be a Yaml-fájlérvényesítéshez használt Yaml-sémát.
hasPoolPermissions(number, number)	Ellenőrzi, hogy az aktuális identitás adott-e át engedélyeket egy készlethez.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	A "végpont" által definiált GET-kérés proxyja. A kérés szolgáltatáskapcsolat használatával van engedélyezve. A rendszer XPath/Json-alapú választóval szűri a választ.
querySecureFilesByProperties(string, string, string)	Biztonságos fájlok lekérdezése névmintával és a fájltulajdonságok feltételével.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Frissítse az üzembehelyezési célokat egy üzembehelyezési csoportban.
replaceAgent(TaskAgent, number, number)	Ügynök cseréje. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett az ügynökkonfigurációs szkripttel távolítson el és konfiguráljon újra egy ügynököt a szervezetből.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Cserélje le az üzembehelyezési célt egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Adjon hozzá egy változócsoportot.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Ügynök adatainak frissítése.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Ügynökkészlet tulajdonságainak frissítése
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)	Központi telepítési csoport frissítése.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Az üzembehelyezési cél és az ügynök tulajdonságainak frissítése egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Az üzembehelyezési csoportokban található üzembehelyezési célok listájának címkéinek frissítése.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Frissítse a megadott környezetet.
updateSecureFile(SecureFile, string, string)	Meglévő biztonságos fájl nevének vagy tulajdonságainak frissítése
updateSecureFiles(SecureFile[], string)	Biztonságos fájlok tulajdonságainak és/vagy nevének frissítése. A fájlokat azonosítójuk azonosítja. A megadott tulajdonságok felülbírálják a meglévőt, azaz nem egyesülnek.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Feladatcsoport frissítése.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Változócsoport frissítése.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Biztonságos fájl feltöltése, a fájlstream belefoglalása a kérelem törzsébe
validateInputs(InputValidationRequest)

Konstruktor adatai

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

addAgent(TaskAgent, number)

Ügynököt ad hozzá egy készlethez. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett konfiguráljon egy ügynököt az ügynök letöltési csomagjának használatával.

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

Paraméterek

agent: TaskAgent

A hozzáadott ügynök részletei

poolId: number

Az ügynökkészlet, amelyben hozzá szeretné adni az ügynököt

Válaszok

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Paraméterek

agentCloud: TaskAgentCloud

Válaszok

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

ügynökkészlet Létrehozás.

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

Paraméterek

pool: TaskAgentPool

Az új ügynökkészlet részletei

Válaszok

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Létrehozás egy új ügynöksort egy projekt ügynökkészlethez való csatlakoztatásához.

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

Paraméterek

queue: TaskAgentQueue

A létrehozandó üzenetsor részletei

project: string

Projektazonosító vagy projektnév

authorizePipelines: boolean

Üzenetsor automatikus engedélyezése YAML használata esetén

Válaszok

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

üzembe helyezési csoport Létrehozás.

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

Paraméterek

deploymentGroup: DeploymentGroupCreateParameter

Létrehozandó üzembe helyezési csoport.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Paraméterek

machine: DeploymentMachine

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Válaszok

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Paraméterek

machineGroup: DeploymentMachineGroup

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Üzembehelyezési cél regisztrálása egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.

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

Paraméterek

machine: DeploymentMachine

Üzembehelyezési cél a regisztrációhoz.

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyhez az üzembehelyezési cél regisztrálva van.

Válaszok

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

környezet Létrehozás.

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

Paraméterek

environmentCreateParameter: EnvironmentCreateParameter

Létrehozandó környezet.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Paraméterek

createParameters: KubernetesResourceCreateParameters

project: string

Projektazonosító vagy projektnév

environmentId: number

Válaszok

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

feladatcsoport Létrehozás.

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

Paraméterek

taskGroup: TaskGroupCreateParameter

Létrehozandó feladatcsoport-objektum.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Adjon hozzá egy változócsoportot.

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

Paraméterek

variableGroupParameters: VariableGroupParameters

Válaszok

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Paraméterek

createParameters: VirtualMachineGroupCreateParameters

project: string

Projektazonosító vagy projektnév

environmentId: number

Válaszok

Promise<VirtualMachineGroup>

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

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

Paraméterek

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Válaszok

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Paraméterek

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Válaszok

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Paraméterek

session: TaskAgentSession

poolId: number

Válaszok

Promise<TaskAgentSession>

createTeamProject(string)

Létrehozás új csapatprojektet.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

deleteAgent(number, number)

Ügynök törlése. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett az ügynökkonfigurációs szkripttel távolítson el egy ügynököt a szervezetből.

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

Paraméterek

poolId: number

Az ügynök eltávolítására vonatkozó készletazonosító

agentId: number

Az eltávolítandó ügynökazonosító

Válaszok

Promise<void>

deleteAgentCloud(number)

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

Paraméterek

agentCloudId: number

Válaszok

Promise<TaskAgentCloud>

deleteAgentPool(number)

Ügynökkészlet törlése.

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

Paraméterek

poolId: number

A törölni kívánt ügynökkészlet azonosítója

Válaszok

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Paraméterek

poolId: number

definitionId: number

Válaszok

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Paraméterek

poolId: number

jobId: number

Válaszok

Promise<void>

deleteAgentQueue(number, string)

Eltávolít egy ügynöksort egy projektből.

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

Paraméterek

queueId: number

Az eltávolítandó ügynök üzenetsora

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

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

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

Paraméterek

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Válaszok

Promise<void>

deleteAgentSession(number, string)

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

Paraméterek

poolId: number

sessionId: string

Válaszok

Promise<void>

deleteDeploymentGroup(string, number)

Üzembehelyezési csoport törlése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

A törölni kívánt üzembe helyezési csoport azonosítója.

Válaszok

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineId: number

Válaszok

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

machineGroupId: number

Válaszok

Promise<void>

deleteDeploymentTarget(string, number, number)

Központi telepítési cél törlése egy üzembehelyezési csoportban. Ezzel az ügynököt is törli a társított üzembehelyezési készletből.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyben az üzembe helyezési cél törlődik.

targetId: number

A törölni kívánt üzembehelyezési cél azonosítója.

Válaszok

Promise<void>

deleteEnvironment(string, number)

Törölje a megadott környezetet.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

A környezet azonosítója.

Válaszok

Promise<void>

deleteKubernetesResource(string, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

Válaszok

Promise<void>

deleteMessage(number, number, string)

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

Paraméterek

poolId: number

messageId: number

sessionId: string

Válaszok

Promise<void>

deleteSecureFile(string, string)

Biztonságos fájl törlése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

secureFileId: string

Az egyedi biztonságos fájlazonosító

Válaszok

Promise<void>

deleteTaskDefinition(string)

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

Paraméterek

taskId: string

Válaszok

Promise<void>

deleteTaskGroup(string, string, string)

Tevékenységcsoport törlése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

A törölni kívánt feladatcsoport azonosítója.

comment: string

Törölni kívánt megjegyzések.

Válaszok

Promise<void>

deleteVariableGroup(number, string[])

Változócsoport törlése

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

Paraméterek

groupId: number

A változócsoport azonosítója.

projectIds: string[]

Válaszok

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

Válaszok

Promise<void>

downloadSecureFile(string, string, string, boolean)

Biztonságos fájl letöltése azonosító alapján

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

Paraméterek

project: string

Projektazonosító vagy projektnév

secureFileId: string

Az egyedi biztonságos fájlazonosító

ticket: string

Érvényes letöltési jegy

download: boolean

Ha a letöltés igaz, a fájl csatolásként lesz elküldve a válasz törzsében. Ha a letöltés hamis, a válasz törzse tartalmazza a fájlstreamet.

Válaszok

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

PAT-jogkivonat lekérése az üzembehelyezési célok kezeléséhez (konfigurálásához, eltávolításához, címkézéséhez) egy üzembehelyezési csoportban.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyben az üzembehelyezési célokat kezelik.

Válaszok

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

machineGroupId: number

Válaszok

Promise<string>

generateDeploymentPoolAccessToken(number)

PAT-jogkivonat lekérése az üzembehelyezési ügynökök kezeléséhez (konfigurálásához, eltávolításához, címkézéséhez) az üzembehelyezési készletben.

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

Paraméterek

poolId: number

Annak az üzembehelyezési készletnek az azonosítója, amelyben az üzembehelyezési ügynököket kezelik.

Válaszok

Promise<string>

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

Információk lekérése egy ügynökről.

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

Paraméterek

poolId: number

Az ügynököt tartalmazó ügynökkészlet

agentId: number

Az ügynök azonosítója, amelyről információt szeretne kapni

includeCapabilities: boolean

Az ügynök képességeinek belefoglalása a válaszba

includeAssignedRequest: boolean

Az ügynök aktuális munkájával kapcsolatos részletek megadása

includeLastCompletedRequest: boolean

Szerepeljenek-e az ügynökök legutóbbi befejezett munkájával kapcsolatos részletek

propertyFilters: string[]

A visszaadott egyéni tulajdonságok szűrése

Válaszok

Promise<TaskAgent>

getAgentCloud(number)

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

Paraméterek

agentCloudId: number

Válaszok

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Paraméterek

agentCloudId: number

Válaszok

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Válaszok

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Ügynökfelhő-típusok lekérése.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Válaszok

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Információk lekérése egy ügynökkészletről.

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

Paraméterek

poolId: number

Ügynökkészlet azonosítója

properties: string[]

Ügynökkészlet tulajdonságai (vesszővel tagolt)

actionFilter: TaskAgentPoolActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Paraméterek

poolId: number

definitionId: number

Válaszok

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Paraméterek

poolId: number

Válaszok

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Paraméterek

poolId: number

jobId: number

Válaszok

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Paraméterek

poolId: number

jobId: number

Válaszok

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Paraméterek

poolId: number

definitionId: number

Válaszok

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Paraméterek

poolId: number

Válaszok

Promise<string>

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

Az ügynökkészletek listájának lekérése.

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

Paraméterek

poolName: string

Szűrés név alapján

properties: string[]

Szűrés ügynökkészlet tulajdonságai alapján (vesszővel elválasztva)

poolType: TaskAgentPoolType

Szűrés készlettípus szerint

actionFilter: TaskAgentPoolActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Az ügynökkészletek listájának lekérése.

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

Paraméterek

poolIds: number[]

beolvasandó készletazonosítók

actionFilter: TaskAgentPoolActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Információk lekérése egy ügynök üzenetsoráról.

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

Paraméterek

queueId: number

Az ügynök üzenetsora, amelyről információt szeretne kapni

project: string

Projektazonosító vagy projektnév

actionFilter: TaskAgentQueueActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Az ügynöksorok listájának lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

queueName: string

Szűrés az ügynök üzenetsorának nevére

actionFilter: TaskAgentQueueActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Ügynöksorok listájának lekérése az azonosítójuk alapján

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

Paraméterek

queueIds: number[]

A lekérendő ügynökvárólista-azonosítók vesszővel tagolt listája

project: string

Projektazonosító vagy projektnév

actionFilter: TaskAgentQueueActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Ügynöksorok listájának lekérése a nevük alapján

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

Paraméterek

queueNames: string[]

A lekérendő ügynöknevek vesszővel tagolt listája

project: string

Projektazonosító vagy projektnév

actionFilter: TaskAgentQueueActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Ügynöksorok listájának lekérése készletazonosítók alapján

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

Paraméterek

poolIds: number[]

Készletazonosítók vesszővel tagolt listája a megfelelő üzenetsorok lekéréséhez

project: string

Projektazonosító vagy projektnév

actionFilter: TaskAgentQueueActionFilter

Szűrés annak alapján, hogy a hívó felhasználó rendelkezik-e használati vagy kezelési engedélyekkel

Válaszok

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Paraméterek

poolId: number

requestId: number

includeStatus: boolean

Válaszok

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Paraméterek

poolId: number

top: number

continuationToken: string

Válaszok

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Paraméterek

poolId: number

agentId: number

completedRequestCount: number

Válaszok

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Paraméterek

poolId: number

agentIds: number[]

completedRequestCount: number

Válaszok

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineId: number

completedRequestCount: number

Válaszok

Promise<TaskAgentJobRequest[]>

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

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Válaszok

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Ügynökkérelmek lekérése egy üzembehelyezési célhoz.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyhez a cél tartozik.

targetId: number

Az üzembehelyezési cél azonosítója.

completedRequestCount: number

A visszaadni kívánt befejezett kérelmek maximális száma. Az alapértelmezett érték 50

Válaszok

Promise<TaskAgentJobRequest[]>

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

Ügynökkérelmek lekérése listatelepítési célokhoz.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyhez a célok tartoznak.

targetIds: number[]

Az üzembehelyezési célok azonosítóinak vesszővel tagolt listája.

ownerId: number

Az ügynökfeladat-kérelem tulajdonosának azonosítója.

completedOn: Date

Dátum/idő a kérés visszaadásához ennyi idő után.

completedRequestCount: number

Az egyes célokhoz visszaadandó befejezett kérelmek maximális száma. Az alapértelmezett érték 50

Válaszok

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Paraméterek

poolId: number

planId: string

jobId: string

Válaszok

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

queueId: number

top: number

continuationToken: string

Válaszok

Promise<PagedList<TaskAgentJobRequest>>

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

Ügynökök listájának lekérése.

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

Paraméterek

poolId: number

Az ügynököket tartalmazó ügynökkészlet

agentName: string

Szűrés az ügynök nevére

includeCapabilities: boolean

Az ügynökök képességeinek belefoglalása a válaszba

includeAssignedRequest: boolean

Az ügynökök aktuális munkájával kapcsolatos részletek megadása

includeLastCompletedRequest: boolean

Az ügynökök legutóbbi befejezett munkájával kapcsolatos részletek megadása

propertyFilters: string[]

A visszaadott egyéni tulajdonságok szűrése

demands: string[]

Az ügynökök által kielégíthető igények szerinti szűrés

Válaszok

Promise<TaskAgent[]>

getAzureManagementGroups()

Az Azure-előfizetések listáját adja vissza

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Válaszok

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Az Azure-előfizetések listáját adja vissza

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Válaszok

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Üzembehelyezési csoport lekérése az azonosító alapján.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Az üzembehelyezési csoport azonosítója.

actionFilter: DeploymentGroupActionFilter

Csak akkor kérje le az üzembehelyezési csoportot, ha ez a művelet végrehajtható rajta.

expand: DeploymentGroupExpands

Adja meg ezeket a további részleteket a visszaadott objektumban.

Válaszok

Promise<DeploymentGroup>

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

Az üzembehelyezési csoportok listájának lekérése név vagy azonosító alapján.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

name: string

Az üzembehelyezési csoport neve.

actionFilter: DeploymentGroupActionFilter

Csak azokat az üzembehelyezési csoportokat kérje le, amelyeken ez a művelet végrehajtható.

expand: DeploymentGroupExpands

Adja meg ezeket a további részleteket a visszaadott objektumokban.

continuationToken: string

Szerezze be a folytatásnál nagyobb nevű üzembehelyezési csoportokat Lexikálisan.

top: number

A visszaküldött üzembehelyezési csoportok maximális száma. Az alapértelmezett érték 1000.

ids: number[]

Az üzembehelyezési csoportok azonosítóinak vesszővel tagolt listája.

Válaszok

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Az üzembehelyezési csoport metrikáinak listájának lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupName: string

Az üzembehelyezési csoport neve.

continuationToken: string

A folytatásnál nagyobb nevű üzembehelyezési csoportok metrikáinak lekéréseToken lexikográfiailag.

top: number

Az üzembehelyezési csoport által visszaadandó metrikák maximális száma. Az alapértelmezett érték 50.

Válaszok

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Válaszok

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

machineGroupId: number

actionFilter: MachineGroupActionFilter

Válaszok

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Paraméterek

project: string

Projektazonosító vagy projektnév

machineGroupId: number

tagFilters: string[]

Válaszok

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

machineGroupName: string

actionFilter: MachineGroupActionFilter

Válaszok

Promise<DeploymentMachineGroup[]>

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

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Válaszok

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Lekérheti az üzembehelyezési készlet összefoglalóinak listáját.

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

Paraméterek

poolName: string

Az üzembehelyezési készlet neve.

expands: DeploymentPoolSummaryExpands

Adja meg ezeket a további részleteket a visszaadott objektumokban.

poolIds: number[]

Az üzembehelyezési készlet azonosítóinak listája.

Válaszok

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Üzembehelyezési cél lekérése az azonosító alapján egy üzembehelyezési csoportban

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyhez az üzembehelyezési cél tartozik.

targetId: number

A visszahelyezési cél azonosítója.

expand: DeploymentTargetExpands

Adja meg ezeket a további részleteket a visszaadott objektumokban.

Válaszok

Promise<DeploymentMachine>

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

Lekérheti az üzembehelyezési csoportok üzembehelyezési céljainak listáját.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Az üzembehelyezési csoport azonosítója.

tags: string[]

Csak azokat az üzembehelyezési célokat kérje le, amelyek a címkék vesszővel tagolt listáját tartalmazzák.

name: string

A visszaküldött üzembehelyezési célok névmintája.

partialNameMatch: boolean

Ha igaz értékre van állítva, a nevet mintaként kezeli. Máskülönben abszolút egyezésként kezeli. Az alapértelmezett érték hamis.

expand: DeploymentTargetExpands

Adja meg ezeket a további részleteket a visszaadott objektumokban.

agentStatus: TaskAgentStatusFilter

Csak az ilyen állapotú üzembehelyezési célokat kérje le.

agentJobResult: TaskAgentJobResultFilter

Csak azokat az üzembehelyezési célokat kérje le, amelyek az utolsó feladateredményt kapják.

continuationToken: string

Szerezze be a folytatásnál nagyobb nevű üzembehelyezési célokat Lexikálisan.

top: number

A visszaadandó üzembehelyezési célok maximális száma. Az alapértelmezett érték 1000.

enabled: boolean

Csak az engedélyezett vagy letiltott üzembehelyezési célokat kérje le. Az alapértelmezett érték a "null", amely az összes célt visszaadja.

propertyFilters: string[]

Válaszok

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Környezet lekérése az azonosító alapján.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

A környezet azonosítója.

expands: EnvironmentExpands

Adja meg ezeket a további részleteket a visszaadott objektumokban.

Válaszok

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

A környezet üzembe helyezésének végrehajtási előzményeinek lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

continuationToken: string

top: number

Válaszok

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Az összes környezet lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

name: string

continuationToken: string

top: number

Válaszok

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

Válaszok

Promise<KubernetesResource>

getMessage(number, string, number)

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

Paraméterek

poolId: number

sessionId: string

lastMessageId: number

Válaszok

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Paraméterek

packageType: string

platform: string

version: string

Válaszok

Promise<PackageMetadata>

getPackages(string, string, number)

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

Paraméterek

packageType: string

platform: string

top: number

Válaszok

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Válaszok

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Paraméterek

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Válaszok

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Biztonságos fájl lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

secureFileId: string

Az egyedi biztonságos fájlazonosító

includeDownloadTicket: boolean

Ha az includeDownloadTicket igaz, és a hívó rendelkezik engedélyekkel, a válasz egy letöltési jegyet tartalmaz.

actionFilter: SecureFileActionFilter

Válaszok

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Biztonságos fájlok lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

namePattern: string

Az egyeztetni kívánt biztonságos fájl neve. Több fájlnak megfelelő helyettesítő karaktereket is tartalmazhat.

includeDownloadTickets: boolean

Ha az includeDownloadTickets igaz, és a hívó rendelkezik engedélyekkel, a válasz minden biztonságos fájlhoz tartalmaz egy letöltési jegyet.

actionFilter: SecureFileActionFilter

Szűrés biztonságos fájlengedélyek alapján a Nézet, a Kezelés vagy a Használat művelethez. Alapértelmezés szerint a Nézet.

Válaszok

Promise<SecureFile[]>

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

Biztonságos fájlok lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

secureFileIds: string[]

A biztonságos fájlazonosítók listája

includeDownloadTickets: boolean

Ha az includeDownloadTickets igaz, és a hívó rendelkezik engedélyekkel, a válasz minden biztonságos fájlhoz tartalmaz egy letöltési jegyet.

actionFilter: SecureFileActionFilter

Válaszok

Promise<SecureFile[]>

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

Biztonságos fájlok lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

secureFileNames: string[]

A biztonságos fájlazonosítók listája

includeDownloadTickets: boolean

Ha az includeDownloadTickets igaz, és a hívó rendelkezik engedélyekkel, a válasz minden biztonságos fájlhoz tartalmaz egy letöltési jegyet.

actionFilter: SecureFileActionFilter

Válaszok

Promise<SecureFile[]>

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

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

Paraméterek

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Válaszok

Promise<ArrayBuffer>

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

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

Paraméterek

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Válaszok

Promise<TaskDefinition>

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

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

Paraméterek

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Válaszok

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Feladatcsoport lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

A feladatcsoport azonosítója.

versionSpec: string

a feladatcsoport verziós specifikációja. példák: 1, 1.0.

expand: TaskGroupExpands

A kibontandó tulajdonságok. példa $expand=A feladatok kibontják a beágyazott tevékenységcsoportokat.

Válaszok

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

Válaszok

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

revision: number

Válaszok

Promise<string>

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

Feladatcsoportok listázása.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

A feladatcsoport azonosítója.

expanded: boolean

"true" a feladatcsoportok rekurzív kibontásához. Az alapértelmezett érték a "false".

taskIdFilter: string

A szűrni kívánt feladatazonosító guid azonosítója.

deleted: boolean

"true" a törölt feladatcsoportok belefoglalásához. Az alapértelmezett érték a "false".

top: number

Lekérendő feladatcsoportok száma.

continuationToken: Date

Lekéri a feladatcsoportokat a megadott folytatási jogkivonat után.

queryOrder: TaskGroupQueryOrder

Lekéri az eredményeket a megadott sorrendben. Az alapértelmezett érték a "CreatedOnDescending".

Válaszok

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Paraméterek

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Válaszok

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Változócsoport lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

groupId: number

A változócsoport azonosítója.

Válaszok

Promise<VariableGroup>

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

Változócsoportok lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

groupName: string

Változócsoport neve.

actionFilter: VariableGroupActionFilter

A változócsoport műveletszűrője. Meghatározza a változócsoportokon végrehajtható műveletet.

top: number

A lekérendő változócsoportok száma.

continuationToken: number

Lekéri a változócsoportokat a megadott folytatási jogkivonat után.

queryOrder: VariableGroupQueryOrder

Lekéri az eredményeket a megadott sorrendben. Az alapértelmezett érték az "IdDescending".

Válaszok

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Változócsoportok lekérése azonosítók alapján.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

groupIds: number[]

Változócsoportok azonosítóinak vesszővel tagolt listája.

loadSecrets: boolean

Jelző, amely jelzi, hogy a változócsoportok titkos kódjait be kell-e tölteni.

Válaszok

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

Válaszok

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

Paraméterek

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Válaszok

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Válaszok

Promise<string>

getYamlSchema(boolean)

Szerezze be a Yaml-fájlérvényesítéshez használt Yaml-sémát.

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

Paraméterek

validateTaskNames: boolean

Azt, hogy a sémának ellenőriznie kell-e, hogy a tevékenységek ténylegesen telepítve vannak-e (olyan offline eszközök esetén hasznos, amelyeken nem szeretne ellenőrzést végezni).

Válaszok

Promise<any>

hasPoolPermissions(number, number)

Ellenőrzi, hogy az aktuális identitás adott-e át engedélyeket egy készlethez.

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

Paraméterek

poolId: number

Az ellenőrizni kívánt készlet azonosítója

permissions: number

Az ellenőrzéshez szükséges engedélyek. Több engedély egyesíthető egyetlen értékre a bitenkénti VAGY operátorral (pl. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Válaszok

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Paraméterek

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Projektazonosító vagy projektnév

parentTaskGroupId: string

Válaszok

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

A "végpont" által definiált GET-kérés proxyja. A kérés szolgáltatáskapcsolat használatával van engedélyezve. A rendszer XPath/Json-alapú választóval szűri a választ.

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

Paraméterek

endpoint: TaskDefinitionEndpoint

A beolvasandó URL-címet ismerteti.

Válaszok

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Biztonságos fájlok lekérdezése névmintával és a fájltulajdonságok feltételével.

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

Paraméterek

condition: string

A fő feltétel szintaxisát itt ismertetjük. A property('property-name') függvénnyel érheti el egy biztonságos fájl megadott tulajdonságának értékét. Null értéket ad vissza, ha a tulajdonság nincs beállítva. Pl. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Projektazonosító vagy projektnév

namePattern: string

Az egyeztetni kívánt biztonságos fájl neve. Több fájlnak megfelelő helyettesítő karaktereket is tartalmazhat.

Válaszok

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Paraméterek

job: TaskAgentPoolMaintenanceJob

poolId: number

Válaszok

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Paraméterek

request: TaskAgentJobRequest

project: string

Projektazonosító vagy projektnév

queueId: number

Válaszok

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Paraméterek

request: TaskAgentJobRequest

poolId: number

Válaszok

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Paraméterek

poolId: number

agentId: number

Válaszok

Promise<void>

refreshAgents(number)

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

Paraméterek

poolId: number

Válaszok

Promise<void>

refreshDeploymentMachines(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Válaszok

Promise<void>

refreshDeploymentTargets(string, number)

Frissítse az üzembehelyezési célokat egy üzembehelyezési csoportban.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Az üzembehelyezési csoport azonosítója.

Válaszok

Promise<void>

replaceAgent(TaskAgent, number, number)

Ügynök cseréje. Valószínűleg nem szeretné közvetlenül meghívni ezt a végpontot. Ehelyett az ügynökkonfigurációs szkripttel távolítson el és konfiguráljon újra egy ügynököt a szervezetből.

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

Paraméterek

agent: TaskAgent

Frissített részletek a csereügynökről

poolId: number

A használni kívánt ügynökkészlet

agentId: number

A lecserélendő ügynök

Válaszok

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Paraméterek

machine: DeploymentMachine

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineId: number

Válaszok

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Cserélje le az üzembehelyezési célt egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.

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

Paraméterek

machine: DeploymentMachine

Új üzembehelyezési cél.

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyben az üzembehelyezési cél lecserélődik.

targetId: number

A lecserélendő üzembehelyezési cél azonosítója.

Válaszok

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Paraméterek

message: TaskAgentMessage

poolId: number

requestId: number

Válaszok

Promise<void>

setAgentPoolMetadata(any, number)

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

Paraméterek

agentPoolMetadata: any

poolId: number

Válaszok

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Adjon hozzá egy változócsoportot.

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

Paraméterek

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Válaszok

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Paraméterek

taskGroup: TaskGroup

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Ügynök adatainak frissítése.

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

Paraméterek

agent: TaskAgent

Frissített adatok az ügynökről

poolId: number

A használni kívánt ügynökkészlet

agentId: number

A frissíteni kívánt ügynök

Válaszok

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Paraméterek

updatedCloud: TaskAgentCloud

agentCloudId: number

Válaszok

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Ügynökkészlet tulajdonságainak frissítése

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

Paraméterek

pool: TaskAgentPool

Frissített ügynökkészlet részletei

poolId: number

A frissíteni kívánt ügynökkészlet

Válaszok

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Paraméterek

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Válaszok

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Paraméterek

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Válaszok

Promise<TaskAgentPoolMaintenanceJob>

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

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

Paraméterek

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Válaszok

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Paraméterek

poolId: number

agentId: number

currentState: string

Válaszok

Promise<TaskAgent>

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

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

Paraméterek

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Válaszok

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Központi telepítési csoport frissítése.

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

Paraméterek

deploymentGroup: DeploymentGroupUpdateParameter

Frissítendő üzembehelyezési csoport.

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Az üzembehelyezési csoport azonosítója.

Válaszok

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Paraméterek

machine: DeploymentMachine

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

machineId: number

Válaszok

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Paraméterek

machineGroup: DeploymentMachineGroup

project: string

Projektazonosító vagy projektnév

machineGroupId: number

Válaszok

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Paraméterek

deploymentMachines: DeploymentMachine[]

project: string

Projektazonosító vagy projektnév

machineGroupId: number

Válaszok

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Paraméterek

machines: DeploymentMachine[]

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Válaszok

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Az üzembehelyezési cél és az ügynök tulajdonságainak frissítése egy üzembehelyezési csoportban. Ezt általában az ügynökkonfigurációs eszköz hívja meg.

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

Paraméterek

machine: DeploymentMachine

Frissítésre szolgáló üzembehelyezési cél.

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyben az üzembehelyezési cél frissül.

targetId: number

A frissíteni kívánt üzembehelyezési cél azonosítója.

Válaszok

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Az üzembehelyezési csoportokban található üzembehelyezési célok listájának címkéinek frissítése.

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

Paraméterek

machines: DeploymentTargetUpdateParameter[]

Üzembehelyezési célok udpdate címkével.

project: string

Projektazonosító vagy projektnév

deploymentGroupId: number

Annak az üzembehelyezési csoportnak az azonosítója, amelyben az üzembehelyezési célok frissülnek.

Válaszok

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Frissítse a megadott környezetet.

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

Paraméterek

environmentUpdateParameter: EnvironmentUpdateParameter

Frissítendő környezeti adatok.

project: string

Projektazonosító vagy projektnév

environmentId: number

A környezet azonosítója.

Válaszok

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Meglévő biztonságos fájl nevének vagy tulajdonságainak frissítése

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

Paraméterek

secureFile: SecureFile

A biztonságos fájl frissített névvel és/vagy tulajdonságokkal

project: string

Projektazonosító vagy projektnév

secureFileId: string

Az egyedi biztonságos fájlazonosító

Válaszok

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Biztonságos fájlok tulajdonságainak és/vagy nevének frissítése. A fájlokat azonosítójuk azonosítja. A megadott tulajdonságok felülbírálják a meglévőt, azaz nem egyesülnek.

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

Paraméterek

secureFiles: SecureFile[]

A biztonságos fájlobjektumok listája. Csak három mezőt kell kitölteni: Azonosító, Név és Tulajdonságok. Az objektum többi mezője figyelmen kívül lesz hagyva.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Feladatcsoport frissítése.

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

Paraméterek

taskGroup: TaskGroupUpdateParameter

Frissítendő feladatcsoport.

project: string

Projektazonosító vagy projektnév

taskGroupId: string

A frissíteni kívánt feladatcsoport azonosítója.

Válaszok

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Paraméterek

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Projektazonosító vagy projektnév

taskGroupId: string

disablePriorVersions: boolean

Válaszok

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Paraméterek

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Válaszok

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Változócsoport frissítése.

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

Paraméterek

variableGroupParameters: VariableGroupParameters

groupId: number

A frissíteni kívánt változócsoport azonosítója.

Válaszok

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Paraméterek

resource: VirtualMachineGroup

project: string

Projektazonosító vagy projektnév

environmentId: number

Válaszok

Promise<VirtualMachineGroup>

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

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

Paraméterek

machines: VirtualMachine[]

project: string

Projektazonosító vagy projektnév

environmentId: number

resourceId: number

Válaszok

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Biztonságos fájl feltöltése, a fájlstream belefoglalása a kérelem törzsébe

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

Paraméterek

content: any

Feltöltendő tartalom

project: string

Projektazonosító vagy projektnév

name: string

A feltöltendő fájl neve

authorizePipelines: boolean

Ha az authorizePipelines értéke igaz, akkor a biztonságos fájl a projekt összes folyamata számára engedélyezett.

Válaszok

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Paraméterek

inputValidationRequest: InputValidationRequest

Válaszok

Promise<InputValidationRequest>

Megosztás a következőn keresztül:

TaskAgentRestClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

TaskAgentRestClient(IVssRestClientOptions)

Paraméterek

Tulajdonság adatai

RESOURCE_AREA_ID

Tulajdonság értéke

Metódus adatai

addAgent(TaskAgent, number)

Paraméterek

Válaszok

addAgentCloud(TaskAgentCloud)

Paraméterek

Válaszok

addAgentPool(TaskAgentPool)

Paraméterek

Válaszok

addAgentQueue(TaskAgentQueue, string, boolean)

Paraméterek

Válaszok

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Paraméterek

Válaszok

addDeploymentMachine(DeploymentMachine, string, number)

Paraméterek

Válaszok

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Paraméterek

Válaszok

addDeploymentTarget(DeploymentMachine, string, number)

Paraméterek

Válaszok

addEnvironment(EnvironmentCreateParameter, string)

Paraméterek

Válaszok

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Paraméterek

Válaszok

addTaskGroup(TaskGroupCreateParameter, string)

Paraméterek

Válaszok

addVariableGroup(VariableGroupParameters)

Paraméterek

Válaszok

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Paraméterek

Válaszok

createAgentSession(TaskAgentSession, number)

Paraméterek

Válaszok

createTeamProject(string)

Paraméterek

Válaszok

deleteAgent(number, number)

Paraméterek

Válaszok

deleteAgentCloud(number)

Paraméterek

Válaszok

deleteAgentPool(number)

Paraméterek

Válaszok

deleteAgentPoolMaintenanceDefinition(number, number)

Paraméterek

Válaszok

deleteAgentPoolMaintenanceJob(number, number)

Paraméterek

Válaszok

deleteAgentQueue(number, string)

Paraméterek