TaskAgentRestClient class

リファレンス

パッケージ:: azure-devops-extension-api

VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス

Extends: RestClientBase

コンストラクター

TaskAgentRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

addAgent(TaskAgent, number)	エージェントをプールに追加します。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェントダウンロードパッケージを使用してエージェントを構成します。
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	エージェントプールをCreateします。
addAgentQueue(TaskAgentQueue, string, boolean)	新しいエージェントキューをCreateして、プロジェクトをエージェントプールに接続します。
addDeploymentGroup(DeploymentGroupCreateParameter, string)	デプロイグループをCreateします。
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	デプロイターゲットをデプロイグループに登録します。通常、これはエージェント構成ツールによって呼び出されます。
addEnvironment(EnvironmentCreateParameter, string)	環境を作成します。
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	タスクグループをCreateします。
addVariableGroup(VariableGroupParameters)	変数グループを追加します。
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	新しいチームプロジェクトをCreateします。
deleteAgent(number, number)	エージェントを削除します。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェント構成スクリプトを使用して、organizationからエージェントを削除します。
deleteAgentCloud(number)
deleteAgentPool(number)	エージェントプールを削除します。
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	プロジェクトからエージェントキューを削除します。
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	デプロイグループを削除します。
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	デプロイグループ内のデプロイターゲットを削除します。これにより、関連付けられているデプロイプールからもエージェントが削除されます。
deleteEnvironment(string, number)	指定した環境を削除します。
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	セキュリティで保護されたファイルを削除する
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	タスクグループを削除します。
deleteVariableGroup(number, string[])	変数グループを削除する
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	ID でセキュリティで保護されたファイルをダウンロードする
generateDeploymentGroupAccessToken(string, number)	デプロイグループ内のデプロイターゲットを管理 (構成、削除、タグ付け) するための PAT トークンを取得します。
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	デプロイプール内のデプロイエージェントを管理 (構成、削除、タグ付け) するための PAT トークンを取得します。
getAgent(number, number, boolean, boolean, boolean, string[])	エージェントに関する情報を取得します。
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	エージェントクラウドの種類を取得します。
getAgentPool(number, string[], TaskAgentPoolActionFilter)	エージェントプールに関する情報を取得します。
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	エージェントプールの一覧を取得します。
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	エージェントプールの一覧を取得します。
getAgentQueue(number, string, TaskAgentQueueActionFilter)	エージェントキューに関する情報を取得します。
getAgentQueues(string, string, TaskAgentQueueActionFilter)	エージェントキューの一覧を取得します。
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	エージェントキューの一覧を ID で取得する
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	エージェントキューの一覧を名前で取得する
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	プール ID でエージェントキューの一覧を取得する
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)	デプロイターゲットのエージェント要求を取得します。
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	リストデプロイターゲットのエージェント要求を取得します。
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	エージェントの一覧を取得します。
getAzureManagementGroups()	Azure サブスクリプションの一覧を返します
getAzureSubscriptions()	Azure サブスクリプションの一覧を返します
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	ID でデプロイグループを取得します。
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	名前または ID で展開グループの一覧を取得します。
getDeploymentGroupsMetrics(string, string, string, number)	デプロイグループメトリックの一覧を取得します。
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[])	デプロイプールの概要の一覧を取得します。
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	デプロイグループ内の ID でデプロイターゲットを取得する
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	デプロイグループ内のデプロイターゲットの一覧を取得します。
getEnvironmentById(string, number, EnvironmentExpands)	ID で環境を取得します。
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	環境デプロイの実行履歴を取得する
getEnvironments(string, string, string, number)	すべての環境を取得します。
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)	セキュリティで保護されたファイルを取得する
getSecureFiles(string, string, boolean, SecureFileActionFilter)	セキュリティで保護されたファイルを取得する
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	セキュリティで保護されたファイルを取得する
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	セキュリティで保護されたファイルを取得する
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	タスクグループを取得します。
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	タスクグループを一覧表示します。
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	変数グループを取得します。
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	変数グループを取得します。
getVariableGroupsById(string, number[], boolean)	ID で変数グループを取得します。
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	Yaml ファイルの検証に使用される Yaml スキーマを取得します。
hasPoolPermissions(number, number)	現在の ID がプールに対するアクセス許可に合格したかどうかを確認します。
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	"エンドポイント" によって定義された GET 要求のプロキシ。要求は、サービス接続を使用して承認されます。応答は、XPath/Json ベースのセレクターを使用してフィルター処理されます。
querySecureFilesByProperties(string, string, string)	名前パターンとファイルプロパティの条件を使用して、セキュリティで保護されたファイルに対してクエリを実行します。
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	デプロイグループ内のデプロイターゲットをアップグレードします。
replaceAgent(TaskAgent, number, number)	エージェントを置き換えます。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェント構成スクリプトを使用して、organizationからエージェントを削除して再構成します。
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	デプロイグループ内のデプロイターゲットを置き換えます。通常、これはエージェント構成ツールによって呼び出されます。
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	変数グループを追加します。
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	エージェントの詳細を更新します。
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	エージェントプールのプロパティを更新する
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)	デプロイグループを更新します。
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	デプロイグループ内のデプロイターゲットとそのエージェントプロパティを更新します。通常、これはエージェント構成ツールによって呼び出されます。
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	デプロイグループ内のデプロイターゲットの一覧のタグを更新します。
updateEnvironment(EnvironmentUpdateParameter, string, number)	指定した環境を更新します。
updateSecureFile(SecureFile, string, string)	既存のセキュリティで保護されたファイルの名前またはプロパティを更新する
updateSecureFiles(SecureFile[], string)	セキュリティで保護されたファイルのセットのプロパティや名前を更新します。ファイルは ID によって識別されます。指定されたプロパティは、既存のプロパティを完全にオーバーライドします。つまり、マージしません。
updateTaskGroup(TaskGroupUpdateParameter, string, string)	タスクグループを更新します。
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	変数グループを更新します。
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	セキュリティで保護されたファイルをアップロードし、要求本文にファイルストリームを含める
validateInputs(InputValidationRequest)

