TaskAgentRestClient class

VSS REST API への要求を行うために使用する (派生する) 基本クラス

Extends

プロパティ

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)

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

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)

タスクグループをリストにしましょう。

getTaskGroupsByIds({[key: string]: string[]}, string, boolean)

タスクグループはIDやバージョン仕様で取得できます。

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)

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

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)

パラメーター

プロパティの詳細

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd" = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

プロパティ値

"a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

メソッドの詳細

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)

エージェントプールを作成しましょう。

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

パラメーター

pool
TaskAgentPool

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

返品

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

プロジェクトをエージェントプールに接続するための新しいエージェントキューを作成します。

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

パラメーター

queue
TaskAgentQueue

作成するキューの詳細

project

string

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

authorizePipelines

boolean

YAML使用時にこのキューを自動的に承認します

返品

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

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

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>

パラメーター

project

string

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

deploymentGroupId

number

返品

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

パラメーター

machineGroup
DeploymentMachineGroup
project

string

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

返品

addDeploymentTarget(DeploymentMachine, string, number)

展開対象を展開グループに登録します。 一般的にこれはエージェント設定ツールによって呼ばれます。

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

パラメーター

machine
DeploymentMachine

デプロイメントターゲットを登録してください。

project

string

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

deploymentGroupId

number

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

返品

addEnvironment(EnvironmentCreateParameter, string)

環境を作成します。

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

パラメーター

environmentCreateParameter
EnvironmentCreateParameter

創造のための環境。

project

string

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

返品

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

パラメーター

project

string

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

environmentId

number

返品

addTaskGroup(TaskGroupCreateParameter, string)

タスクグループを作成しましょう。

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>

パラメーター

project

string

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

environmentId

number

返品

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>

パラメーター

poolId

number

返品

createAgentSession(TaskAgentSession, number)

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

パラメーター

poolId

number

返品

Promise<TaskAgentSession>

createTeamProject(string)

新しいチームプロジェクトを作成しましょう。

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

パラメーター

project

string

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

返品

Promise<void>

deleteAgent(number, number)

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

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

ダウンロードが true の場合、ファイルは応答本文で添付ファイルとして送信されます。 ダウンロードが 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

返品

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

返品

getAgentPoolMaintenanceDefinitions(number)

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

パラメーター

poolId

number

返品

getAgentPoolMaintenanceJob(number, number)

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

パラメーター

poolId

number

jobId

number

返品

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

返品

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

返品

getAgentRequests(number, number, string)

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

パラメーター

poolId

number

top

number

continuationToken

string

返品

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

この時間以降に返信リクエストの日時。

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

返品

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>

返品

getAzureSubscriptions()

azureサブスクリプションのリストを戻します

function getAzureSubscriptions(): 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 のコンマ区切りの一覧。

返品

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

この継続トークンより大きい名前のデプロイグループに関する指標を辞書式で取得できます。

top

number

返すべき展開グループのメトリクスの最大数。 既定値は 50 です

返品

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

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

パラメーター

project

string

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

deploymentGroupId

number

machineId

number

返品

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

パラメーター

project

string

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

machineGroupId

number

返品

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

返品

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

返品

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

展開プールの概要リストを取得しましょう。

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

パラメーター

poolName

string

デプロイメントプールの名前です。

expands
DeploymentPoolSummaryExpands

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

poolIds

number[]

デプロイメントプールIDの一覧。

返品

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

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

返品

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

返品

getEnvironmentById(string, number, EnvironmentExpands)

IDで環境を把握しましょう。

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

パラメーター

project

string

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

environmentId

number

環境の ID。

expands
EnvironmentExpands

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

返品

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

返品

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

返品

getKubernetesResource(string, number, number)

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

パラメーター

project

string

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

environmentId

number

resourceId

number

返品

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

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

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

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

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

タスクグループを再帰的に展開するための「真」です。 既定値は 'false' です。

taskIdFilter

string

タスクIDのガイドでフィルターを絞り込みます。

deleted

boolean

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

top

number

タスクグループの数。

continuationToken

Date

継続トークンの後にタスクグループを取得します。

queryOrder
TaskGroupQueryOrder

定義された順序で結果を取得します。 デフォルトは「CreatedOnDescending」です。

返品

Promise<TaskGroup[]>

getTaskGroupsByIds({[key: string]: string[]}, string, boolean)

タスクグループはIDやバージョン仕様で取得できます。

function getTaskGroupsByIds(groupsVersionsMap: {[key: string]: string[]}, project: string, expand?: boolean): Promise<{[key: string]: TaskAgent.TaskGroup[]}>

パラメーター

groupsVersionsMap

{[key: string]: string[]}

グループIDをバージョンマップに。

project

string

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

expand

boolean

拡張すべき特性。 例 $expand=タスクは入れ子状のタスクグループを拡張します。

返品

Promise<{[key: string]: TaskGroup[]}>

getTaskHubLicenseDetails(string, boolean, boolean)

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

パラメーター

hubName

string

includeEnterpriseUsersCount

boolean

includeHostedAgentMinutesCount

boolean

返品

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

返品

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

返品

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

パラメーター

poolId

number

返品

queueAgentRequest(TaskAgentJobRequest, string, number)

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

パラメーター

project

string

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

queueId

number

返品

queueAgentRequestByPool(TaskAgentJobRequest, number)

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

パラメーター

poolId

number

返品

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)

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

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>

パラメーター

project

string

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

deploymentGroupId

number

machineId

number

返品

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。

返品

sendMessage(TaskAgentMessage, number, number)

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

パラメーター

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>

パラメーター

poolId

number

definitionId

number

返品

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

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

パラメーター

poolId

number

jobId

number

返品

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

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

パラメーター

poolId

number

requestId

number

lockToken

string

返品

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>

パラメーター

project

string

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

deploymentGroupId

number

machineId

number

返品

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

パラメーター

machineGroup
DeploymentMachineGroup
project

string

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

machineGroupId

number

返品

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。

返品

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。

返品

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

タスクグループの更新を許可してください。

返品

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

返品

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>

パラメーター

project

string

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

environmentId

number

返品

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

返品