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)	Ekip projesinde ekip oluşturma.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Ekibi silme.
getAllTeams(boolean, number, number, boolean)	Tüm ekiplerin listesini alın.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Kimliğine göre bir işlem alın.
getProcesses()	İşlemlerin listesini alın.
getProject(string, boolean, boolean)	İsteğe bağlı olarak özellikler de dahil olmak üzere belirtilen kimlik veya adla proje alın.
getProjectCollection(string)	Belirtilen kimlik veya ada sahip 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 özellikleri koleksiyonu alın.
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 bir takım projesi özellikleri koleksiyonu alın.
getProjectTeamsByCategory(string, boolean, number, number)	Bir projedeki kullanıcı tarafından okunabilir ekiplerin listesini alır ve kullanıcının üyesi olduğu ekiplerin listesini alır (okunabilir listenin dışında tutulur).
getProxies(string)
getTeam(string, string, boolean)	Belirli bir ekibi alın.
getTeamMembersWithExtendedProperties(string, string, number, number)	Belirli bir ekip için üyelerin listesini alın.
getTeams(string, boolean, number, number, boolean)	Ekiplerin listesini alın.
queueCreateProject(TeamProject)	Oluşturulacak projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın.
queueDeleteProject(string)	Silinecek 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)	Projenin avatarını ayarlar.
setProjectProperties(string, JsonPatchDocument)	Ekip projesi özelliklerini oluşturun, güncelleştirin ve silin.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Mevcut projenin adını, kısaltmasını, açıklamasını güncelleştirin veya projeyi geri yükleyin.
updateTeam(WebApiTeam, string, string)	Ekibin adını ve/veya açıklamasını güncelleştirin.

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)

Ekip projesinde ekip oluşturma.

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

Parametreler

team

WebApiTeam

Ekibi oluşturmak için kullanılan ekip verileri.

projectId

string

Ekibin 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)

Ekibi silme.

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

Parametreler

projectId

string

Silinecek ekibi 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 ekiplerin 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 olduğunu isteyen tüm ekipleri döndürebilirsiniz. Aksi takdirde tüm teams kullanıcı okuma erişimine sahip döndür.

top

number

Döndürülecek ekip sayısı üst sınırı.

skip

number

Atacak ekip 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ğine göre bir işlem alın.

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

Parametreler

processId

string

İşlemin kimliği.

Döndürülenler

Promise<Process>

getProcesses()

İşlemlerin listesini alın.

function getProcesses(): Promise<Process[]>

Döndürülenler

Promise<Process[]>

getProject(string, boolean, boolean)

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

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

Parametreler

projectId

string

includeCapabilities

boolean

Takım projesi sonucuna özellikleri (kaynak denetimi gibi) ekleyin (varsayılan: false).

includeHistory

boolean

Yeniden adlandırılan projelerin içinde (geçmişte böyle bir ada sahip olan) arama.

Döndürülenler

Promise<TeamProject>

getProjectCollection(string)

Belirtilen kimlik veya ada sahip 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şe döndürülecek en düşük düzeltme numarası.

Döndürülenler

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Takım projesi özellikleri koleksiyonu alın.

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. 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 ekip projelerine filtre uygulama (varsayılan: WellFormed).

top

number

skip

number

continuationToken

number

Zaten kaç projenin getirildiğini gösteren işaretçi.

getDefaultTeamImageUrl

boolean

Döndürülenler

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Birden çok proje için bir takım projesi özellikleri koleksiyonu 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 ekiplerin listesini alır ve kullanıcının üyesi olduğu ekiplerin listesini alır (okunabilir listenin dışında tutulur).

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

Parametreler

projectId

string

Alınacak ekipleri 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 ekip sayısı üst sınırı.

skip

number

Atacak ekip 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 ekibi alın.

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

Parametreler

projectId

string

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

teamId

string

Ekibin 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

Ekibin 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)

Ekiplerin listesini alın.

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

Parametreler

projectId

string

mine

boolean

True ise, kullanıcı isteyen tüm ekiplerin üye olduğunu, aksi takdirde tüm teams kullanıcısının okuma erişimine sahip olduğunu döndür.

top

number

Döndürülecek ekip sayısı üst sınırı.

skip

number

Atacak ekip 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 projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla denetlemek 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 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)

Projenin avatarını 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)

Ekip 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

Özellik işlemleri dizisini temsil eden bir JSON Patch belgesi. JSON Düzeltme Eki hakkında daha fazla bilgi için bkz. RFC 6902. Kabul edilen işlem fiilleri Ekle ve Kaldır'dır; burada Ekle özelliği hem oluşturma hem de güncelleştirme 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 projenin adını, kısaltmasını, açıklamasını güncelleştirin veya projeyi geri yükleyin.

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

Parametreler

projectUpdate

TeamProject

Projenin güncelleştirmeleri. 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)

Ekibin adını ve/veya açıklamasını güncelleştirin.

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

Parametreler

teamData

WebApiTeam

projectId

string

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

teamId

string

Güncelleştirilecek ekibin kimliğinin adı.

Döndürülenler

Promise<WebApiTeam>