コンストラクターの詳細

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

パラメーター

options: IVssRestClientOptions

プロパティの詳細

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

プロパティ値

string

メソッドの詳細

addAgent(TaskAgent, number)

エージェントをプールに追加します。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェントダウンロードパッケージを使用してエージェントを構成します。

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

パラメーター

agent: TaskAgent

追加されるエージェントの詳細

poolId: number

エージェントを追加するエージェントプール

戻り値

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

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

パラメーター

agentCloud: TaskAgentCloud

戻り値

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

エージェントプールをCreateします。

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

パラメーター

pool: TaskAgentPool

新しいエージェントプールの詳細

戻り値

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

新しいエージェントキューをCreateして、プロジェクトをエージェントプールに接続します。

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

パラメーター

queue: TaskAgentQueue

作成するキューの詳細

project: string

プロジェクト ID またはプロジェクト名

authorizePipelines: boolean

YAML を使用するときにこのキューを自動的に承認する

戻り値

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

デプロイグループをCreateします。

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

パラメーター

deploymentGroup: DeploymentGroupCreateParameter

作成するデプロイグループ。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

パラメーター

machine: DeploymentMachine

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

戻り値

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

パラメーター

machineGroup: DeploymentMachineGroup

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

デプロイターゲットをデプロイグループに登録します。通常、これはエージェント構成ツールによって呼び出されます。

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

パラメーター

machine: DeploymentMachine

登録するデプロイターゲット。

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが登録されているデプロイグループの ID。

戻り値

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

環境を作成します。

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

パラメーター

environmentCreateParameter: EnvironmentCreateParameter

作成する環境。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

パラメーター

createParameters: KubernetesResourceCreateParameters

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

戻り値

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

タスクグループをCreateします。

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

パラメーター

taskGroup: TaskGroupCreateParameter

作成するタスクグループオブジェクト。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

変数グループを追加します。

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

パラメーター

variableGroupParameters: VariableGroupParameters

戻り値

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

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

パラメーター

createParameters: VirtualMachineGroupCreateParameters

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

戻り値

Promise<VirtualMachineGroup>

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

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

パラメーター

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

戻り値

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

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

パラメーター

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

戻り値

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

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

パラメーター

session: TaskAgentSession

poolId: number

戻り値

Promise<TaskAgentSession>

createTeamProject(string)

新しいチームプロジェクトをCreateします。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deleteAgent(number, number)

エージェントを削除します。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェント構成スクリプトを使用して、organizationからエージェントを削除します。

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

