ServiceEndpointRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
| Service |
Özellikler
| RESOURCE_AREA_ID |
Yöntemler
Oluşturucu Ayrıntıları
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parametreler
- options
- IVssRestClientOptions
Özellik Ayrıntıları
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringÖzellik Değeri
string
Yöntem Ayrıntıları
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Hizmet uç noktası yürütme kayıtları ekleyin.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parametreler
Eklenecek hizmet uç noktası yürütme kayıtları.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parametreler
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Döndürülenler
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parametreler
- configurationParams
- OAuthConfigurationParams
Döndürülenler
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Yeni bir hizmet uç noktası oluşturur
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parametreler
- endpoint
- ServiceEndpoint
Oluşturulacak hizmet uç noktası
Döndürülenler
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametreler
- configurationId
-
string
Döndürülenler
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Hizmet uç noktasını silme
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parametreler
- endpointId
-
string
Silinecek uç noktanın uç nokta kimliği
- projectIds
-
string[]
uç noktanın silinmesi gereken proje kimlikleri
- deep
-
boolean
uç nokta tarafından oluşturulan SPN'yi silme
Döndürülenler
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Hizmet uç noktası tarafından tanımlanan get isteğinin ara sunucusu.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parametreler
- serviceEndpointRequest
- ServiceEndpointRequest
Hizmet uç noktası isteği.
- project
-
string
Proje kimliği veya proje adı
- endpointId
-
string
Hizmet uç noktasının kimliği.
Döndürülenler
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Azure aboneliklerinin listesini döndürür
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Döndürülenler
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Azure aboneliklerinin listesini döndürür
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Döndürülenler
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametreler
- configurationId
-
string
Döndürülenler
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parametreler
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Döndürülenler
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
Hizmet uç noktası ayrıntılarını alın.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>Parametreler
- project
-
string
Proje kimliği veya proje adı
- endpointId
-
string
Hizmet uç noktasının kimliği.
- actionFilter
- ServiceEndpointActionFilter
Hizmet bağlantısı için eylem filtresi. Hizmet bağlantısında gerçekleştirilebilecek eylemi belirtir.
- loadConfidentialData
-
boolean
Hizmet uç noktasının gizli ayrıntılarını eklemek için bayrak ekleyin. Bu yalnızca dahili kullanım içindir.
Döndürülenler
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Hizmet uç noktası yürütme kayıtlarını alma.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parametreler
- project
-
string
Proje kimliği veya proje adı
- endpointId
-
string
Hizmet uç noktasının kimliği.
- top
-
number
Alınacak hizmet uç noktası yürütme kayıtlarının sayısı.
- continuationToken
-
number
Bu yönteme önceki bir çağrı tarafından döndürülen ve sonraki kayıt kümesini döndürmek için kullanılabilecek bir devamlılık belirteci
Döndürülenler
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Hizmet uç noktalarını alın.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parametreler
- project
-
string
Proje kimliği veya proje adı
- type
-
string
Hizmet uç noktalarının türü.
- authSchemes
-
string[]
Hizmet uç noktaları için kullanılan yetkilendirme düzenleri.
- endpointIds
-
string[]
Hizmet uç noktalarının kimlikleri.
- owner
-
string
Hizmet uç noktalarının sahibi.
- includeFailed
-
boolean
Hizmet uç noktaları için başarısız bayrak.
- includeDetails
-
boolean
Hizmet uç noktaları için daha fazla ayrıntı eklemek için bayrak ekleyin. Bu yalnızca iç kullanım içindir ve bayrağı diğer tüm istekler için false olarak kabul edilir
- actionFilter
- ServiceEndpointActionFilter
"actionFilter" parametresi, kullanıcıların istek sahibi izinlerini değerlendirmesine ve belirtilen koşullarla eşleşen uç noktaların listesini almasına olanak tanır ve izinlerine göre yalnızca ilgili uç noktaların döndürülmesini sağlar
Döndürülenler
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Hizmet uç noktalarını ada göre alın.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parametreler
- project
-
string
Proje kimliği veya proje adı
- endpointNames
-
string[]
Hizmet uç noktalarının adları.
- type
-
string
Hizmet uç noktalarının türü.
- authSchemes
-
string[]
Hizmet uç noktaları için kullanılan yetkilendirme düzenleri.
- owner
-
string
Hizmet uç noktalarının sahibi.
- includeFailed
-
boolean
Hizmet uç noktaları için başarısız bayrak.
- includeDetails
-
boolean
Hizmet uç noktaları için daha fazla ayrıntı eklemek için bayrak ekleyin. Bu yalnızca iç kullanım içindir ve bayrağı diğer tüm istekler için false olarak kabul edilir
Döndürülenler
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
Kuruluş için türe ve sahibe göre hizmet uç noktalarını alın. Yalnızca kimlik, ad ve url'yi döndürür ve yalnızca lisanslama hizmeti tarafından dahili olarak kullanılır
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>Parametreler
- type
-
string
Hizmet uç noktalarının türü.
- owner
-
string
Hizmet uç noktalarının sahibi.
Döndürülenler
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Hizmet uç noktalarını alır ve yeni yetkilendirme parametrelerine düzeltme eki uygulama
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parametreler
- refreshAuthenticationParameters
Kapsam, İstenen Belirtecin Geçerliliği.
- project
-
string
Proje kimliği veya proje adı
- endpointIds
-
string[]
Hizmet uç noktalarının kimlikleri.
Döndürülenler
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Hizmet uç noktası türlerini alma.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parametreler
- type
-
string
Hizmet uç noktası türü.
- scheme
-
string
Hizmet uç noktası şeması.
Döndürülenler
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Döndürülenler
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Hizmet uç noktası tarafından tanımlanan get isteğinin ara sunucusu. İstek, hizmet uç noktasında bir veri kaynağı kullanılarak yetkilendirilmiştir. Yanıt, XPath/Json tabanlı seçici kullanılarak filtrelenmiştir.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parametreler
- binding
- DataSourceBinding
Getirilecek veri kaynağını açıklar.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parametreler
- endpointId
-
string
- project
-
string
Döndürülenler
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parametreler
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Döndürülenler
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Hizmet uç noktasını projeler arasında paylaşma
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parametreler
- endpointProjectReferences
Hedef projenin proje başvuru ayrıntıları
- endpointId
-
string
Paylaşacak uç noktanın Uç Nokta Kimliği
Döndürülenler
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parametreler
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Döndürülenler
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Hizmet uç noktasını güncelleştirme
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parametreler
- endpoint
- ServiceEndpoint
Uç nokta için güncelleştirilmiş veriler
- endpointId
-
string
Güncelleştirilecek uç noktanın uç nokta kimliği
- operation
-
string
operation type
Döndürülenler
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Hizmet uç noktalarını güncelleştirin.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parametreler
- endpoints
Güncelleştirilecek hizmet uç noktalarının adları.
Döndürülenler
Promise<ServiceEndpoint[]>