TaskAgentRestClient class

الحزمة:: azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد: RestClientBase

المنشئون

TaskAgentRestClient(IVssRestClientOptions)

الخصائص

الأساليب

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)	احصل على قائمة بقوائم انتظار الوكلاء حسب معرفاتهم
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	احصل على قائمة بقوائم انتظار الوكلاء حسب أسمائهم
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	الحصول على قائمة بقوائم انتظار الوكيل حسب معرفات التجمع
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)	احصل على مجموعة نشر حسب معرفها.
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	احصل على قائمة بمجموعات النشر حسب الاسم أو المعرفات.
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)	الحصول على هدف نشر حسب المعرف الخاص به في مجموعة نشر
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	احصل على قائمة بأهداف النشر في مجموعة توزيع.
getEnvironmentById(string, number, EnvironmentExpands)	احصل على بيئة من خلال معرفها.
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)	احصل على مجموعات متغيرة حسب المعرفات.
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	احصل على مخطط Yaml المستخدم للتحقق من صحة ملف Yaml.
hasPoolPermissions(number, number)	التحقق مما إذا كانت الهوية الحالية قد اجتازت الأذونات على مجموعة.
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)	تحديث خصائص و / أو أسماء مجموعة من الملفات الآمنة. يتم تحديد الملفات من خلال معرفاتها. تتجاوز الخصائص المقدمة الخصائص الحالية بالكامل ، أي لا تندمج.
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)

قم بإنشاء تجمع وكيل.

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

معرف المشروع أو اسم المشروع

authorizePipelines: boolean

تفويض قائمة الانتظار هذه تلقائيا عند استخدام YAML

المرتجعات

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

إنشاء مجموعة توزيع.

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

المعلمات

deploymentGroup: DeploymentGroupCreateParameter

مجموعة النشر المراد إنشاؤها.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

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

المعلمات

machine: DeploymentMachine

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

المرتجعات

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

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

المعلمات

machineGroup: DeploymentMachineGroup

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

تسجيل هدف توزيع في مجموعة توزيع. بشكل عام ، يتم استدعاء هذا بواسطة أداة تكوين العامل.

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

المعلمات

machine: DeploymentMachine

هدف النشر للتسجيل.

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي تم تسجيل هدف التوزيع فيها.

المرتجعات

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

إنشاء بيئة.

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

المعلمات

environmentCreateParameter: EnvironmentCreateParameter

بيئة لخلق.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

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

المعلمات

createParameters: KubernetesResourceCreateParameters

project: string

معرف المشروع أو اسم المشروع

environmentId: number

المرتجعات

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

إنشاء مجموعة مهام.

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

المعلمات

taskGroup: TaskGroupCreateParameter

كائن مجموعة المهام المراد إنشاؤه.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

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

معرف المشروع أو اسم المشروع

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)

إنشاء مشروع فريق جديد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<void>

deleteAgent(number, number)

حذف وكيل. ربما لا تريد استدعاء نقطة النهاية هذه مباشرة. بدلا من ذلك، استخدم البرنامج النصي لتكوين العامل لإزالة وكيل من مؤسستك.

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

المعلمات

poolId: number

معرف التجمع لإزالة العامل منه

agentId: number

معرف الوكيل المطلوب إزالته

المرتجعات

Promise<void>

deleteAgentCloud(number)

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

المعلمات

agentCloudId: number

المرتجعات

Promise<TaskAgentCloud>

deleteAgentPool(number)

حذف تجمع الوكلاء.

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

المعلمات

poolId: number

معرف تجمع الوكلاء المراد حذفه

المرتجعات

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

معرف المشروع أو اسم المشروع

المرتجعات

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر المراد حذفها.

المرتجعات

Promise<void>

