CoreRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

CoreRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Takım projesinde bir takım oluşturun.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Bir takımı silin.
getAllTeams(boolean, number, number, boolean)	Tüm takımların bir listesini alın.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Kimliğe göre bir işlem alın.
getProcesses()	İşlemlerin bir listesini alın.
getProject(string, boolean, boolean)	İsteğe bağlı olarak yetenekler de dahil olmak üzere belirtilen kimlik veya adla projeyi alın.
getProjectCollection(string)	Belirtilen kimlik veya adla proje koleksiyonunu alın.
getProjectCollections(number, number)	Bu uygulama için proje koleksiyonu başvurularını alın.
getProjectHistoryEntries(number)	Projedeki değişikliklerin geçmişini alır.
getProjectProperties(string, string[])	Takım projesi özelliklerinin bir koleksiyonunu edinin.
getProjects(any, number, number, number, boolean)	Kimliği doğrulanmış kullanıcının erişimi olan kuruluştaki tüm projeleri alın.
getProjectsProperties(string[], string[])	Birden çok proje için takım projesi özelliklerinin bir koleksiyonunu alın.
getProjectTeamsByCategory(string, boolean, number, number)	Bir projedeki kullanıcı tarafından okunabilir takımların ve kullanıcının üyesi olduğu takımların listesini alır (okunabilir listeden çıkarılır).
getProxies(string)
getTeam(string, string, boolean)	Belirli bir ekip edinin.
getTeamMembersWithExtendedProperties(string, string, number, number)	Belirli bir ekip için üyelerin listesini alın.
getTeams(string, boolean, number, number, boolean)	Takımların bir listesini alın.
queueCreateProject(TeamProject)	Oluşturulacak bir projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla kontrol etmek için GetOperation'ı kullanın.
queueDeleteProject(string)	Silinecek bir projeyi kuyruğa alır. Proje silme durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın.
removeProjectAvatar(string)	Projenin avatarını kaldırır.
setProjectAvatar(ProjectAvatar, string)	Proje için avatarı ayarlar.
setProjectProperties(string, JsonPatchDocument)	Takım projesi özelliklerini oluşturun, güncelleştirin ve silin.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Mevcut bir projenin adını, kısaltmasını, açıklamasını güncelleyin veya bir projeyi geri yükleyin.
updateTeam(WebApiTeam, string, string)	Bir ekibin adını ve/veya açıklamasını güncelleyin.

