ServiceEndpointRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api
- Memperluas
Konstruktor
| Service |
Properti
| RESOURCE_AREA_ID |
Metode
Detail Konstruktor
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
Detail Properti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringNilai Properti
string
Detail Metode
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Tambahkan catatan eksekusi titik akhir layanan.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parameter
Catatan eksekusi titik akhir layanan untuk ditambahkan.
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parameter
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Mengembalikan
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parameter
- configurationParams
- OAuthConfigurationParams
Mengembalikan
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Membuat titik akhir layanan baru
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parameter
- endpoint
- ServiceEndpoint
Titik akhir layanan untuk dibuat
Mengembalikan
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationId
-
string
Mengembalikan
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Menghapus titik akhir layanan
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parameter
- endpointId
-
string
Id titik akhir titik akhir yang akan dihapus
- projectIds
-
string[]
id proyek dari titik akhir mana yang perlu dihapus
- deep
-
boolean
hapus spn yang dibuat oleh titik akhir
Mengembalikan
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proksi untuk permintaan GET yang ditentukan oleh titik akhir layanan.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parameter
- serviceEndpointRequest
- ServiceEndpointRequest
Permintaan titik akhir layanan.
- project
-
string
ID proyek atau nama proyek
- endpointId
-
string
Id titik akhir layanan.
Mengembalikan
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Mengembalikan daftar langganan azure
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Mengembalikan
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Mengembalikan daftar langganan azure
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Mengembalikan
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationId
-
string
Mengembalikan
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parameter
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Mengembalikan
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
Dapatkan detail titik akhir layanan.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>Parameter
- project
-
string
ID proyek atau nama proyek
- endpointId
-
string
Id titik akhir layanan.
- actionFilter
- ServiceEndpointActionFilter
Filter tindakan untuk koneksi layanan. Ini menentukan tindakan yang dapat dilakukan pada koneksi layanan.
- loadConfidentialData
-
boolean
Bendera untuk menyertakan detail rahasia titik akhir layanan. Ini hanya untuk penggunaan internal.
Mengembalikan
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Mendapatkan rekaman eksekusi titik akhir layanan.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parameter
- project
-
string
ID proyek atau nama proyek
- endpointId
-
string
Id titik akhir layanan.
- top
-
number
Jumlah rekaman eksekusi titik akhir layanan yang akan didapatkan.
- continuationToken
-
number
Token kelanjutan, yang dikembalikan oleh panggilan sebelumnya ke metode ini, yang dapat digunakan untuk mengembalikan kumpulan rekaman berikutnya
Mengembalikan
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Dapatkan titik akhir layanan.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parameter
- project
-
string
ID proyek atau nama proyek
- type
-
string
Jenis titik akhir layanan.
- authSchemes
-
string[]
Skema otorisasi yang digunakan untuk titik akhir layanan.
- endpointIds
-
string[]
Id titik akhir layanan.
- owner
-
string
Pemilik untuk titik akhir layanan.
- includeFailed
-
boolean
Bendera gagal untuk titik akhir layanan.
- includeDetails
-
boolean
Bendera untuk menyertakan detail selengkapnya untuk titik akhir layanan. Ini hanya untuk penggunaan internal dan bendera akan diperlakukan sebagai false untuk semua permintaan lainnya
- actionFilter
- ServiceEndpointActionFilter
Parameter "actionFilter" memungkinkan pengguna untuk mengevaluasi izin pemohon dan mengambil daftar titik akhir yang cocok dengan kondisi yang ditentukan, memastikan bahwa hanya titik akhir yang relevan yang dikembalikan berdasarkan izin mereka
Mengembalikan
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Dapatkan titik akhir layanan berdasarkan nama.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parameter
- project
-
string
ID proyek atau nama proyek
- endpointNames
-
string[]
Nama titik akhir layanan.
- type
-
string
Jenis titik akhir layanan.
- authSchemes
-
string[]
Skema otorisasi yang digunakan untuk titik akhir layanan.
- owner
-
string
Pemilik untuk titik akhir layanan.
- includeFailed
-
boolean
Bendera gagal untuk titik akhir layanan.
- includeDetails
-
boolean
Bendera untuk menyertakan detail selengkapnya untuk titik akhir layanan. Ini hanya untuk penggunaan internal dan bendera akan diperlakukan sebagai false untuk semua permintaan lainnya
Mengembalikan
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
Dapatkan titik akhir layanan untuk organisasi berdasarkan jenis dan pemilik. Hanya mengembalikan id, nama, dan url dan hanya digunakan secara internal oleh layanan lisensi
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>Parameter
- type
-
string
Jenis titik akhir layanan.
- owner
-
string
Pemilik untuk titik akhir layanan.
Mengembalikan
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Mendapatkan titik akhir layanan dan patch parameter otorisasi baru
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parameter
- refreshAuthenticationParameters
Cakupan, Validitas Token diminta.
- project
-
string
ID proyek atau nama proyek
- endpointIds
-
string[]
Id titik akhir layanan.
Mengembalikan
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Mendapatkan jenis titik akhir layanan.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parameter
- type
-
string
Jenis titik akhir layanan.
- scheme
-
string
Skema titik akhir layanan.
Mengembalikan
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Mengembalikan
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proksi untuk permintaan GET yang ditentukan oleh titik akhir layanan. Permintaan diotorisasi menggunakan sumber data di titik akhir layanan. Respons difilter menggunakan pemilih berbasis XPath/Json.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parameter
- binding
- DataSourceBinding
Menjelaskan sumber data yang akan diambil.
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parameter
- endpointId
-
string
- project
-
string
Mengembalikan
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parameter
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Mengembalikan
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Berbagi titik akhir layanan di seluruh proyek
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parameter
- endpointProjectReferences
Detail referensi proyek proyek target
- endpointId
-
string
Id Titik Akhir titik akhir yang akan dibagikan
Mengembalikan
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Mengembalikan
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Memperbarui titik akhir layanan
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parameter
- endpoint
- ServiceEndpoint
Data yang diperbarui untuk titik akhir
- endpointId
-
string
Id Titik Akhir titik akhir yang akan diperbarui
- operation
-
string
Jenis operasi
Mengembalikan
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Perbarui titik akhir layanan.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parameter
- endpoints
Nama titik akhir layanan yang akan diperbarui.
Mengembalikan
Promise<ServiceEndpoint[]>