CoreRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

CoreRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Buat tim dalam proyek tim.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Hapus tim.
getAllTeams(boolean, number, number, boolean)	Dapatkan daftar semua tim.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Dapatkan proses berdasarkan ID.
getProcesses()	Dapatkan daftar proses.
getProject(string, boolean, boolean)	Dapatkan proyek dengan id atau nama yang ditentukan, secara opsional menyertakan kemampuan.
getProjectCollection(string)	Dapatkan koleksi proyek dengan id atau nama yang ditentukan.
getProjectCollections(number, number)	Dapatkan referensi koleksi proyek untuk aplikasi ini.
getProjectHistoryEntries(number)	Mendapatkan riwayat perubahan pada proyek.
getProjectProperties(string, string[])	Dapatkan koleksi properti proyek tim.
getProjects(any, number, number, number, boolean)	Dapatkan semua project di organisasi yang dapat diakses oleh pengguna yang diautentikasi.
getProjectsProperties(string[], string[])	Dapatkan koleksi properti proyek tim untuk beberapa proyek.
getProjectTeamsByCategory(string, boolean, number, number)	Mendapatkan daftar tim yang dapat dibaca pengguna dalam proyek dan anggota pengguna tim (dikecualikan dari daftar yang dapat dibaca).
getProxies(string)
getTeam(string, string, boolean)	Dapatkan tim tertentu.
getTeamMembersWithExtendedProperties(string, string, number, number)	Dapatkan daftar anggota untuk tim tertentu.
getTeams(string, boolean, number, number, boolean)	Dapatkan daftar tim.
queueCreateProject(TeamProject)	Mengantrekan proyek yang akan dibuat. Gunakan GetOperation untuk memeriksa status pembuatan proyek secara berkala.
queueDeleteProject(string)	Mengantri proyek untuk dihapus. Gunakan GetOperation untuk memeriksa status proyek penghapusan secara berkala.
removeProjectAvatar(string)	Menghapus avatar untuk proyek.
setProjectAvatar(ProjectAvatar, string)	Mengatur avatar untuk proyek.
setProjectProperties(string, JsonPatchDocument)	Buat, perbarui, dan hapus properti proyek tim.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Perbarui nama, singkatan, deskripsi, atau pemulihan proyek yang ada.
updateTeam(WebApiTeam, string, string)	Perbarui nama dan/atau deskripsi tim.

Detail Konstruktor

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createConnectedService(WebApiConnectedServiceDetails, string)

function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>

Parameter

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Mengembalikan

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parameter

mruData

IdentityData

mruName

string

Mengembalikan

Promise<void>

createOrUpdateProxy(Proxy)

function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

Parameter

proxy

Proxy

Mengembalikan

Promise<Proxy>

createTeam(WebApiTeam, string)

Buat tim dalam proyek tim.

function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

Parameter

team

WebApiTeam

Data tim yang digunakan untuk membuat tim.

projectId

string

Nama atau ID (GUID) proyek tim untuk membuat tim.

Mengembalikan

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parameter

mruData

IdentityData

mruName

string

Mengembalikan

Promise<void>

deleteProxy(string, string)

function deleteProxy(proxyUrl: string, site?: string): Promise<void>

Parameter

proxyUrl

string

site

string

Mengembalikan

Promise<void>

deleteTeam(string, string)

Hapus tim.

function deleteTeam(projectId: string, teamId: string): Promise<void>

Parameter

projectId

string

Nama atau ID (GUID) proyek tim yang berisi tim yang akan dihapus.

teamId

string

Nama atau ID tim yang akan dihapus.

Mengembalikan

Promise<void>

getAllTeams(boolean, number, number, boolean)

Dapatkan daftar semua tim.

function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Parameter

mine

boolean

Jika true, kembalikan semua tim yang meminta pengguna adalah anggota. Jika tidak, kembalikan semua akses baca pengguna tim.

top

number

Jumlah maksimum tim yang akan dikembalikan.

skip

number

Jumlah tim yang akan dilewati.

expandIdentity

boolean

Nilai yang menunjukkan apakah akan memperluas informasi Identitas dalam objek WebApiTeam hasil atau tidak.

Mengembalikan

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>

Parameter

projectId

string

name

string

Mengembalikan

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>

Parameter

projectId

string

kind

ConnectedServiceKind

Mengembalikan

Promise<WebApiConnectedService[]>

getIdentityMru(string)

function getIdentityMru(mruName: string): Promise<IdentityRef[]>

Parameter

mruName

string

Mengembalikan

Promise<IdentityRef[]>

getProcessById(string)

Dapatkan proses berdasarkan ID.

function getProcessById(processId: string): Promise<Process>

Parameter

processId

string

ID untuk suatu proses.

Mengembalikan

Promise<Process>

getProcesses()

Dapatkan daftar proses.

function getProcesses(): Promise<Process[]>

Mengembalikan

Promise<Process[]>

getProject(string, boolean, boolean)

Dapatkan proyek dengan id atau nama yang ditentukan, secara opsional menyertakan kemampuan.

function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>

Parameter

projectId

string

includeCapabilities

boolean

Sertakan kemampuan (seperti kontrol sumber) dalam hasil proyek tim (default: false).

includeHistory

boolean

Cari dalam proyek yang diganti namanya (yang memiliki nama seperti itu di masa lalu).

Mengembalikan

Promise<TeamProject>

getProjectCollection(string)

Dapatkan koleksi proyek dengan id atau nama yang ditentukan.

function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

Parameter

collectionId

string

Mengembalikan

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Dapatkan referensi koleksi proyek untuk aplikasi ini.

function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>

Parameter

top

number

skip

number

