TaskAgentRestClient class

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie: RestClientBase

Konstruktory

TaskAgentRestClient(IVssRestClientOptions)

Właściwości

Metody

addAgent(TaskAgent, number)	Dodaje agenta do puli. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego skonfigurować agenta przy użyciu pakietu pobierania agenta.
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Utwórz pulę agentów.
addAgentQueue(TaskAgentQueue, string, boolean)	Utwórz nową kolejkę agentów, aby połączyć projekt z pulą agentów.
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Utwórz grupę wdrożenia.
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	Zarejestruj element docelowy wdrożenia w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.
addEnvironment(EnvironmentCreateParameter, string)	Utwórz środowisko.
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Utwórz grupę zadań.
addVariableGroup(VariableGroupParameters)	Dodaj grupę zmiennych.
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Utwórz nowy projekt zespołowy.
deleteAgent(number, number)	Usuwanie agenta. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego użyj skryptu konfiguracji agenta , aby usunąć agenta z organizacji.
deleteAgentCloud(number)
deleteAgentPool(number)	Usuń pulę agentów.
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	Usuwa kolejkę agenta z projektu.
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	Usuń grupę wdrożenia.
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	Usuń element docelowy wdrożenia w grupie wdrożenia. Spowoduje to również usunięcie agenta ze skojarzonej puli wdrożeń.
deleteEnvironment(string, number)	Usuń określone środowisko.
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	Usuwanie zabezpieczonego pliku
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	Usuwanie grupy zadań.
deleteVariableGroup(number, string[])	Usuwanie grupy zmiennych
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	Pobierz bezpieczny plik według identyfikatora
generateDeploymentGroupAccessToken(string, number)	POBIERZ token pat do zarządzania (konfigurowania, usuwania, tagowania) obiektów docelowych wdrożenia w grupie wdrożenia.
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	POBIERZ token pat do zarządzania (konfigurowania, usuwania, oznaczania) agentami wdrażania w puli wdrożeń.
getAgent(number, number, boolean, boolean, boolean, string[])	Uzyskaj informacje o agencie.
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	Pobierz typy chmur agentów.
getAgentPool(number, string[], TaskAgentPoolActionFilter)	Uzyskaj informacje o puli agentów.
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	Pobierz listę pul agentów.
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	Pobierz listę pul agentów.
getAgentQueue(number, string, TaskAgentQueueActionFilter)	Uzyskaj informacje o kolejce agenta.
getAgentQueues(string, string, TaskAgentQueueActionFilter)	Pobierz listę kolejek agentów.
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	Pobieranie listy kolejek agentów według ich identyfikatorów
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	Pobieranie listy kolejek agentów według ich nazw
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	Pobieranie listy kolejek agentów według identyfikatorów puli
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)	Pobieranie żądań agentów dla miejsca docelowego wdrożenia.
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	Pobierz żądania agentów dotyczące listy celów wdrożenia.
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	Pobierz listę agentów.
getAzureManagementGroups()	Zwraca listę subskrypcji platformy Azure
getAzureSubscriptions()	Zwraca listę subskrypcji platformy Azure
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	Pobierz grupę wdrożenia według jej identyfikatora.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	Pobierz listę grup wdrożeń według nazw lub identyfikatorów.
getDeploymentGroupsMetrics(string, string, string, number)	Pobierz listę metryk grupy wdrożenia.
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[])	Pobierz listę podsumowań puli wdrożeń.
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	Pobieranie docelowego wdrożenia według jego identyfikatora w grupie wdrożenia
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	Pobierz listę obiektów docelowych wdrożenia w grupie wdrożenia.
getEnvironmentById(string, number, EnvironmentExpands)	Pobierz środowisko według jego identyfikatora.
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	Pobieranie historii wykonywania wdrożeń środowiska
getEnvironments(string, string, string, number)	Korzystaj ze wszystkich środowisk.
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)	Zabezpiecz plik
getSecureFiles(string, string, boolean, SecureFileActionFilter)	Bezpieczne pliki
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	Bezpieczne pliki
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	Bezpieczne pliki
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	Pobierz grupę zadań.
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	Wyświetlanie listy grup zadań.
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	Pobierz grupę zmiennych.
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	Pobierz grupy zmiennych.
getVariableGroupsById(string, number[], boolean)	Pobierz grupy zmiennych według identyfikatorów.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	POBIERZ schemat Yaml używany do walidacji pliku Yaml.
hasPoolPermissions(number, number)	Sprawdza, czy bieżąca tożsamość przekazała uprawnienia do puli.
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	Serwer proxy dla żądania GET zdefiniowanego przez "punkt końcowy". Żądanie jest autoryzowane przy użyciu połączenia z usługą. Odpowiedź jest filtrowana przy użyciu selektora opartego na kodzie XPath/Json.
querySecureFilesByProperties(string, string, string)	Wypytuj o zabezpieczone pliki przy użyciu wzorca nazwy i warunku we właściwościach pliku.
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	Uaktualnij cele wdrożenia w grupie wdrożenia.
replaceAgent(TaskAgent, number, number)	Zastąp agenta. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego użyj skryptu konfiguracji agenta , aby usunąć i ponownie skonfigurować agenta z organizacji.
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	Zastąp element docelowy wdrożenia w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	Dodaj grupę zmiennych.
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	Aktualizowanie szczegółów agenta.
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	Aktualizowanie właściwości w puli agentów
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)	Aktualizowanie grupy wdrożenia.
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	Aktualizowanie obiektu docelowego wdrożenia i jego właściwości agenta w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	Aktualizowanie tagów listy obiektów docelowych wdrożenia w grupie wdrażania.
updateEnvironment(EnvironmentUpdateParameter, string, number)	Zaktualizuj określone środowisko.
updateSecureFile(SecureFile, string, string)	Aktualizowanie nazwy lub właściwości istniejącego bezpiecznego pliku
updateSecureFiles(SecureFile[], string)	Aktualizowanie właściwości i/lub nazw zestawu zabezpieczonych plików. Pliki są identyfikowane na podstawie ich identyfikatorów. Podane właściwości całkowicie zastępują istniejącą, tzn. nie są scalane.
updateTaskGroup(TaskGroupUpdateParameter, string, string)	Aktualizowanie grupy zadań.
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	Aktualizowanie grupy zmiennych.
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	Przekaż bezpieczny plik, dołącz strumień pliku do treści żądania
validateInputs(InputValidationRequest)

