ServiceEndpointRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الخصائص
| RESOURCE_AREA_ID |
الأساليب
تفاصيل المنشئ
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)المعلمات
- options
- IVssRestClientOptions
تفاصيل الخاصية
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringقيمة الخاصية
string
تفاصيل الأسلوب
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
إضافة سجلات تنفيذ نقطة نهاية الخدمة.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>المعلمات
سجلات تنفيذ نقطة نهاية الخدمة لإضافتها.
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<ServiceEndpointExecutionRecord[]>
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>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>المعلمات
- configurationParams
- OAuthConfigurationParams
المرتجعات
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
إنشاء نقطة نهاية خدمة جديدة
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>المعلمات
- endpoint
- ServiceEndpoint
نقطة نهاية الخدمة المراد إنشاؤها
المرتجعات
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>المعلمات
- configurationId
-
string
المرتجعات
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
حذف نقطة نهاية خدمة
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>المعلمات
- endpointId
-
string
معرف نقطة النهاية لنقطة النهاية المراد حذفه
- projectIds
-
string[]
معرفات المشروع التي يجب حذف نقطة النهاية منها
- deep
-
boolean
حذف spn الذي تم إنشاؤه بواسطة نقطة النهاية
المرتجعات
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
وكيل لطلب GET محدد بواسطة نقطة نهاية خدمة.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>المعلمات
- serviceEndpointRequest
- ServiceEndpointRequest
طلب نقطة نهاية الخدمة.
- project
-
string
معرف المشروع أو اسم المشروع
- endpointId
-
string
معرف نقطة نهاية الخدمة.
المرتجعات
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
إرجاع قائمة اشتراكات azure
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>المرتجعات
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
إرجاع قائمة اشتراكات azure
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>المرتجعات
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>المعلمات
- configurationId
-
string
المرتجعات
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>المعلمات
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
المرتجعات
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
احصل على تفاصيل نقطة نهاية الخدمة.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- endpointId
-
string
معرف نقطة نهاية الخدمة.
- actionFilter
- ServiceEndpointActionFilter
عامل تصفية الإجراء لاتصال الخدمة. يحدد الإجراء الذي يمكن تنفيذه على اتصال الخدمة.
- loadConfidentialData
-
boolean
وضع علامة لتضمين تفاصيل سرية لنقطة نهاية الخدمة. هذا للاستخدام الداخلي فقط.
المرتجعات
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
الحصول على سجلات تنفيذ نقطة نهاية الخدمة.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- endpointId
-
string
معرف نقطة نهاية الخدمة.
- top
-
number
عدد سجلات تنفيذ نقطة نهاية الخدمة التي يجب الحصول عليها.
- continuationToken
-
number
رمز متابعة مميز، تم إرجاعه بواسطة استدعاء سابق لهذا الأسلوب، يمكن استخدامه لإرجاع المجموعة التالية من السجلات
المرتجعات
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
الحصول على نقاط نهاية الخدمة.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- type
-
string
نوع نقاط نهاية الخدمة.
- authSchemes
-
string[]
مخططات التخويل المستخدمة لنقاط نهاية الخدمة.
- endpointIds
-
string[]
معرفات نقاط نهاية الخدمة.
- owner
-
string
مالك نقاط نهاية الخدمة.
- includeFailed
-
boolean
علامة فاشلة لنقاط نهاية الخدمة.
- includeDetails
-
boolean
ضع علامة لتضمين مزيد من التفاصيل لنقاط نهاية الخدمة. هذا للاستخدام الداخلي فقط وسيتم التعامل مع العلامة على أنها خاطئة لجميع الطلبات الأخرى
- actionFilter
- ServiceEndpointActionFilter
تسمح المعلمة "actionFilter" للمستخدمين بتقييم أذونات الطالب واسترداد قائمة بنقاط النهاية التي تطابق الشروط المحددة، ما يضمن إرجاع نقاط النهاية ذات الصلة فقط استنادا إلى أذوناتهم
المرتجعات
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
احصل على نقاط نهاية الخدمة بالاسم.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- endpointNames
-
string[]
أسماء نقاط نهاية الخدمة.
- type
-
string
نوع نقاط نهاية الخدمة.
- authSchemes
-
string[]
مخططات التخويل المستخدمة لنقاط نهاية الخدمة.
- owner
-
string
مالك نقاط نهاية الخدمة.
- includeFailed
-
boolean
علامة فاشلة لنقاط نهاية الخدمة.
- includeDetails
-
boolean
ضع علامة لتضمين مزيد من التفاصيل لنقاط نهاية الخدمة. هذا للاستخدام الداخلي فقط وسيتم التعامل مع العلامة على أنها خاطئة لجميع الطلبات الأخرى
المرتجعات
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
احصل على نقاط نهاية الخدمة للمؤسسة حسب النوع والمالك. إرجاع المعرف والاسم وعنوان url فقط ويستخدم داخليا فقط من خلال خدمة الترخيص
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>المعلمات
- type
-
string
نوع نقاط نهاية الخدمة.
- owner
-
string
مالك نقاط نهاية الخدمة.
المرتجعات
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
الحصول على نقاط نهاية الخدمة وتصحيح معلمات التخويل الجديدة
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>المعلمات
- refreshAuthenticationParameters
النطاق، صلاحية الرمز المميز المطلوب.
- project
-
string
معرف المشروع أو اسم المشروع
- endpointIds
-
string[]
معرفات نقاط نهاية الخدمة.
المرتجعات
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
الحصول على أنواع نقاط نهاية الخدمة.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>المعلمات
- type
-
string
نوع نقطة نهاية الخدمة.
- scheme
-
string
مخطط نقطة نهاية الخدمة.
المرتجعات
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>المرتجعات
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
وكيل لطلب GET محدد بواسطة نقطة نهاية خدمة. يتم تخويل الطلب باستخدام مصدر بيانات في نقطة نهاية الخدمة. تتم تصفية الاستجابة باستخدام محدد يستند إلى XPath/Json.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>المعلمات
- binding
- DataSourceBinding
يصف مصدر البيانات المراد إحضاره.
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>المعلمات
- endpointId
-
string
- project
-
string
المرتجعات
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>المعلمات
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
المرتجعات
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
مشاركة نقطة نهاية الخدمة عبر المشاريع
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>المعلمات
- endpointProjectReferences
تفاصيل مرجع المشروع للمشروع الهدف
- endpointId
-
string
معرف نقطة النهاية لنقطة النهاية المراد مشاركتها
المرتجعات
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>المعلمات
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
المرتجعات
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
تحديث نقطة نهاية الخدمة
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>المعلمات
- endpoint
- ServiceEndpoint
البيانات المحدثة لنقطة النهاية
- endpointId
-
string
معرف نقطة النهاية لنقطة النهاية المراد تحديثها
- operation
-
string
نوع العملية
المرتجعات
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
تحديث نقاط نهاية الخدمة.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>المعلمات
- endpoints
أسماء نقاط نهاية الخدمة المراد تحديثها.
المرتجعات
Promise<ServiceEndpoint[]>