Mengembalikan

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Mendapatkan riwayat perubahan pada proyek.

function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

Parameter

minRevision

number

Nomor revisi minimum yang akan dikembalikan dalam riwayat.

Mengembalikan

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Dapatkan koleksi properti proyek tim.

function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>

Parameter

projectId

string

ID proyek tim.

keys

string[]

String nama properti proyek tim yang dibatasi koma. Karakter karakter pengganti ("?" dan "*") didukung. Jika tidak ada kunci yang ditentukan, semua properti akan dikembalikan.

Mengembalikan

Promise<ProjectProperty[]>

getProjects(any, number, number, number, boolean)

Dapatkan semua project di organisasi yang dapat diakses oleh pengguna yang diautentikasi.

function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>

Parameter

stateFilter

any

Memfilter proyek tim dalam status proyek tim tertentu (default: WellFormed).

top

number

skip

number

continuationToken

number

Penunjuk yang menunjukkan berapa banyak proyek yang telah diambil.

getDefaultTeamImageUrl

boolean

Mengembalikan

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Dapatkan koleksi properti proyek tim untuk beberapa proyek.

function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>

Parameter

projectIds

string[]

String ID proyek tim yang dibatasi koma

properties

string[]

Mengembalikan

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Mendapatkan daftar tim yang dapat dibaca pengguna dalam proyek dan anggota pengguna tim (dikecualikan dari daftar yang dapat dibaca).

function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>

Parameter

projectId

string

Nama atau ID (GUID) proyek tim yang berisi tim yang akan diambil.

expandIdentity

boolean

Nilai yang menunjukkan apakah akan memperluas informasi Identitas dalam objek WebApiTeam hasil atau tidak.

top

number

Jumlah maksimum tim yang akan dikembalikan.

skip

number

Jumlah tim yang akan dilewati.

Mengembalikan

Promise<CategorizedWebApiTeams>

getProxies(string)

function getProxies(proxyUrl?: string): Promise<Proxy[]>

Parameter

proxyUrl

string

Mengembalikan

Promise<Proxy[]>

getTeam(string, string, boolean)

Dapatkan tim tertentu.

function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>

Parameter

projectId

string

Nama atau ID (GUID) proyek tim yang berisi tim.

teamId

string

Nama atau ID (GUID) tim.

expandIdentity

boolean

Nilai yang menunjukkan apakah akan memperluas informasi Identitas dalam objek WebApiTeam hasil atau tidak.

Mengembalikan

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Dapatkan daftar anggota untuk tim tertentu.

function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>

Parameter

projectId

string

Nama atau ID (GUID) proyek tim tempat tim berada.

teamId

string

Nama atau ID (GUID) tim .

top

number

skip

number

Mengembalikan

Promise<TeamMember[]>

getTeams(string, boolean, number, number, boolean)

Dapatkan daftar tim.

function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Parameter

projectId

string

mine

boolean

Jika true mengembalikan semua tim yang meminta pengguna adalah anggota, jika tidak, mengembalikan semua tim pengguna memiliki akses baca.

top

number

Jumlah maksimum tim yang akan dikembalikan.

skip

number

Jumlah tim yang akan dilewati.

expandIdentity

boolean

Nilai yang menunjukkan apakah akan memperluas informasi Identitas dalam objek WebApiTeam hasil atau tidak.

Mengembalikan

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Mengantrekan proyek yang akan dibuat. Gunakan GetOperation untuk memeriksa status pembuatan proyek secara berkala.

function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

Parameter

projectToCreate

TeamProject

Proyek untuk membuat.

Mengembalikan

Promise<OperationReference>

queueDeleteProject(string)

Mengantri proyek untuk dihapus. Gunakan GetOperation untuk memeriksa status proyek penghapusan secara berkala.

function queueDeleteProject(projectId: string): Promise<OperationReference>

Parameter

projectId

string

ID proyek proyek yang akan dihapus.

Mengembalikan

Promise<OperationReference>

removeProjectAvatar(string)

Menghapus avatar untuk proyek.

function removeProjectAvatar(projectId: string): Promise<void>

Parameter

projectId

string

ID atau nama proyek.

Mengembalikan

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Mengatur avatar untuk proyek.

function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

Parameter

avatarBlob

ProjectAvatar

Objek data blob avatar untuk diunggah.

projectId

string

ID atau nama proyek.

Mengembalikan

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Buat, perbarui, dan hapus properti proyek tim.

function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>

Parameter

projectId

string

ID proyek tim.

patchDocument

JsonPatchDocument

Dokumen JSON Patch yang mewakili array operasi properti. Lihat RFC 6902 untuk detail lebih lanjut tentang JSON Patch. Kata kerja operasi yang diterima adalah Tambah dan Hapus, di mana Tambah digunakan untuk membuat dan memperbarui properti. Jalur terdiri dari garis miring maju dan nama properti.

Mengembalikan

Promise<void>

updateIdentityMru(IdentityData, string)

function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parameter

mruData

IdentityData

mruName

string

Mengembalikan

Promise<void>

updateProject(TeamProject, string)

Perbarui nama, singkatan, deskripsi, atau pemulihan proyek yang ada.

function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>

Parameter

projectUpdate

TeamProject

Pembaruan untuk proyek. Status harus diatur ke wellFormed untuk memulihkan proyek.

projectId

string

ID proyek proyek yang akan diperbarui.

Mengembalikan

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Perbarui nama dan/atau deskripsi tim.

function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>

Parameter

teamData

WebApiTeam

projectId

string

Nama atau ID (GUID) proyek tim yang berisi tim yang akan diperbarui.

teamId

string

Nama ID tim yang akan diperbarui.

Mengembalikan

Promise<WebApiTeam>