Szczegóły konstruktora

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addAgent(TaskAgent, number)

Dodaje agenta do puli. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego skonfigurować agenta przy użyciu pakietu pobierania agenta.

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

Parametry

agent: TaskAgent

Szczegółowe informacje o dodawanym agencie

poolId: number

Pula agentów, w której ma zostać dodany agent

Zwraca

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

Parametry

agentCloud: TaskAgentCloud

Zwraca

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Utwórz pulę agentów.

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

Parametry

pool: TaskAgentPool

Szczegółowe informacje o nowej puli agentów

Zwraca

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Utwórz nową kolejkę agentów, aby połączyć projekt z pulą agentów.

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

Parametry

queue: TaskAgentQueue

Szczegółowe informacje o kolejce do utworzenia

project: string

Identyfikator projektu lub nazwa projektu

authorizePipelines: boolean

Automatyczne autoryzowanie tej kolejki w przypadku korzystania z języka YAML

Zwraca

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Utwórz grupę wdrożenia.

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

Parametry

deploymentGroup: DeploymentGroupCreateParameter

Grupa wdrożenia do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

Parametry

machine: DeploymentMachine

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Zwraca

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

Parametry

machineGroup: DeploymentMachineGroup

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

Zarejestruj element docelowy wdrożenia w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.

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

Parametry

machine: DeploymentMachine

Cel wdrożenia do zarejestrowania.

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której jest zarejestrowany element docelowy wdrożenia.

Zwraca

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

Utwórz środowisko.

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

Parametry

environmentCreateParameter: EnvironmentCreateParameter

Środowisko do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

Parametry

createParameters: KubernetesResourceCreateParameters

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Zwraca

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Utwórz grupę zadań.

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

Parametry

taskGroup: TaskGroupCreateParameter

Obiekt grupy zadań do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

Dodaj grupę zmiennych.

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

Parametry

variableGroupParameters: VariableGroupParameters

Zwraca

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

Parametry

createParameters: VirtualMachineGroupCreateParameters

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Zwraca

Promise<VirtualMachineGroup>

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

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

Parametry

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Zwraca

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

Parametry

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Zwraca

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

Parametry

session: TaskAgentSession

poolId: number

Zwraca

Promise<TaskAgentSession>

createTeamProject(string)

Utwórz nowy projekt zespołowy.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deleteAgent(number, number)

Usuwanie agenta. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego użyj skryptu konfiguracji agenta , aby usunąć agenta z organizacji.

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

Parametry

poolId: number

Identyfikator puli, z której ma zostać usunięty agent

agentId: number

Identyfikator agenta do usunięcia

Zwraca

Promise<void>

deleteAgentCloud(number)

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

Parametry

agentCloudId: number

Zwraca

Promise<TaskAgentCloud>

deleteAgentPool(number)

Usuń pulę agentów.

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

Parametry

poolId: number

Identyfikator puli agentów do usunięcia

Zwraca

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

Parametry

poolId: number

definitionId: number

Zwraca

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

Parametry

poolId: number

jobId: number

Zwraca

Promise<void>

deleteAgentQueue(number, string)