パラメーター

poolId: number

エージェントを削除するプール ID

agentId: number

削除するエージェント ID

戻り値

Promise<void>

deleteAgentCloud(number)

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

パラメーター

agentCloudId: number

戻り値

Promise<TaskAgentCloud>

deleteAgentPool(number)

エージェントプールを削除します。

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

パラメーター

poolId: number

削除するエージェントプールの ID

戻り値

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

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

パラメーター

poolId: number

definitionId: number

戻り値

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

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

パラメーター

poolId: number

jobId: number

戻り値

Promise<void>

deleteAgentQueue(number, string)

プロジェクトからエージェントキューを削除します。

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

パラメーター

queueId: number

削除するエージェントキュー

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

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

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

パラメーター

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

戻り値

Promise<void>

deleteAgentSession(number, string)

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

パラメーター

poolId: number

sessionId: string

戻り値

Promise<void>

deleteDeploymentGroup(string, number)

デプロイグループを削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

削除するデプロイグループの ID。

戻り値

Promise<void>

deleteDeploymentMachine(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineId: number

戻り値

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

戻り値

Promise<void>

deleteDeploymentTarget(string, number, number)

デプロイグループ内のデプロイターゲットを削除します。これにより、関連付けられているデプロイプールからもエージェントが削除されます。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが削除されるデプロイグループの ID。

targetId: number

削除するデプロイターゲットの ID。

戻り値

Promise<void>

deleteEnvironment(string, number)

指定した環境を削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

環境の ID。

戻り値

Promise<void>

deleteKubernetesResource(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

戻り値

Promise<void>

deleteMessage(number, number, string)

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

パラメーター

poolId: number

messageId: number

sessionId: string

戻り値

Promise<void>

deleteSecureFile(string, string)

セキュリティで保護されたファイルを削除する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

secureFileId: string

一意のセキュリティで保護されたファイル ID

戻り値

Promise<void>

deleteTaskDefinition(string)

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

パラメーター

taskId: string

戻り値

Promise<void>

deleteTaskGroup(string, string, string)

タスクグループを削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

削除するタスクグループの ID。

comment: string

削除するコメント。

戻り値

Promise<void>

deleteVariableGroup(number, string[])

変数グループを削除する

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

パラメーター

groupId: number

変数グループの ID。

projectIds: string[]

戻り値

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

戻り値

Promise<void>

downloadSecureFile(string, string, string, boolean)

ID でセキュリティで保護されたファイルをダウンロードする

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

secureFileId: string

一意のセキュリティで保護されたファイル ID

ticket: string

有効なダウンロードチケット

download: boolean

download が true の場合、ファイルは応答本文で添付ファイルとして送信されます。 download が false の場合、応答本文にはファイルストリームが含まれます。

戻り値

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

デプロイグループ内のデプロイターゲットを管理 (構成、削除、タグ付け) するための PAT トークンを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが管理されているデプロイグループの ID。

戻り値

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

戻り値

Promise<string>

generateDeploymentPoolAccessToken(number)

デプロイプール内のデプロイエージェントを管理 (構成、削除、タグ付け) するための PAT トークンを取得します。

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

パラメーター

poolId: number

デプロイエージェントが管理されている展開プールの ID。

戻り値

Promise<string>

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

エージェントに関する情報を取得します。

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

パラメーター

poolId: number

エージェントを含むエージェントプール

agentId: number

情報を取得するエージェント ID

includeCapabilities: boolean

エージェントの機能を応答に含めるかどうか

includeAssignedRequest: boolean

エージェントの現在の作業に関する詳細を含めるかどうか

includeLastCompletedRequest: boolean

エージェントの最新の完了した作業に関する詳細を含めるかどうか

propertyFilters: string[]

返されるカスタムプロパティをフィルター処理する

戻り値

Promise<TaskAgent>

getAgentCloud(number)

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

パラメーター

agentCloudId: number

戻り値

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

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

パラメーター

agentCloudId: number

戻り値

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

戻り値

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

エージェントクラウドの種類を取得します。

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

戻り値

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

エージェントプールに関する情報を取得します。

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

パラメーター

poolId: number

エージェントプール ID

properties: string[]

エージェントプールのプロパティ (コンマ区切り)

actionFilter: TaskAgentPoolActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

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

パラメーター

poolId: number

definitionId: number

戻り値

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

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

パラメーター

poolId: number

戻り値

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

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

パラメーター

poolId: number

jobId: number

戻り値

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

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

パラメーター

poolId: number

jobId: number

戻り値

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

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

パラメーター

poolId: number

definitionId: number

戻り値

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

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

パラメーター

poolId: number

戻り値

Promise<string>

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

エージェントプールの一覧を取得します。

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

パラメーター

poolName: string

名前でフィルター

properties: string[]

エージェントプールのプロパティでフィルター処理する (コンマ区切り)

poolType: TaskAgentPoolType

プールの種類でフィルター処理する

actionFilter: TaskAgentPoolActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

エージェントプールの一覧を取得します。

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

パラメーター

poolIds: number[]

フェッチするプール ID

actionFilter: TaskAgentPoolActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

エージェントキューに関する情報を取得します。

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

パラメーター

queueId: number

に関する情報を取得するエージェントキュー

project: string

プロジェクト ID またはプロジェクト名

actionFilter: TaskAgentQueueActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

エージェントキューの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

queueName: string

エージェントキュー名をフィルター処理する

actionFilter: TaskAgentQueueActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

エージェントキューの一覧を ID で取得する

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

パラメーター

queueIds: number[]

取得するエージェントキュー ID のコンマ区切りのリスト

project: string

プロジェクト ID またはプロジェクト名

actionFilter: TaskAgentQueueActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

エージェントキューの一覧を名前で取得する

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

パラメーター

queueNames: string[]

取得するエージェント名のコンマ区切りの一覧

project: string

プロジェクト ID またはプロジェクト名

actionFilter: TaskAgentQueueActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

プール ID でエージェントキューの一覧を取得する

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

パラメーター

poolIds: number[]

対応するキューを取得するプール ID のコンマ区切りの一覧

project: string

プロジェクト ID またはプロジェクト名

actionFilter: TaskAgentQueueActionFilter

呼び出し元のユーザーがアクセス許可を使用または管理しているかどうかをフィルター処理する

戻り値

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

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

パラメーター

poolId: number

requestId: number

includeStatus: boolean

戻り値

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

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

パラメーター

poolId: number

top: number

continuationToken: string

戻り値

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

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

パラメーター

poolId: number

agentId: number

completedRequestCount: number

戻り値

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

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

パラメーター

poolId: number

agentIds: number[]

completedRequestCount: number

戻り値

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineId: number

completedRequestCount: number

戻り値

Promise<TaskAgentJobRequest[]>

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

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

戻り値

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

デプロイターゲットのエージェント要求を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

ターゲットが属するデプロイグループの ID。

targetId: number

デプロイターゲットの ID。

completedRequestCount: number

返される完了した要求の最大数。既定値は 50 です

戻り値

Promise<TaskAgentJobRequest[]>

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

リストデプロイターゲットのエージェント要求を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

ターゲットが属するデプロイグループの ID。

targetIds: number[]

デプロイターゲットの ID のコンマ区切りの一覧。

ownerId: number

エージェントジョブ要求の所有者の ID。

completedOn: Date

この時刻より後に要求を返す Datetime。

completedRequestCount: number

各ターゲットに対して返される完了した要求の最大数。既定値は 50 です

戻り値

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

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

パラメーター

poolId: number

planId: string

jobId: string

戻り値

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

queueId: number

top: number

continuationToken: string

戻り値

Promise<PagedList<TaskAgentJobRequest>>

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

エージェントの一覧を取得します。

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

パラメーター

poolId: number

エージェントを含むエージェントプール

agentName: string

エージェント名でフィルター処理する

includeCapabilities: boolean

エージェントの機能を応答に含めるかどうか

includeAssignedRequest: boolean

エージェントの現在の作業に関する詳細を含めるかどうか

includeLastCompletedRequest: boolean

エージェントの最新の完了した作業に関する詳細を含めるかどうか

propertyFilters: string[]

返されるカスタムプロパティをフィルター処理する

demands: string[]

エージェントが満たすことができる要求でフィルター処理する

戻り値

Promise<TaskAgent[]>

getAzureManagementGroups()

Azure サブスクリプションの一覧を返します

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

戻り値

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Azure サブスクリプションの一覧を返します

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

戻り値

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

ID でデプロイグループを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイグループの ID。

actionFilter: DeploymentGroupActionFilter

このアクションを実行できる場合にのみ、デプロイグループを取得します。

expand: DeploymentGroupExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

戻り値

Promise<DeploymentGroup>

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

名前または ID で展開グループの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

name: string

デプロイグループの名前。

actionFilter: DeploymentGroupActionFilter

このアクションを実行できるデプロイグループのみを取得します。

expand: DeploymentGroupExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

continuationToken: string

この continuationToken よりも大きい名前のデプロイグループを辞書式で取得します。

top: number

返されるデプロイグループの最大数。既定値は 1000 です。

ids: number[]

デプロイグループの ID のコンマ区切りの一覧。

戻り値

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

デプロイグループメトリックの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupName: string

デプロイグループの名前。

continuationToken: string

この continuationToken より大きい名前を持つデプロイグループのメトリックを辞書式で取得します。

top: number

返されるデプロイグループメトリックの最大数。既定値は 50 です。

戻り値

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

戻り値

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

actionFilter: MachineGroupActionFilter

戻り値

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

tagFilters: string[]

戻り値

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

machineGroupName: string

actionFilter: MachineGroupActionFilter

戻り値

Promise<DeploymentMachineGroup[]>

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

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

戻り値

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

デプロイプールの概要の一覧を取得します。

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

パラメーター

poolName: string

デプロイプールの名前。

expands: DeploymentPoolSummaryExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

poolIds: number[]

デプロイプール ID の一覧。

戻り値

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

デプロイグループ内の ID でデプロイターゲットを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが属するデプロイグループの ID。

targetId: number

返すデプロイターゲットの ID。

expand: DeploymentTargetExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

戻り値

Promise<DeploymentMachine>

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

デプロイグループ内のデプロイターゲットの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイグループの ID。

tags: string[]

これらのコンマ区切りのタグの一覧をすべて含むデプロイターゲットのみを取得します。

name: string

返すデプロイターゲットの名前パターン。

partialNameMatch: boolean

true に設定すると、名前がパターンとして扱われます。それ以外の場合は、絶対一致として扱います。既定値は falseです。

expand: DeploymentTargetExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

agentStatus: TaskAgentStatusFilter

この状態のデプロイターゲットのみを取得します。

agentJobResult: TaskAgentJobResultFilter

この最後のジョブ結果を持つデプロイターゲットのみを取得します。

continuationToken: string

この continuationToken より大きい名前を持つデプロイターゲットを辞書式で取得します。

top: number

返されるデプロイターゲットの最大数。既定値は 1000 です。

enabled: boolean

有効または無効になっているデプロイターゲットのみを取得します。既定値は 'null' で、すべてのターゲットを返します。

propertyFilters: string[]

戻り値

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

ID で環境を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

環境の ID。

expands: EnvironmentExpands

返されるオブジェクトにこれらの追加の詳細を含めます。

戻り値

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

環境デプロイの実行履歴を取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

continuationToken: string

top: number

戻り値

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

すべての環境を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

name: string

continuationToken: string

top: number

戻り値

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

戻り値

Promise<KubernetesResource>

getMessage(number, string, number)

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

パラメーター

poolId: number

sessionId: string

lastMessageId: number

戻り値

Promise<TaskAgentMessage>

getPackage(string, string, string)

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

パラメーター

packageType: string

platform: string

version: string

戻り値

Promise<PackageMetadata>

getPackages(string, string, number)

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

パラメーター

packageType: string

platform: string

top: number

戻り値

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

戻り値

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

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

パラメーター

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

戻り値

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

セキュリティで保護されたファイルを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

secureFileId: string

一意のセキュリティで保護されたファイル ID

includeDownloadTicket: boolean

includeDownloadTicket が true で、呼び出し元にアクセス許可がある場合は、ダウンロードチケットが応答に含まれます。

actionFilter: SecureFileActionFilter

戻り値

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

セキュリティで保護されたファイルを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

namePattern: string

一致するセキュリティで保護されたファイルの名前。複数のファイルに一致するワイルドカードを含めることができます。

includeDownloadTickets: boolean

includeDownloadTickets が true で、呼び出し元にアクセス許可がある場合は、各セキュリティで保護されたファイルのダウンロードチケットが応答に含まれます。

actionFilter: SecureFileActionFilter

[表示]、[管理]、または [使用] アクションのセキュリティで保護されたファイルアクセス許可でフィルター処理します。既定値は [表示] です。

戻り値

Promise<SecureFile[]>

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

セキュリティで保護されたファイルを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

secureFileIds: string[]

セキュリティで保護されたファイル ID の一覧

includeDownloadTickets: boolean

actionFilter: SecureFileActionFilter

戻り値

Promise<SecureFile[]>

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

セキュリティで保護されたファイルを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

secureFileNames: string[]

セキュリティで保護されたファイル ID の一覧

includeDownloadTickets: boolean

actionFilter: SecureFileActionFilter

戻り値

Promise<SecureFile[]>

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

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

パラメーター

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

戻り値

Promise<ArrayBuffer>

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

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

パラメーター

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

戻り値

Promise<TaskDefinition>

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

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

パラメーター

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

戻り値

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

タスクグループを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

タスクグループの ID。

versionSpec: string

タスクグループのバージョン指定。例: 1、1.0。

expand: TaskGroupExpands

展開する必要があるプロパティ。例 $expand=タスクは、入れ子になったタスクグループを展開します。

戻り値

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

戻り値

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

revision: number

戻り値

Promise<string>

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

タスクグループを一覧表示します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

タスクグループの ID。

expanded: boolean

'true' を指定すると、タスクグループが再帰的に展開されます。既定値は 'false' です。

taskIdFilter: string

フィルター処理する taskId の Guid。

deleted: boolean

削除されたタスクグループを含める場合は 'true' です。既定値は 'false' です。

top: number

取得するタスクグループの数。

continuationToken: Date

継続トークンが指定された後のタスクグループを取得します。

queryOrder: TaskGroupQueryOrder

定義された順序で結果を取得します。既定値は 'CreatedOnDescending' です。

戻り値

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

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

パラメーター

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

戻り値

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

変数グループを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

groupId: number

変数グループの ID。

戻り値

Promise<VariableGroup>

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

変数グループを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

groupName: string

変数グループの名前。

actionFilter: VariableGroupActionFilter

変数グループのアクションフィルター。変数グループに対して実行できるアクションを指定します。

top: number

取得する変数グループの数。

continuationToken: number

継続トークンが指定された後の変数グループを取得します。

queryOrder: VariableGroupQueryOrder

定義された順序で結果を取得します。既定値は 'IdDescending' です。

戻り値

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

ID で変数グループを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

groupIds: number[]

変数グループの ID のコンマ区切りリスト。

loadSecrets: boolean

変数グループ内のシークレットを読み込む必要があるかどうかを示すフラグ。

戻り値

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

戻り値

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

戻り値

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

戻り値

Promise<string>

getYamlSchema(boolean)

Yaml ファイルの検証に使用される Yaml スキーマを取得します。

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

パラメーター

validateTaskNames: boolean

タスクが実際にインストールされていることをスキーマで検証する必要があるかどうか (検証が不要なオフラインツールに役立ちます)。

戻り値

Promise<any>

hasPoolPermissions(number, number)

現在の ID がプールに対するアクセス許可に合格したかどうかを確認します。

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

パラメーター

poolId: number

チェックするプールの ID

permissions: number

チェックへのアクセス許可。ビットごとの OR 演算子 (AgentPoolPermissions.Manage など) を使用して、複数のアクセス許可を 1 つの値にマージできます。AgentPoolPermissions.View)

戻り値

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

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

パラメーター

taskGroupMetadata: PublishTaskGroupMetadata

project: string

プロジェクト ID またはプロジェクト名

parentTaskGroupId: string

戻り値

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

"エンドポイント" によって定義された GET 要求のプロキシ。要求は、サービス接続を使用して承認されます。応答は、XPath/Json ベースのセレクターを使用してフィルター処理されます。

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

パラメーター

endpoint: TaskDefinitionEndpoint

フェッチする URL について説明します。

戻り値

Promise<string[]>

querySecureFilesByProperties(string, string, string)

名前パターンとファイルプロパティの条件を使用して、セキュリティで保護されたファイルに対してクエリを実行します。

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

パラメーター

condition: string

メイン条件の構文については、こちらを参照してください。 property('property-name') 関数を使用して、セキュリティで保護されたファイルの指定されたプロパティの値にアクセスします。プロパティが設定されていない場合は null を返します。例: and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

プロジェクト ID またはプロジェクト名

namePattern: string

一致するセキュリティで保護されたファイルの名前。複数のファイルに一致するワイルドカードを含めることができます。

戻り値

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

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

パラメーター

job: TaskAgentPoolMaintenanceJob

poolId: number

戻り値

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

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

パラメーター

request: TaskAgentJobRequest

project: string

プロジェクト ID またはプロジェクト名

queueId: number

戻り値

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

パラメーター

request: TaskAgentJobRequest

poolId: number

戻り値

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

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

パラメーター

poolId: number

agentId: number

戻り値

Promise<void>

refreshAgents(number)

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

パラメーター

poolId: number

戻り値

Promise<void>

refreshDeploymentMachines(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

戻り値

Promise<void>

refreshDeploymentTargets(string, number)

デプロイグループ内のデプロイターゲットをアップグレードします。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイグループの ID。

戻り値

Promise<void>

replaceAgent(TaskAgent, number, number)

エージェントを置き換えます。このエンドポイントを直接呼び出したくない場合があります。代わりに、エージェント構成スクリプトを使用して、organizationからエージェントを削除して再構成します。

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

パラメーター

agent: TaskAgent

置き換えエージェントに関する詳細を更新しました

poolId: number

使うエージェントプール

agentId: number

置き換えるエージェント

戻り値

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

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

パラメーター

machine: DeploymentMachine

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineId: number

戻り値

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

デプロイグループ内のデプロイターゲットを置き換えます。通常、これはエージェント構成ツールによって呼び出されます。

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

パラメーター

machine: DeploymentMachine

新しいデプロイターゲット。

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが置き換えられる展開グループの ID。

targetId: number

置き換えるデプロイターゲットの ID。

戻り値

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

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

パラメーター

message: TaskAgentMessage

poolId: number

requestId: number

戻り値

Promise<void>

setAgentPoolMetadata(any, number)

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

パラメーター

agentPoolMetadata: any

poolId: number

戻り値

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

変数グループを追加します。

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

パラメーター

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

戻り値

Promise<void>

undeleteTaskGroup(TaskGroup, string)

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

パラメーター

taskGroup: TaskGroup

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

エージェントの詳細を更新します。

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

パラメーター

agent: TaskAgent

エージェントに関する更新された詳細

poolId: number

使うエージェントプール

agentId: number

更新するエージェント

戻り値

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

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

パラメーター

updatedCloud: TaskAgentCloud

agentCloudId: number

戻り値

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

エージェントプールのプロパティを更新する

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

パラメーター

pool: TaskAgentPool

エージェントプールの詳細を更新しました

poolId: number

更新するエージェントプール

戻り値

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

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

パラメーター

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

戻り値

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

パラメーター

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

戻り値

Promise<TaskAgentPoolMaintenanceJob>

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

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

パラメーター

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

戻り値

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

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

パラメーター

poolId: number

agentId: number

currentState: string

戻り値

Promise<TaskAgent>

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

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

パラメーター

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

戻り値

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

デプロイグループを更新します。

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

パラメーター

deploymentGroup: DeploymentGroupUpdateParameter

更新する展開グループ。

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイグループの ID。

戻り値

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

パラメーター

machine: DeploymentMachine

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

machineId: number

戻り値

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

パラメーター

machineGroup: DeploymentMachineGroup

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

戻り値

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

パラメーター

deploymentMachines: DeploymentMachine[]

project: string

プロジェクト ID またはプロジェクト名

machineGroupId: number

戻り値

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

パラメーター

machines: DeploymentMachine[]

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

戻り値

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

デプロイグループ内のデプロイターゲットとそのエージェントプロパティを更新します。通常、これはエージェント構成ツールによって呼び出されます。

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

パラメーター

machine: DeploymentMachine

更新するデプロイターゲット。

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが更新される展開グループの ID。

targetId: number

更新するデプロイターゲットの ID。

戻り値

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

デプロイグループ内のデプロイターゲットの一覧のタグを更新します。

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

パラメーター

machines: DeploymentTargetUpdateParameter[]

udpdate へのタグを持つデプロイターゲット。

project: string

プロジェクト ID またはプロジェクト名

deploymentGroupId: number

デプロイターゲットが更新されるデプロイグループの ID。

戻り値

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

指定した環境を更新します。

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

パラメーター

environmentUpdateParameter: EnvironmentUpdateParameter

更新する環境データ。

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

環境の ID。

戻り値

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

既存のセキュリティで保護されたファイルの名前またはプロパティを更新する

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

パラメーター

secureFile: SecureFile

名前やプロパティが更新されたセキュリティで保護されたファイル

project: string

プロジェクト ID またはプロジェクト名

secureFileId: string

一意のセキュリティで保護されたファイル ID

戻り値

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

セキュリティで保護されたファイルのセットのプロパティや名前を更新します。ファイルは ID によって識別されます。指定されたプロパティは、既存のプロパティを完全にオーバーライドします。つまり、マージしません。

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

パラメーター

secureFiles: SecureFile[]

セキュリティで保護されたファイルオブジェクトの一覧。 Id、Name、および Properties を設定する必要があるフィールドは 3 つだけです。オブジェクト内の残りのフィールドは無視されます。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

タスクグループを更新します。

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

パラメーター

taskGroup: TaskGroupUpdateParameter

更新するタスクグループ。

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

更新するタスクグループの ID。

戻り値

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

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

パラメーター

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

プロジェクト ID またはプロジェクト名

taskGroupId: string

disablePriorVersions: boolean

戻り値

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

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

パラメーター

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

戻り値

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

変数グループを更新します。

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

パラメーター

variableGroupParameters: VariableGroupParameters

groupId: number

更新する変数グループの ID。

戻り値

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

パラメーター

resource: VirtualMachineGroup

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

戻り値

Promise<VirtualMachineGroup>

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

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

パラメーター

machines: VirtualMachine[]

project: string

プロジェクト ID またはプロジェクト名

environmentId: number

resourceId: number

戻り値

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

セキュリティで保護されたファイルをアップロードし、要求本文にファイルストリームを含める

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

パラメーター

content: any

アップロードするコンテンツ

project: string

プロジェクト ID またはプロジェクト名

name: string

アップロードするファイルの名前

authorizePipelines: boolean

authorizePipelines が true の場合、セキュリティで保護されたファイルはプロジェクト内のすべてのパイプラインで使用が承認されます。

戻り値

Promise<SecureFile>

validateInputs(InputValidationRequest)

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

パラメーター

inputValidationRequest: InputValidationRequest

戻り値

Promise<InputValidationRequest>

次の方法で共有

TaskAgentRestClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

TaskAgentRestClient(IVssRestClientOptions)

パラメーター

プロパティの詳細

RESOURCE_AREA_ID

プロパティ値

メソッドの詳細

addAgent(TaskAgent, number)

パラメーター

戻り値

addAgentCloud(TaskAgentCloud)

パラメーター

戻り値

addAgentPool(TaskAgentPool)

パラメーター

戻り値

addAgentQueue(TaskAgentQueue, string, boolean)

パラメーター

戻り値

addDeploymentGroup(DeploymentGroupCreateParameter, string)

パラメーター

戻り値

addDeploymentMachine(DeploymentMachine, string, number)

パラメーター

戻り値

addDeploymentMachineGroup(DeploymentMachineGroup, string)

パラメーター

戻り値

addDeploymentTarget(DeploymentMachine, string, number)

パラメーター

戻り値

addEnvironment(EnvironmentCreateParameter, string)

パラメーター

戻り値

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

パラメーター

戻り値

addTaskGroup(TaskGroupCreateParameter, string)

パラメーター

戻り値

addVariableGroup(VariableGroupParameters)

パラメーター

戻り値

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

パラメーター

戻り値

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

パラメーター

戻り値

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

パラメーター

戻り値

createAgentSession(TaskAgentSession, number)

パラメーター

戻り値

createTeamProject(string)

パラメーター

戻り値

deleteAgent(number, number)

パラメーター

戻り値

deleteAgentCloud(number)

パラメーター

戻り値

deleteAgentPool(number)

パラメーター

戻り値

deleteAgentPoolMaintenanceDefinition(number, number)

パラメーター

戻り値

deleteAgentPoolMaintenanceJob(number, number)

パラメーター

戻り値

deleteAgentQueue(number, string)

パラメーター