deleteDeploymentMachine(string, number, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

machineId: number

المرتجعات

Promise<void>

deleteDeploymentMachineGroup(string, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

المرتجعات

Promise<void>

deleteDeploymentTarget(string, number, number)

حذف هدف توزيع في مجموعة توزيع. يؤدي هذا إلى حذف العامل من تجمع التوزيع المقترن أيضا.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة التوزيع التي يتم حذف هدف التوزيع فيها.

targetId: number

معرف هدف التوزيع المراد حذفه.

المرتجعات

Promise<void>

deleteEnvironment(string, number)

احذف البيئة المحددة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

environmentId: number

معرف البيئة.

المرتجعات

Promise<void>

deleteKubernetesResource(string, number, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

secureFileId: string

معرف الملف الآمن الفريد

المرتجعات

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

معرف المشروع أو اسم المشروع

taskGroupId: string

معرف مجموعة المهام المراد حذفها.

comment: string

التعليقات المراد حذفها.

المرتجعات

Promise<void>

deleteVariableGroup(number, string[])

حذف مجموعة متغيرات

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

المعلمات

groupId: number

معرف المجموعة المتغيرة.

projectIds: string[]

المرتجعات

Promise<void>

deleteVirtualMachineGroup(string, number, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

secureFileId: string

معرف الملف الآمن الفريد

ticket: string

تذكرة تنزيل صالحة

download: boolean

إذا كان التنزيل صحيحا، إرسال الملف كمرفق في نص الاستجابة. إذا كان التنزيل خطأ، فسيحتوي نص الاستجابة على دفق الملف.

المرتجعات

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

احصل على رمز PAT المميز لإدارة (تكوين وإزالة ووضع علامات) على أهداف التوزيع في مجموعة توزيع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي تتم فيها إدارة أهداف التوزيع.

المرتجعات

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

المرتجعات

Promise<string>

generateDeploymentPoolAccessToken(number)

احصل على رمز PAT المميز لإدارة (تكوين وإزالة ووضع علامات) على وكلاء التوزيع في تجمع التوزيع.

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

المعلمات

poolId: number

معرف تجمع التوزيع الذي تتم فيه إدارة وكلاء التوزيع.

المرتجعات

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

معرف الوكيل للحصول على معلومات حول

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

معرف تجمع الوكيل

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

معرفات المجمع المراد جلبها

actionFilter: TaskAgentPoolActionFilter

التصفية حسب ما إذا كان المستخدم المتصل لديه أذونات استخدام أو إدارة

المرتجعات

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

احصل على معلومات حول قائمة انتظار الوكيل.

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

المعلمات

queueId: number

قائمة انتظار الوكيل للحصول على معلومات حول

project: string

معرف المشروع أو اسم المشروع

actionFilter: TaskAgentQueueActionFilter

التصفية حسب ما إذا كان المستخدم المتصل لديه أذونات استخدام أو إدارة

المرتجعات

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

احصل على قائمة بقوائم انتظار الوكيل.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

queueName: string

تصفية على اسم قائمة انتظار الوكيل

actionFilter: TaskAgentQueueActionFilter

التصفية حسب ما إذا كان المستخدم المتصل لديه أذونات استخدام أو إدارة

المرتجعات

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

احصل على قائمة بقوائم انتظار الوكلاء حسب معرفاتهم

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

المعلمات

queueIds: number[]

قائمة مفصولة بفواصل لمعرفات قائمة انتظار الوكيل لاستردادها

project: string

معرف المشروع أو اسم المشروع

actionFilter: TaskAgentQueueActionFilter

التصفية حسب ما إذا كان المستخدم المتصل لديه أذونات استخدام أو إدارة

المرتجعات

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

احصل على قائمة بقوائم انتظار الوكلاء حسب أسمائهم

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

المعلمات

queueNames: string[]

قائمة مفصولة بفواصل لأسماء الوكلاء المراد استردادها

project: string

معرف المشروع أو اسم المشروع

actionFilter: TaskAgentQueueActionFilter

التصفية حسب ما إذا كان المستخدم المتصل لديه أذونات استخدام أو إدارة

المرتجعات

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

الحصول على قائمة بقوائم انتظار الوكيل حسب معرفات التجمع

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

المعلمات

poolIds: number[]

قائمة مفصولة بفواصل من معرفات التجمع للحصول على قوائم الانتظار المقابلة لها

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي ينتمي إليها الهدف.

targetId: number

معرف هدف النشر.

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي تنتمي إليها الأهداف.

targetIds: number[]

قائمة معرفات أهداف التوزيع مفصولة بفواصل

ownerId: number

هوية مالك طلب وظيفة الوكيل.

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

معرف المشروع أو اسم المشروع

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)

احصل على مجموعة نشر حسب معرفها.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر.

actionFilter: DeploymentGroupActionFilter

احصل على مجموعة النشر فقط إذا كان من الممكن تنفيذ هذا الإجراء عليها.

expand: DeploymentGroupExpands

قم بتضمين هذه التفاصيل الإضافية في الكائن الذي تم إرجاعه.

المرتجعات

Promise<DeploymentGroup>

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

احصل على قائمة بمجموعات النشر حسب الاسم أو المعرفات.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

name: string

اسم مجموعة التوزيع.

actionFilter: DeploymentGroupActionFilter

احصل فقط على مجموعات التوزيع التي يمكن تنفيذ هذا الإجراء عليها.

expand: DeploymentGroupExpands

قم بتضمين هذه التفاصيل الإضافية في الكائنات التي تم إرجاعها.

continuationToken: string

احصل على مجموعات التوزيع بأسماء أكبر من هذا continuationToken من الناحية المعجمية.

top: number

الحد الأقصى لعدد مجموعات النشر المراد إرجاعها. الافتراضي هو 1000.

ids: number[]

قائمة معرفات مجموعات النشر مفصولة بفواصل

المرتجعات

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

احصل على قائمة بمقاييس مجموعة التوزيع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

المرتجعات

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

actionFilter: MachineGroupActionFilter

المرتجعات

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

tagFilters: string[]

المرتجعات

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

قائمة معرفات تجمع التوزيع.

المرتجعات

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

الحصول على هدف نشر حسب المعرف الخاص به في مجموعة نشر

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة التوزيع التي ينتمي إليها هدف التوزيع.

targetId: number

معرف هدف التوزيع المراد إرجاعه.

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر.

tags: string[]

احصل فقط على أهداف التوزيع التي تحتوي على كل قائمة العلامات المنفصلة بفواصل.

name: string

نمط الاسم لأهداف النشر المراد إرجاعها.

partialNameMatch: boolean

عند التعيين إلى صواب، يتعامل مع الاسم كنمط. يتعامل معها Else على أنها مباراة مطلقة. الافتراضي هو خطأ.

expand: DeploymentTargetExpands

قم بتضمين هذه التفاصيل الإضافية في الكائنات التي تم إرجاعها.

agentStatus: TaskAgentStatusFilter

احصل فقط على أهداف التوزيع التي لها هذه الحالة.

agentJobResult: TaskAgentJobResultFilter

احصل فقط على أهداف التوزيع التي لها نتيجة الوظيفة الأخيرة هذه.

continuationToken: string

احصل على أهداف التوزيع بأسماء أكبر من هذا الاستمرار من الرمز المميز من الناحية المعجمية.

top: number

الحد الأقصى لعدد أهداف النشر المراد إرجاعها. الافتراضي هو 1000.

enabled: boolean

احصل فقط على أهداف التوزيع التي تم تمكينها أو تعطيلها. الافتراضي هو "null" الذي يرجع جميع الأهداف.

propertyFilters: string[]

المرتجعات

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

احصل على بيئة من خلال معرفها.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

environmentId: number

معرف البيئة.

expands: EnvironmentExpands

قم بتضمين هذه التفاصيل الإضافية في الكائنات التي تم إرجاعها.

المرتجعات

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

الحصول على محفوظات تنفيذ نشر البيئة

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

secureFileId: string

معرف الملف الآمن الفريد

includeDownloadTicket: boolean

إذا كان includeDownloadTicket صحيحا وكان لدى المتصل أذونات ، تضمين تذكرة تنزيل في الاستجابة.

actionFilter: SecureFileActionFilter

المرتجعات

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

الحصول على ملفات آمنة

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

namePattern: string

اسم الملف الآمن المطلوب مطابقته. يمكن أن تتضمن أحرف بدل لمطابقة ملفات متعددة.

includeDownloadTickets: boolean

إذا كان includeDownloadTickets صحيحا وكان لدى المتصل أذونات ، تضمين تذكرة تنزيل لكل ملف آمن في الاستجابة.

actionFilter: SecureFileActionFilter

التصفية حسب أذونات الملفات الآمنة لإجراء العرض أو الإدارة أو الاستخدام. الإعدادات الافتراضية للعرض.

المرتجعات

Promise<SecureFile[]>

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

الحصول على ملفات آمنة

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

secureFileIds: string[]

قائمة بمعرفات الملفات الآمنة

includeDownloadTickets: boolean

إذا كان includeDownloadTickets صحيحا وكان لدى المتصل أذونات ، تضمين تذكرة تنزيل لكل ملف آمن في الاستجابة.

actionFilter: SecureFileActionFilter

المرتجعات

Promise<SecureFile[]>

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

الحصول على ملفات آمنة

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

secureFileNames: string[]

قائمة بمعرفات الملفات الآمنة

includeDownloadTickets: boolean

إذا كان includeDownloadTickets صحيحا وكان لدى المتصل أذونات ، تضمين تذكرة تنزيل لكل ملف آمن في الاستجابة.

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

معرف المشروع أو اسم المشروع

taskGroupId: string

معرف مجموعة المهام.

versionSpec: string

مواصفات إصدار مجموعة المهام. أمثلة: 1 ، 1.0.

expand: TaskGroupExpands

الخصائص التي يجب توسيعها. مثال $expand=ستقوم المهام بتوسيع مجموعات المهام المتداخلة.

المرتجعات

Promise<TaskGroup>

getTaskGroupHistory(string, string)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

taskGroupId: string

المرتجعات

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

taskGroupId: string

معرف مجموعة المهام.

expanded: boolean

"true" لتوسيع مجموعات المهام بشكل متكرر. الافتراضي هو "خطأ".

taskIdFilter: string

دليل taskId للتصفية.

deleted: boolean

"صواب"لتضمين مجموعات المهام المحذوفة. الافتراضي هو "خطأ".

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

معرف المشروع أو اسم المشروع

groupId: number

معرف المجموعة المتغيرة.

المرتجعات

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

معرف المشروع أو اسم المشروع

groupName: string

اسم مجموعة المتغيرات.

actionFilter: VariableGroupActionFilter

عامل تصفية الإجراء لمجموعة المتغيرات. يحدد الإجراء الذي يمكن تنفيذه على مجموعات المتغيرات.

top: number

عدد المجموعات المتغيرة التي يجب الحصول عليها.

continuationToken: number

يحصل على مجموعات المتغيرات بعد الرمز المميز للاستمرار المقدم.

queryOrder: VariableGroupQueryOrder

الحصول على النتائج بالترتيب المحدد. الافتراضي هو "IdDescending".

المرتجعات

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

احصل على مجموعات متغيرة حسب المعرفات.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

groupIds: number[]

قائمة مفصولة بفواصل لمعرفات مجموعات المتغيرات.

loadSecrets: boolean

علامة تشير إلى ما إذا كان يجب تحميل الأسرار داخل مجموعات المتغيرات.

المرتجعات

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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)

التحقق مما إذا كانت الهوية الحالية قد اجتازت الأذونات على مجموعة.

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

المعلمات

poolId: number

معرف المسبح للتحقق

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

معرف المشروع أو اسم المشروع

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-name') للوصول إلى قيمة الخاصية المحددة لملف آمن. يقوم بإرجاع null إذا لم يتم تعيين الخاصية. على سبيل المثال. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

المرتجعات

Promise<void>

refreshDeploymentTargets(string, number)

ترقية أهداف التوزيع في مجموعة توزيع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر.

المرتجعات

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>

المعلمات

machine: DeploymentMachine

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة التوزيع التي يتم استبدال هدف التوزيع فيها.

targetId: number

معرف هدف التوزيع المراد استبداله.

المرتجعات

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

معرف المشروع أو اسم المشروع

المرتجعات

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر.

المرتجعات

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

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

المعلمات

machine: DeploymentMachine

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

machineId: number

المرتجعات

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

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

المعلمات

machineGroup: DeploymentMachineGroup

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

المرتجعات

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

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

المعلمات

deploymentMachines: DeploymentMachine[]

project: string

معرف المشروع أو اسم المشروع

machineGroupId: number

المرتجعات

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

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

المعلمات

machines: DeploymentMachine[]

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي يتم فيها تحديث هدف التوزيع.

targetId: number

معرف هدف التوزيع المراد تحديثه.

المرتجعات

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

تحديث علامات قائمة أهداف التوزيع في مجموعة توزيع.

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

المعلمات

machines: DeploymentTargetUpdateParameter[]

أهداف النشر مع العلامات إلى udpdate.

project: string

معرف المشروع أو اسم المشروع

deploymentGroupId: number

معرف مجموعة النشر التي يتم فيها تحديث أهداف التوزيع.

المرتجعات

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

قم بتحديث البيئة المحددة.

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

المعلمات

environmentUpdateParameter: EnvironmentUpdateParameter

بيانات البيئة المطلوب تحديثها.

project: string

معرف المشروع أو اسم المشروع

environmentId: number

معرف البيئة.

المرتجعات

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

تحديث اسم أو خصائص ملف آمن موجود

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

المعلمات

secureFile: SecureFile

الملف الآمن مع الاسم و / أو الخصائص المحدثة

project: string

معرف المشروع أو اسم المشروع

secureFileId: string

معرف الملف الآمن الفريد

المرتجعات

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

تحديث خصائص و / أو أسماء مجموعة من الملفات الآمنة. يتم تحديد الملفات من خلال معرفاتها. تتجاوز الخصائص المقدمة الخصائص الحالية بالكامل ، أي لا تندمج.

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

المعلمات

secureFiles: SecureFile[]

قائمة بكائنات الملفات الآمنة. يجب ملء ثلاثة حقول فقط المعرف والاسم والخصائص. يتم تجاهل بقية الحقول في الكائن.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

تحديث مجموعة مهام.

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

المعلمات

taskGroup: TaskGroupUpdateParameter

مجموعة المهام المراد تحديثها.

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف مجموعة المتغيرات المراد تحديثها.

المرتجعات

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

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

المعلمات

resource: VirtualMachineGroup

project: string

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

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

معرف المشروع أو اسم المشروع

name: string

اسم الملف المراد تحميله

authorizePipelines: boolean

إذا كان authorizePipelines صحيحا، تفويض الملف الآمن للاستخدام من قبل جميع المسارات في المشروع.

المرتجعات

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)

المعلمات