Usuwa kolejkę agenta z projektu.

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

Parametry

queueId: number

Kolejka agenta do usunięcia

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

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

Parametry

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Zwraca

Promise<void>

deleteAgentSession(number, string)

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

Parametry

poolId: number

sessionId: string

Zwraca

Promise<void>

deleteDeploymentGroup(string, number)

Usuń grupę wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, która ma zostać usunięta.

Zwraca

Promise<void>

deleteDeploymentMachine(string, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineId: number

Zwraca

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

Zwraca

Promise<void>

deleteDeploymentTarget(string, number, number)

Usuń element docelowy wdrożenia w grupie wdrożenia. Spowoduje to również usunięcie agenta ze skojarzonej puli wdrożeń.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której jest usuwany element docelowy wdrożenia.

targetId: number

Identyfikator miejsca docelowego wdrożenia do usunięcia.

Zwraca

Promise<void>

deleteEnvironment(string, number)

Usuń określone środowisko.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Identyfikator środowiska.

Zwraca

Promise<void>

deleteKubernetesResource(string, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

Zwraca

Promise<void>

deleteMessage(number, number, string)

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

Parametry

poolId: number

messageId: number

sessionId: string

Zwraca

Promise<void>

deleteSecureFile(string, string)

Usuwanie zabezpieczonego pliku

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

secureFileId: string

Unikalny identyfikator bezpiecznego pliku

Zwraca

Promise<void>

deleteTaskDefinition(string)

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

Parametry

taskId: string

Zwraca

Promise<void>

deleteTaskGroup(string, string, string)

Usuwanie grupy zadań.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

Identyfikator grupy zadań, która ma zostać usunięta.

comment: string

Komentarze do usunięcia.

Zwraca

Promise<void>

deleteVariableGroup(number, string[])

Usuwanie grupy zmiennych

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

Parametry

groupId: number

Identyfikator grupy zmiennych.

projectIds: string[]

Zwraca

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

Zwraca

Promise<void>

downloadSecureFile(string, string, string, boolean)

Pobierz bezpieczny plik według identyfikatora

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

secureFileId: string

Unikalny identyfikator bezpiecznego pliku

ticket: string

Ważny bilet do pobrania

download: boolean

Jeśli wartość download ma wartość true, plik jest wysyłany jako załącznik w treści odpowiedzi. Jeśli wartość pobierania ma wartość false, treść odpowiedzi zawiera strumień pliku.

Zwraca

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

POBIERZ token pat do zarządzania (konfigurowania, usuwania, tagowania) obiektów docelowych wdrożenia w grupie wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której zarządzane są obiekty docelowe wdrożenia.

Zwraca

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

Zwraca

Promise<string>

generateDeploymentPoolAccessToken(number)

POBIERZ token pat do zarządzania (konfigurowania, usuwania, oznaczania) agentami wdrażania w puli wdrożeń.

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

Parametry

poolId: number

Identyfikator puli wdrożeń, w której zarządza się agentami wdrażania.

Zwraca

Promise<string>

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

Uzyskaj informacje o agencie.

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

Parametry

poolId: number

Pula agentów zawierająca agenta

agentId: number

Identyfikator agenta, aby uzyskać informacje o

includeCapabilities: boolean

Czy uwzględnić możliwości agenta w odpowiedzi

includeAssignedRequest: boolean

Czy dołączyć szczegółowe informacje o bieżącej pracy agenta

includeLastCompletedRequest: boolean

Czy należy uwzględnić szczegółowe informacje o ostatniej ukończonej pracy agentów

propertyFilters: string[]

Filtruj, które właściwości niestandardowe zostaną zwrócone

Zwraca

Promise<TaskAgent>

getAgentCloud(number)

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

Parametry

agentCloudId: number

Zwraca

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

Parametry

agentCloudId: number

Zwraca

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Zwraca

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

Pobierz typy chmur agentów.

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Zwraca

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

Uzyskaj informacje o puli agentów.

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

Parametry

poolId: number

Identyfikator puli agentów

properties: string[]

Właściwości puli agentów (rozdzielane przecinkami)

actionFilter: TaskAgentPoolActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

Parametry

poolId: number

definitionId: number

Zwraca

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

Parametry

poolId: number

Zwraca

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

Parametry

poolId: number

jobId: number

Zwraca

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

Parametry

poolId: number

jobId: number

Zwraca

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

Parametry

poolId: number

definitionId: number

Zwraca

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

Parametry

poolId: number

Zwraca

Promise<string>

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

Pobierz listę pul agentów.

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

Parametry

poolName: string

Filtruj według nazwy

properties: string[]

Filtrowanie według właściwości puli agentów (rozdzielane przecinkami)

poolType: TaskAgentPoolType

Filtrowanie według typu puli

actionFilter: TaskAgentPoolActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

Pobierz listę pul agentów.

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

Parametry

poolIds: number[]

Identyfikatory puli do pobrania

actionFilter: TaskAgentPoolActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

Uzyskaj informacje o kolejce agenta.

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

Parametry

queueId: number

Kolejka agenta, w której można uzyskać informacje o

project: string

Identyfikator projektu lub nazwa projektu

actionFilter: TaskAgentQueueActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

Pobierz listę kolejek agentów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

queueName: string

Filtrowanie według nazwy kolejki agenta

actionFilter: TaskAgentQueueActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

Pobieranie listy kolejek agentów według ich identyfikatorów

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

Parametry

queueIds: number[]

Rozdzielona przecinkami lista identyfikatorów kolejek agentów do pobrania

project: string

Identyfikator projektu lub nazwa projektu

actionFilter: TaskAgentQueueActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

Pobieranie listy kolejek agentów według ich nazw

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

Parametry

queueNames: string[]

Rozdzielona przecinkami lista nazw agentów do pobrania

project: string

Identyfikator projektu lub nazwa projektu

actionFilter: TaskAgentQueueActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

Pobieranie listy kolejek agentów według identyfikatorów puli

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

Parametry

poolIds: number[]

Rozdzielona przecinkami lista identyfikatorów puli, dla których mają być pobierane odpowiednie kolejki

project: string

Identyfikator projektu lub nazwa projektu

actionFilter: TaskAgentQueueActionFilter

Filtrowanie według tego, czy użytkownik wywołujący ma uprawnienia do używania lub zarządzania

Zwraca

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

Parametry

poolId: number

requestId: number

includeStatus: boolean

Zwraca

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

Parametry

poolId: number

top: number

continuationToken: string

Zwraca

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

Parametry

poolId: number

agentId: number

completedRequestCount: number

Zwraca

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

Parametry

poolId: number

agentIds: number[]

completedRequestCount: number

Zwraca

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineId: number

completedRequestCount: number

Zwraca

Promise<TaskAgentJobRequest[]>

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

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Zwraca

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

Pobieranie żądań agentów dla miejsca docelowego wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, do której należy element docelowy.

targetId: number

Identyfikator miejsca docelowego wdrożenia.

completedRequestCount: number

Maksymalna liczba zrealizowanych żądań do zwrotu. Wartość domyślna to 50

Zwraca

Promise<TaskAgentJobRequest[]>

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

Pobierz żądania agentów dotyczące listy celów wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, do której należą obiekty docelowe.

targetIds: number[]

Rozdzielona przecinkami lista identyfikatorów obiektów docelowych wdrożenia.

ownerId: number

Identyfikator właściciela żądania zadania agenta.

completedOn: Date

Data/godzina zwrócenia żądania po tym czasie.

completedRequestCount: number

Maksymalna liczba ukończonych żądań do zwrócenia dla każdego elementu docelowego. Wartość domyślna to 50

Zwraca

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

Parametry

poolId: number

planId: string

jobId: string

Zwraca

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

queueId: number

top: number

continuationToken: string

Zwraca

Promise<PagedList<TaskAgentJobRequest>>

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

Pobierz listę agentów.

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

Parametry

poolId: number

Pula agentów zawierająca agentów

agentName: string

Filtruj według nazwy agenta

includeCapabilities: boolean

Czy uwzględnić możliwości agentów w odpowiedzi

includeAssignedRequest: boolean

Czy należy uwzględnić szczegółowe informacje o bieżącej pracy agentów

includeLastCompletedRequest: boolean

Czy należy uwzględnić szczegółowe informacje o ostatniej ukończonej pracy agentów

propertyFilters: string[]

Filtruj, które właściwości niestandardowe zostaną zwrócone

demands: string[]

Filtruj według wymagań, które agenci mogą spełnić

Zwraca

Promise<TaskAgent[]>

getAzureManagementGroups()

Zwraca listę subskrypcji platformy Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Zwraca

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Zwraca listę subskrypcji platformy Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Zwraca

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

Pobierz grupę wdrożenia według jej identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia.

actionFilter: DeploymentGroupActionFilter

Pobierz grupę wdrożenia tylko wtedy, gdy można wykonać tę akcję.

expand: DeploymentGroupExpands

Uwzględnij te dodatkowe szczegóły w zwróconym obiekcie.

Zwraca

Promise<DeploymentGroup>

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

Pobierz listę grup wdrożeń według nazw lub identyfikatorów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

name: string

Nazwa grupy wdrożenia.

actionFilter: DeploymentGroupActionFilter

Pobierz tylko grupy wdrożeń, dla których można wykonać tę akcję.

expand: DeploymentGroupExpands

Uwzględnij te dodatkowe szczegóły w zwracanych obiektach.

continuationToken: string

Pobierz grupy wdrożenia o nazwach większych niż ta kontynuacjaToken leksykograficznie.

top: number

Maksymalna liczba grup wdrożeń do zwrócenia. Wartość domyślna to 1000.

ids: number[]

Rozdzielona przecinkami lista identyfikatorów grup wdrożeń.

Zwraca

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

Pobierz listę metryk grupy wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupName: string

Nazwa grupy wdrożenia.

continuationToken: string

Pobierz leksykograficznie metryki dla grup wdrożeń o nazwach większych niż ten continuationToken.

top: number

Maksymalna liczba metryk grupy wdrożenia do zwrócenia. Wartość domyślna to 50.

Zwraca

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Zwraca

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

actionFilter: MachineGroupActionFilter

Zwraca

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

tagFilters: string[]

Zwraca

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

machineGroupName: string

actionFilter: MachineGroupActionFilter

Zwraca

Promise<DeploymentMachineGroup[]>

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

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Zwraca

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

Pobierz listę podsumowań puli wdrożeń.

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

Parametry

poolName: string

Nazwa puli wdrożenia.

expands: DeploymentPoolSummaryExpands

Uwzględnij te dodatkowe szczegóły w zwracanych obiektach.

poolIds: number[]

Lista identyfikatorów puli wdrożeń.

Zwraca

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

Pobieranie docelowego wdrożenia według jego identyfikatora w grupie wdrożenia

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, do której należy cel wdrożenia.

targetId: number

Identyfikator docelowego wdrożenia, który ma być zwrócony.

expand: DeploymentTargetExpands

Uwzględnij te dodatkowe szczegóły w zwracanych obiektach.

Zwraca

Promise<DeploymentMachine>

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

Pobierz listę obiektów docelowych wdrożenia w grupie wdrożenia.

function getDeploymentTargets(project: string, deploymentGroupId: number, tags?: string[], name?: string, partialNameMatch?: boolean, expand?: DeploymentTargetExpands, agentStatus?: TaskAgentStatusFilter, agentJobResult?: TaskAgentJobResultFilter, continuationToken?: string, top?: number, enabled?: boolean, propertyFilters?: string[]): Promise<PagedList<DeploymentMachine>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia.

tags: string[]

Pobierz tylko elementy docelowe wdrożenia zawierające listę tagów rozdzielonych przecinkami.

name: string

Wzorzec nazwy obiektów docelowych wdrożenia, który ma być zwracany.

partialNameMatch: boolean

W przypadku ustawienia wartości true nazwa jest traktowana jako wzorzec. Inne traktuje go jako bezwzględne dopasowanie. Wartość domyślna to false.

expand: DeploymentTargetExpands

Uwzględnij te dodatkowe szczegóły w zwracanych obiektach.

agentStatus: TaskAgentStatusFilter

Pobierz tylko elementy docelowe wdrożenia, które mają ten stan.

agentJobResult: TaskAgentJobResultFilter

Pobierz tylko obiekty docelowe wdrożenia, które mają ten ostatni wynik zadania.

continuationToken: string

Pobierz cele wdrożenia o nazwach większych niż ta kontynuacjaToken leksykograficznie.

top: number

Maksymalna liczba miejsc docelowych wdrożenia do zwrócenia. Wartość domyślna to 1000.

enabled: boolean

Pobierz tylko obiekty docelowe wdrożenia, które są włączone lub wyłączone. Wartość domyślna to "null", która zwraca wszystkie elementy docelowe.

propertyFilters: string[]

Zwraca

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

Pobierz środowisko według jego identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Identyfikator środowiska.

expands: EnvironmentExpands

Uwzględnij te dodatkowe szczegóły w zwracanych obiektach.

Zwraca

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

Pobieranie historii wykonywania wdrożeń środowiska

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

continuationToken: string

top: number

Zwraca

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

Korzystaj ze wszystkich środowisk.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

name: string

continuationToken: string

top: number

Zwraca

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

Zwraca

Promise<KubernetesResource>

getMessage(number, string, number)

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

Parametry

poolId: number

sessionId: string

lastMessageId: number

Zwraca

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

Parametry

packageType: string

platform: string

version: string

Zwraca

Promise<PackageMetadata>

getPackages(string, string, number)

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

Parametry

packageType: string

platform: string

top: number

Zwraca

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Zwraca

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

Parametry

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Zwraca

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

Zabezpiecz plik

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

secureFileId: string

Unikalny identyfikator bezpiecznego pliku

includeDownloadTicket: boolean

Jeśli parametr includeDownloadTicket ma wartość true, a obiekt wywołujący ma uprawnienia, w odpowiedzi zostanie uwzględniony bilet pobierania.

actionFilter: SecureFileActionFilter

Zwraca

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

Bezpieczne pliki

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

namePattern: string

Nazwa bezpiecznego pliku do dopasowania. Może zawierać symbole wieloznaczne pasujące do wielu plików.

includeDownloadTickets: boolean

Jeśli parametr includeDownloadTickets ma wartość true, a obiekt wywołujący ma uprawnienia, w odpowiedzi jest dołączany bilet pobierania dla każdego bezpiecznego pliku.

actionFilter: SecureFileActionFilter

Filtrowanie według uprawnień do bezpiecznych plików dla akcji Wyświetlanie, Zarządzanie lub Używanie. Wartość domyślna to Widok.

Zwraca

Promise<SecureFile[]>

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

Bezpieczne pliki

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

secureFileIds: string[]

Lista bezpiecznych identyfikatorów plików

includeDownloadTickets: boolean

Jeśli parametr includeDownloadTickets ma wartość true, a obiekt wywołujący ma uprawnienia, w odpowiedzi jest dołączany bilet pobierania dla każdego bezpiecznego pliku.

actionFilter: SecureFileActionFilter

Zwraca

Promise<SecureFile[]>

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

Bezpieczne pliki

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

secureFileNames: string[]

Lista bezpiecznych identyfikatorów plików

includeDownloadTickets: boolean

Jeśli parametr includeDownloadTickets ma wartość true, a obiekt wywołujący ma uprawnienia, w odpowiedzi jest dołączany bilet pobierania dla każdego bezpiecznego pliku.

actionFilter: SecureFileActionFilter

Zwraca

Promise<SecureFile[]>

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

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

Parametry

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Zwraca

Promise<ArrayBuffer>

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

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

Parametry

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Zwraca

Promise<TaskDefinition>

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

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

Parametry

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Zwraca

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

Pobierz grupę zadań.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

Identyfikator grupy zadań.

versionSpec: string

Specyfikacja wersji grupy zadań. Przykłady: 1, 1.0.

expand: TaskGroupExpands

Właściwości, które powinny zostać rozwinięte. przykład $expand=Zadania rozwiną zagnieżdżone grupy zadań.

Zwraca

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

Zwraca

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

revision: number

Zwraca

Promise<string>

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

Wyświetlanie listy grup zadań.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

Identyfikator grupy zadań.

expanded: boolean

"true", aby rekursywnie rozwijać grupy zadań. Wartość domyślna to "false".

taskIdFilter: string

Identyfikator Guid taskId do filtrowania.

deleted: boolean

'true', aby uwzględnić usunięte grupy zadań. Wartość domyślna to "false".

top: number

Liczba grup zadań do pobrania.

continuationToken: Date

Pobiera grupy zadań po podanym tokenie kontynuacji.

queryOrder: TaskGroupQueryOrder

Pobiera wyniki w zdefiniowanej kolejności. Wartość domyślna to "CreatedOnDescending".

Zwraca

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

Parametry

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Zwraca

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

Pobierz grupę zmiennych.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

groupId: number

Identyfikator grupy zmiennych.

Zwraca

Promise<VariableGroup>

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

Pobierz grupy zmiennych.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

groupName: string

Nazwa grupy zmiennych.

actionFilter: VariableGroupActionFilter

Filtr akcji dla grupy zmiennych. Określa akcję, która może zostać wykonana na grupach zmiennych.

top: number

Liczba grup zmiennych do pobrania.

continuationToken: number

Pobiera grupy zmiennych po podanym tokenie kontynuacji.

queryOrder: VariableGroupQueryOrder

Pobiera wyniki w zdefiniowanej kolejności. Wartość domyślna to "IdDescending".

Zwraca

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

Pobierz grupy zmiennych według identyfikatorów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

groupIds: number[]

Rozdzielona przecinkami lista identyfikatorów grup zmiennych.

loadSecrets: boolean

Flaga wskazująca, czy wpisy tajne w grupach zmiennych powinny zostać załadowane.

Zwraca

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

Zwraca

Promise<VirtualMachineGroup>

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

function getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise<PagedList<VirtualMachine>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Zwraca

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Zwraca

Promise<string>

getYamlSchema(boolean)

POBIERZ schemat Yaml używany do walidacji pliku Yaml.

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

Parametry

validateTaskNames: boolean

Określa, czy schemat powinien sprawdzać, czy zadania są faktycznie zainstalowane (przydatne w przypadku narzędzi w trybie offline, w których nie chcesz sprawdzać poprawności).

Zwraca

Promise<any>

hasPoolPermissions(number, number)

Sprawdza, czy bieżąca tożsamość przekazała uprawnienia do puli.

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

Parametry

poolId: number

Identyfikator puli do sprawdzenia

permissions: number

Uprawnienia do sprawdzania. Wiele uprawnień można scalić w jedną wartość przy użyciu operatora bitowego OR (np. AgentPoolPermissions.Manage | AgentPoolPermissions.View)

Zwraca

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

Parametry

taskGroupMetadata: PublishTaskGroupMetadata

project: string

Identyfikator projektu lub nazwa projektu

parentTaskGroupId: string

Zwraca

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

Serwer proxy dla żądania GET zdefiniowanego przez "punkt końcowy". Żądanie jest autoryzowane przy użyciu połączenia z usługą. Odpowiedź jest filtrowana przy użyciu selektora opartego na kodzie XPath/Json.

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

Parametry

endpoint: TaskDefinitionEndpoint

Opisuje adres URL do pobrania.

Zwraca

Promise<string[]>

querySecureFilesByProperties(string, string, string)

Wypytuj o zabezpieczone pliki przy użyciu wzorca nazwy i warunku we właściwościach pliku.

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

Parametry

condition: string

Składnia głównego warunku jest opisana tutaj. Użyj funkcji property('property-name'), aby uzyskać dostęp do wartości określonej właściwości bezpiecznego pliku. Zwraca wartość null, jeśli właściwość nie jest ustawiona. Na przykład. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

Identyfikator projektu lub nazwa projektu

namePattern: string

Nazwa bezpiecznego pliku do dopasowania. Może zawierać symbole wieloznaczne pasujące do wielu plików.

Zwraca

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

Parametry

job: TaskAgentPoolMaintenanceJob

poolId: number

Zwraca

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

Parametry

request: TaskAgentJobRequest

project: string

Identyfikator projektu lub nazwa projektu

queueId: number

Zwraca

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

Parametry

request: TaskAgentJobRequest

poolId: number

Zwraca

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

Parametry

poolId: number

agentId: number

Zwraca

Promise<void>

refreshAgents(number)

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

Parametry

poolId: number

Zwraca

Promise<void>

refreshDeploymentMachines(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Zwraca

Promise<void>

refreshDeploymentTargets(string, number)

Uaktualnij cele wdrożenia w grupie wdrożenia.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia.

Zwraca

Promise<void>

replaceAgent(TaskAgent, number, number)

Zastąp agenta. Prawdopodobnie nie chcesz bezpośrednio wywoływać tego punktu końcowego. Zamiast tego użyj skryptu konfiguracji agenta , aby usunąć i ponownie skonfigurować agenta z organizacji.

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

Parametry

agent: TaskAgent

Zaktualizowano szczegółowe informacje o czynniku zastępczym

poolId: number

Pula agentów do użycia

agentId: number

Czynnik do zastąpienia

Zwraca

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametry

machine: DeploymentMachine

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineId: number

Zwraca

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

Zastąp element docelowy wdrożenia w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.

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

Parametry

machine: DeploymentMachine

Nowy cel wdrożenia.

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której jest zastępowany element docelowy wdrożenia.

targetId: number

Identyfikator miejsca docelowego wdrożenia do zastąpienia.

Zwraca

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

Parametry

message: TaskAgentMessage

poolId: number

requestId: number

Zwraca

Promise<void>

setAgentPoolMetadata(any, number)

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

Parametry

agentPoolMetadata: any

poolId: number

Zwraca

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

Dodaj grupę zmiennych.

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

Parametry

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Zwraca

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

Parametry

taskGroup: TaskGroup

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

Aktualizowanie szczegółów agenta.

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

Parametry

agent: TaskAgent

Zaktualizowane informacje o agencie

poolId: number

Pula agentów do użycia

agentId: number

Agent do aktualizacji

Zwraca

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

Parametry

updatedCloud: TaskAgentCloud

agentCloudId: number

Zwraca

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

Aktualizowanie właściwości w puli agentów

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

Parametry

pool: TaskAgentPool

Zaktualizowane szczegóły puli agentów

poolId: number

Pula agentów do zaktualizowania

Zwraca

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

Parametry

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Zwraca

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

Parametry

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Zwraca

Promise<TaskAgentPoolMaintenanceJob>

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

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

Parametry

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Zwraca

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

Parametry

poolId: number

agentId: number

currentState: string

Zwraca

Promise<TaskAgent>

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

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

Parametry

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Zwraca

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

Aktualizowanie grupy wdrożenia.

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

Parametry

deploymentGroup: DeploymentGroupUpdateParameter

Grupa wdrożeniowa do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia.

Zwraca

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

Parametry

machine: DeploymentMachine

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

machineId: number

Zwraca

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

Parametry

machineGroup: DeploymentMachineGroup

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

Zwraca

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

Parametry

deploymentMachines: DeploymentMachine[]

project: string

Identyfikator projektu lub nazwa projektu

machineGroupId: number

Zwraca

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

Parametry

machines: DeploymentMachine[]

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Zwraca

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

Aktualizowanie obiektu docelowego wdrożenia i jego właściwości agenta w grupie wdrożenia. Zazwyczaj jest to wywoływane przez narzędzie do konfiguracji agenta.

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

Parametry

machine: DeploymentMachine

Element docelowy wdrożenia do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której jest aktualizowany element docelowy wdrożenia.

targetId: number

Identyfikator miejsca docelowego wdrożenia do zaktualizowania.

Zwraca

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

Aktualizowanie tagów listy obiektów docelowych wdrożenia w grupie wdrażania.

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

Parametry

machines: DeploymentTargetUpdateParameter[]

Cele wdrożenia z tagami na udpdate.

project: string

Identyfikator projektu lub nazwa projektu

deploymentGroupId: number

Identyfikator grupy wdrożenia, w której są aktualizowane cele wdrożenia.

Zwraca

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

Zaktualizuj określone środowisko.

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

Parametry

environmentUpdateParameter: EnvironmentUpdateParameter

Dane środowiska do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Identyfikator środowiska.

Zwraca

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

Aktualizowanie nazwy lub właściwości istniejącego bezpiecznego pliku

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

Parametry

secureFile: SecureFile

Bezpieczny plik ze zaktualizowaną nazwą i/lub właściwościami

project: string

Identyfikator projektu lub nazwa projektu

secureFileId: string

Unikalny identyfikator bezpiecznego pliku

Zwraca

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

Aktualizowanie właściwości i/lub nazw zestawu zabezpieczonych plików. Pliki są identyfikowane na podstawie ich identyfikatorów. Podane właściwości całkowicie zastępują istniejącą, tzn. nie są scalane.

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

Parametry

secureFiles: SecureFile[]

Lista bezpiecznych obiektów plików. Muszą być wypełnione tylko trzy pola: Id, Name i Properties. Pozostałe pola w obiekcie są ignorowane.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

Aktualizowanie grupy zadań.

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

Parametry

taskGroup: TaskGroupUpdateParameter

Grupa zadań do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

Identyfikator grupy zadań do zaktualizowania.

Zwraca

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

Parametry

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

disablePriorVersions: boolean

Zwraca

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

Parametry

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Zwraca

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

Aktualizowanie grupy zmiennych.

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

Parametry

variableGroupParameters: VariableGroupParameters

groupId: number

Identyfikator grupy zmiennych do zaktualizowania.

Zwraca

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

Parametry

resource: VirtualMachineGroup

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

Zwraca

Promise<VirtualMachineGroup>

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

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

Parametry

machines: VirtualMachine[]

project: string

Identyfikator projektu lub nazwa projektu

environmentId: number

resourceId: number

Zwraca

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

Przekaż bezpieczny plik, dołącz strumień pliku do treści żądania

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

Parametry

content: any

Zawartość do przekazania

project: string

Identyfikator projektu lub nazwa projektu

name: string

Nazwa pliku do przesłania

authorizePipelines: boolean

Jeśli authorizePipelines ma wartość true, bezpieczny plik jest autoryzowany do użycia przez wszystkie potoki w projekcie.

Zwraca

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

Parametry

inputValidationRequest: InputValidationRequest

Zwraca

Promise<InputValidationRequest>

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij za pomocą

TaskAgentRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

TaskAgentRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

addAgent(TaskAgent, number)

Parametry

Zwraca

addAgentCloud(TaskAgentCloud)

Parametry

Zwraca

addAgentPool(TaskAgentPool)

Parametry

Zwraca

addAgentQueue(TaskAgentQueue, string, boolean)

Parametry

Zwraca

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Parametry

Zwraca

addDeploymentMachine(DeploymentMachine, string, number)

Parametry

Zwraca

addDeploymentMachineGroup(DeploymentMachineGroup, string)

Parametry

Zwraca

addDeploymentTarget(DeploymentMachine, string, number)

Parametry

Zwraca

addEnvironment(EnvironmentCreateParameter, string)

Parametry

Zwraca

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

Parametry

Zwraca

addTaskGroup(TaskGroupCreateParameter, string)

Parametry

Zwraca

addVariableGroup(VariableGroupParameters)

Parametry

Zwraca

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

Parametry

Zwraca

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

Parametry

Zwraca

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

Parametry

Zwraca

createAgentSession(TaskAgentSession, number)

Parametry

Zwraca

createTeamProject(string)

Parametry

Zwraca

deleteAgent(number, number)

Parametry

Zwraca

deleteAgentCloud(number)

Parametry

Zwraca

deleteAgentPool(number)

Parametry

Zwraca

deleteAgentPoolMaintenanceDefinition(number, number)

Parametry

Zwraca

deleteAgentPoolMaintenanceJob(number, number)

Parametry

Zwraca

deleteAgentQueue(number, string)

Parametry