Oluşturucu Ayrıntıları

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(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ı

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parametreler

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Döndürülenler

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parametreler

mruData

IdentityData

mruName

string

Döndürülenler

Promise<void>

createOrUpdateProxy(Proxy)

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

Parametreler

proxy

Proxy

Döndürülenler

Promise<Proxy>

createTeam(WebApiTeam, string)

Takım projesinde bir takım oluşturun.

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

Parametreler

team

WebApiTeam

Takımı oluşturmak için kullanılan takım verileri.

projectId

string

Takımın oluşturulacağı takım projesinin adı veya kimliği (GUID).

Döndürülenler

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parametreler

mruData

IdentityData

mruName

string

Döndürülenler

Promise<void>

deleteProxy(string, string)

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

Parametreler

proxyUrl

string

site

string

Döndürülenler

Promise<void>

deleteTeam(string, string)

Bir takımı silin.

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

Parametreler

projectId

string

Silinecek takımı içeren takım projesinin adı veya kimliği (GUID).

teamId

string

Silinecek ekibin adı veya kimliği.

Döndürülenler

Promise<void>

getAllTeams(boolean, number, number, boolean)

Tüm takımların bir listesini alın.

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

Parametreler

mine

boolean

Doğruysa, kullanıcının üye olmasını isteyen tüm ekipleri döndürün. Aksi takdirde, okuma erişimine sahip tüm ekipler kullanıcısını döndürün.

top

number

Döndürülecek en fazla ekip sayısı.

skip

number

Atlanacak takım sayısı.

expandIdentity

boolean

Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.

Döndürülenler

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parametreler

projectId

string

name

string

Döndürülenler

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parametreler

projectId

string

kind

ConnectedServiceKind

Döndürülenler

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parametreler

mruName

string

Döndürülenler

Promise<IdentityRef[]>

getProcessById(string)

Kimliğe göre bir işlem alın.

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

Parametreler

processId

string

Bir işlem için kimlik.

Döndürülenler

Promise<Process>

getProcesses()

İşlemlerin bir listesini alın.

function getProcesses(): Promise<Process[]>

Döndürülenler

Promise<Process[]>

getProject(string, boolean, boolean)

İsteğe bağlı olarak yetenekler de dahil olmak üzere belirtilen kimlik veya adla projeyi alın.

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

Parametreler

projectId

string

includeCapabilities

boolean

Takım projesi sonucuna yetenekleri (kaynak denetimi gibi) dahil et (varsayılan: false).

includeHistory

boolean

Yeniden adlandırılmış projeler (geçmişte böyle bir ada sahip olanlar) içinde arama yapın.

Döndürülenler

Promise<TeamProject>

getProjectCollection(string)

Belirtilen kimlik veya adla proje koleksiyonunu alın.

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

Parametreler

collectionId

string

Döndürülenler

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Bu uygulama için proje koleksiyonu başvurularını alın.

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

Parametreler

top

number

skip

number

Döndürülenler

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Projedeki değişikliklerin geçmişini alır.

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

Parametreler

minRevision

number

Geçmişte döndürülecek minimum revizyon numarası.

Döndürülenler

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Takım projesi özelliklerinin bir koleksiyonunu edinin.

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

Parametreler

projectId

string

Takım projesi kimliği.

keys

string[]

Takım projesi özellik adlarının virgülle ayrılmış dizesi. Joker karakterler ("?" ve "*") desteklenir. Herhangi bir anahtar belirtilmezse, tüm özellikler döndürülür.

Döndürülenler

Promise<ProjectProperty[]>

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

Kimliği doğrulanmış kullanıcının erişimi olan kuruluştaki tüm projeleri alın.

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

Parametreler

stateFilter

any

Belirli bir takım projesi durumundaki takım projelerine filtre uygulayın (varsayılan: WellFormed).

top

number

skip

number

continuationToken

number

Kaç projenin zaten getirildiğini gösteren işaretçi.

getDefaultTeamImageUrl

boolean

Döndürülenler

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Birden çok proje için takım projesi özelliklerinin bir koleksiyonunu alın.

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

Parametreler

projectIds

string[]

Takım projesi kimliklerinin virgülle ayrılmış dizesi

properties

string[]

Döndürülenler

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Bir projedeki kullanıcı tarafından okunabilir takımların ve kullanıcının üyesi olduğu takımların listesini alır (okunabilir listeden çıkarılır).

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

Parametreler

projectId

string

Alınacak takımları içeren takım projesinin adı veya kimliği (GUID).

expandIdentity

boolean

Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.

top

number

Döndürülecek en fazla ekip sayısı.

skip

number

Atlanacak takım sayısı.

Döndürülenler

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parametreler

proxyUrl

string

Döndürülenler

Promise<Proxy[]>

getTeam(string, string, boolean)

Belirli bir ekip edinin.

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

Parametreler

projectId

string

Takımı içeren takım projesinin adı veya kimliği (GUID).

teamId

string

Takımın adı veya kimliği (GUID).

expandIdentity

boolean

Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.

Döndürülenler

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Belirli bir ekip için üyelerin listesini alın.

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

Parametreler

projectId

string

Takımın ait olduğu takım projesinin adı veya kimliği (GUID).

teamId

string

Ekibin adı veya kimliği (GUID) .

top

number

skip

number

Döndürülenler

Promise<TeamMember[]>

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

Takımların bir listesini alın.

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

Parametreler

projectId

string

mine

boolean

true ise, istekte bulunan kullanıcının üye olduğu tüm takımları döndürün, aksi takdirde kullanıcının okuma erişimine sahip olduğu tüm takımları döndürün.

top

number

Döndürülecek en fazla ekip sayısı.

skip

number

Atlanacak takım sayısı.

expandIdentity

boolean

Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.

Döndürülenler

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Oluşturulacak bir projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla kontrol etmek için GetOperation'ı kullanın.

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

Parametreler

projectToCreate

TeamProject

Oluşturulacak proje.

Döndürülenler

Promise<OperationReference>

queueDeleteProject(string)

Silinecek bir projeyi kuyruğa alır. Proje silme durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın.

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

Parametreler

projectId

string

Silinecek projenin proje kimliği.

Döndürülenler

Promise<OperationReference>

removeProjectAvatar(string)

Projenin avatarını kaldırır.

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

Parametreler

projectId

string

Projenin kimliği veya adı.

Döndürülenler

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Proje için avatarı ayarlar.

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

Parametreler

avatarBlob

ProjectAvatar

Karşıya yüklenecek avatar blob veri nesnesi.

projectId

string

Projenin kimliği veya adı.

Döndürülenler

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Takım projesi özelliklerini oluşturun, güncelleştirin ve silin.

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

Parametreler

projectId

string

Takım projesi kimliği.

patchDocument

JsonPatchDocument

Bir dizi özellik işlemini temsil eden bir JSON Yama belgesi. JSON Yaması hakkında daha fazla ayrıntı için RFC 6902'ye bakın. Kabul edilen işlem fiilleri Add ve Remove'dur, burada Add, özellikleri hem oluşturmak hem de güncelleştirmek için kullanılır. Yol, eğik çizgi ve özellik adından oluşur.

Döndürülenler

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parametreler

mruData

IdentityData

mruName

string

Döndürülenler

Promise<void>

updateProject(TeamProject, string)

Mevcut bir projenin adını, kısaltmasını, açıklamasını güncelleyin veya bir projeyi geri yükleyin.

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

Parametreler

projectUpdate

TeamProject

Proje için güncellemeler. Projeyi geri yüklemek için durumun wellFormed olarak ayarlanması gerekir.

projectId

string

Güncelleştirilecek projenin proje kimliği.

Döndürülenler

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Bir ekibin adını ve/veya açıklamasını güncelleyin.

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

Parametreler

teamData

WebApiTeam

projectId

string

Güncelleştirilecek takımı içeren takım projesinin adı veya kimliği (GUID).

teamId

string

Güncellenecek ekibin kimliğinin adı.

Döndürülenler

Promise<WebApiTeam>