GraphRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Konstruktor

GraphRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

addMembership(string, string)	Buat keanggotaan baru antara kontainer dan subjek.
checkMembershipExistence(string, string)	Periksa untuk melihat apakah ada hubungan keanggotaan antara kontainer dan subjek.
createGroup(GraphGroupCreationContext, string, string[])	Buat grup Azure DevOps baru atau terwujudkan grup AAD yang sudah ada.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Mewujudkan perwakilan layanan AAD yang ada ke dalam akun ADO.
createUser(GraphUserCreationContext, string[])	Mewujudkan pengguna AAD atau MSA yang ada ke akun ADO.
deleteAvatar(string)
deleteGroup(string)	Menghapus grup Azure DevOps dari semua grup induknya.
deleteScope(string)
deleteServicePrincipal(string)	Menonaktifkan perwakilan layanan.
deleteUser(string)	Menonaktifkan pengguna.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Mengatasi kunci penyimpanan ke deskriptor
getFederatedProviderData(string, string, number)	Memperoleh kumpulan lengkap data autentikasi penyedia federasi yang tersedia untuk subjek grafik dan nama penyedia yang diberikan.
getGroup(string)	Dapatkan grup menurut deskriptornya.
getMemberByDescriptor(string)	Titik akhir ini mengembalikan hasil untuk setiap anggota yang pernah valid dalam sistem, bahkan jika anggota telah dihapus atau telah menghapus semua keanggotaan mereka. Validitas anggota saat ini ditunjukkan melalui properti yang dinonaktifkan, yang dihilangkan ketika false.
getMembership(string, string)	Dapatkan hubungan keanggotaan antara kontainer dan subjek.
getMembershipState(string)	Periksa apakah subjek aktif atau tidak aktif.
getProviderInfo(string)
getScope(string)	Mendapatkan cakupan yang diidentifikasi oleh deskriptornya
getServicePrincipal(string)	Dapatkan perwakilan layanan oleh deskriptornya.
getStorageKey(string)	Atasi deskriptor ke kunci penyimpanan.
getSubject(string)	Atasi deskriptor ke pengguna, grup, atau cakupan.
getUser(string)	Dapatkan pengguna dengan deskriptornya.
listMemberships(string, GraphTraversalDirection, number)	Dapatkan semua keanggotaan di mana deskriptor ini adalah anggota dalam hubungan.
lookupMembers(GraphSubjectLookup)	Mendapatkan semua anggota yang diminta dalam cakupan saat ini (biasanya organisasi atau akun).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Melintasi keanggotaan deskriptor subjek yang diberikan.
lookupSubjects(GraphSubjectLookup)	Atasi deskriptor untuk pengguna, grup, atau cakupan (Subjek) dalam batch.
querySubjects(GraphSubjectQuery)	Search untuk pengguna, atau/dan grup Azure Devops. Hasil akan dikembalikan dalam batch dengan tidak lebih dari 100 subjek grafik.
removeMembership(string, string)	Menghapus keanggotaan antara kontainer dan subjek.
requestAccess(any)
resolve(IdentityMappings)	Peta batch daftar pengguna ke pengguna baru.
setAvatar(Avatar, string)
translate(string, string)	Terjemahan Identitas - Titik akhir terjemahan seharusnya digunakan oleh tindakan jenewa.
traverseMemberships(string, GraphTraversalDirection, number)	Melintasi keanggotaan deskriptor subjek yang diberikan.
updateGroup(string, JsonPatchDocument)	Memperbarui properti grup Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Petakan perwakilan layanan yang ada ke perwakilan layanan yang berbeda.
updateUser(GraphUserUpdateContext, string)	Memetakan pengguna yang sudah ada ke pengguna lain.

Detail Konstruktor

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addMembership(string, string)

Buat keanggotaan baru antara kontainer dan subjek.

function addMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>

Parameter

subjectDescriptor

string

Deskriptor untuk grup atau pengguna yang dapat menjadi subjek anak dalam hubungan.

containerDescriptor

string

Deskriptor ke grup yang dapat menjadi kontainer dalam hubungan.

Mengembalikan

Promise<GraphMembership>

checkMembershipExistence(string, string)

Periksa untuk melihat apakah ada hubungan keanggotaan antara kontainer dan subjek.

function checkMembershipExistence(subjectDescriptor: string, containerDescriptor: string): Promise<boolean>

Parameter

subjectDescriptor

string

Grup atau pengguna yang merupakan subjek anak dari hubungan.

containerDescriptor

string

Grup yang merupakan kontainer dalam hubungan.

Mengembalikan

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Buat grup Azure DevOps baru atau terwujudkan grup AAD yang sudah ada.

function createGroup(creationContext: GraphGroupCreationContext, scopeDescriptor?: string, groupDescriptors?: string[]): Promise<GraphGroup>

Parameter

creationContext

GraphGroupCreationContext

Subset grup grafik lengkap yang digunakan untuk menemukan subjek grafik secara unik di penyedia eksternal.

scopeDescriptor

string

Deskriptor yang mereferensikan cakupan (koleksi, proyek) tempat grup harus dibuat. Jika dihilangkan, akan dibuat dalam cakupan akun atau organisasi penutup. Hanya berlaku untuk grup VSTS.

groupDescriptors

string[]

Daftar deskriptor yang dipisahkan koma yang mereferensikan grup yang Anda inginkan untuk bergabung dengan grup grafik

Mengembalikan

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

function createScope(creationContext: GraphScopeCreationContext, scopeDescriptor?: string): Promise<GraphScope>

Parameter

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Mengembalikan

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Mewujudkan perwakilan layanan AAD yang ada ke dalam akun ADO.

function createServicePrincipal(creationContext: GraphServicePrincipalCreationContext, groupDescriptors?: string[]): Promise<GraphServicePrincipal>

Parameter

creationContext

GraphServicePrincipalCreationContext

Subset perwakilan layanan grafik lengkap yang digunakan untuk menemukan subjek grafik secara unik di penyedia eksternal.

groupDescriptors

string[]

Daftar deskriptor grup yang dipisahkan koma yang Anda inginkan untuk bergabung dengan perwakilan layanan grafik

Mengembalikan

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Mewujudkan pengguna AAD atau MSA yang ada ke akun ADO.

function createUser(creationContext: GraphUserCreationContext, groupDescriptors?: string[]): Promise<GraphUser>

Parameter

creationContext

GraphUserCreationContext

Subset pengguna grafik lengkap yang digunakan untuk menemukan subjek grafik secara unik di penyedia eksternal.

groupDescriptors

string[]

Daftar deskriptor grup yang dipisahkan koma yang Anda inginkan untuk bergabung dengan pengguna grafik

Mengembalikan

Promise<GraphUser>

deleteAvatar(string)

function deleteAvatar(subjectDescriptor: string): Promise<void>

Parameter

subjectDescriptor

string

Mengembalikan

Promise<void>

deleteGroup(string)

Menghapus grup Azure DevOps dari semua grup induknya.

function deleteGroup(groupDescriptor: string): Promise<void>

Parameter

groupDescriptor

string

Pendeskripsi grup yang akan dihapus.

Mengembalikan

Promise<void>

deleteScope(string)

function deleteScope(scopeDescriptor: string): Promise<void>

Parameter

scopeDescriptor

string

Mengembalikan

Promise<void>

deleteServicePrincipal(string)

Menonaktifkan perwakilan layanan.

function deleteServicePrincipal(servicePrincipalDescriptor: string): Promise<void>

Parameter

servicePrincipalDescriptor

string

Pendeskripsi perwakilan layanan yang akan dihapus.

Mengembalikan

Promise<void>

deleteUser(string)

Menonaktifkan pengguna.

function deleteUser(userDescriptor: string): Promise<void>

Parameter

userDescriptor

string

Pendeskripsi pengguna yang akan dihapus.

Mengembalikan

Promise<void>

getAvatar(string, AvatarSize, string)

function getAvatar(subjectDescriptor: string, size?: AvatarSize, format?: string): Promise<Avatar>

Parameter

subjectDescriptor

string

size

AvatarSize

format

string

Mengembalikan

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Mengembalikan

Promise<GraphCachePolicies>

getDescriptor(string)

Mengatasi kunci penyimpanan ke deskriptor

function getDescriptor(storageKey: string): Promise<GraphDescriptorResult>

Parameter

storageKey

string

Kunci penyimpanan subjek (pengguna, grup, cakupan, dll.) untuk mengatasinya

Mengembalikan

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Memperoleh kumpulan lengkap data autentikasi penyedia federasi yang tersedia untuk subjek grafik dan nama penyedia yang diberikan.

function getFederatedProviderData(subjectDescriptor: string, providerName: string, versionHint?: number): Promise<GraphFederatedProviderData>

Parameter

subjectDescriptor

string

pendeskripsi subjek grafik yang harus kita peroleh datanya

providerName

string

nama penyedia untuk memperoleh data, misalnya "github.com"

versionHint

number

petunjuk versi yang dapat digunakan untuk konkurensi cache optimis dan untuk mendukung percobaan kembali pada kegagalan token akses; perhatikan bahwa ini hanya petunjuk dan tidak menjamin versi tertentu pada respons

Mengembalikan

Promise<GraphFederatedProviderData>

getGroup(string)

Dapatkan grup menurut deskriptornya.

function getGroup(groupDescriptor: string): Promise<GraphGroup>

Parameter

groupDescriptor

string

Deskriptor grup grafik yang diinginkan.

Mengembalikan

Promise<GraphGroup>

getMemberByDescriptor(string)

Titik akhir ini mengembalikan hasil untuk setiap anggota yang pernah valid dalam sistem, bahkan jika anggota telah dihapus atau telah menghapus semua keanggotaan mereka. Validitas anggota saat ini ditunjukkan melalui properti yang dinonaktifkan, yang dihilangkan ketika false.

function getMemberByDescriptor(memberDescriptor: string): Promise<GraphMember>

Parameter

memberDescriptor

string

Pendeskripsi anggota yang diinginkan.

Mengembalikan

Promise<GraphMember>

getMembership(string, string)

Dapatkan hubungan keanggotaan antara kontainer dan subjek.

function getMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>

Parameter

subjectDescriptor

string

Deskriptor untuk subjek anak dalam hubungan.

containerDescriptor

string

Deskriptor ke kontainer dalam hubungan.

Mengembalikan

Promise<GraphMembership>

getMembershipState(string)

Periksa apakah subjek aktif atau tidak aktif.

function getMembershipState(subjectDescriptor: string): Promise<GraphMembershipState>

Parameter

subjectDescriptor

string

Deskriptor subjek (pengguna, grup, cakupan, dll.) untuk memeriksa status

Mengembalikan

Promise<GraphMembershipState>

getProviderInfo(string)

function getProviderInfo(userDescriptor: string): Promise<GraphProviderInfo>

Parameter

userDescriptor

string

Mengembalikan

Promise<GraphProviderInfo>

getScope(string)

Mendapatkan cakupan yang diidentifikasi oleh deskriptornya

function getScope(scopeDescriptor: string): Promise<GraphScope>

Parameter

scopeDescriptor

string

Deskriptor yang secara unik mengidentifikasi cakupan.

Mengembalikan

Promise<GraphScope>

getServicePrincipal(string)

Dapatkan perwakilan layanan oleh deskriptornya.

function getServicePrincipal(servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>

Parameter

servicePrincipalDescriptor

string

Pendeskripsi perwakilan layanan yang diinginkan.

Mengembalikan

Promise<GraphServicePrincipal>

getStorageKey(string)

Atasi deskriptor ke kunci penyimpanan.

function getStorageKey(subjectDescriptor: string): Promise<GraphStorageKeyResult>

Parameter

subjectDescriptor

string

Mengembalikan

Promise<GraphStorageKeyResult>

getSubject(string)

Atasi deskriptor ke pengguna, grup, atau cakupan.

function getSubject(subjectDescriptor: string): Promise<GraphSubject>

Parameter

subjectDescriptor

string

Pendeskripsi subjek yang diinginkan.

Mengembalikan

Promise<GraphSubject>

getUser(string)

Dapatkan pengguna dengan deskriptornya.

function getUser(userDescriptor: string): Promise<GraphUser>

Parameter

userDescriptor

string

Pendeskripsi pengguna yang diinginkan.

Mengembalikan

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Dapatkan semua keanggotaan di mana deskriptor ini adalah anggota dalam hubungan.

function listMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembership[]>

Parameter

subjectDescriptor

string

Ambil semua keanggotaan langsung deskriptor ini.

direction

GraphTraversalDirection

Default ke Atas.

depth

number

Jumlah maksimum tepi untuk melintasi ke atas atau ke bawah pohon keanggotaan. Saat ini satu-satunya nilai yang didukung adalah '1'.

Mengembalikan

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Mendapatkan semua anggota yang diminta dalam cakupan saat ini (biasanya organisasi atau akun).

function lookupMembers(memberLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphMember}>

Parameter

memberLookup

GraphSubjectLookup

Mengembalikan

Promise<{[key: string]: GraphMember}>

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Melintasi keanggotaan deskriptor subjek yang diberikan.

function lookupMembershipTraversals(membershipTraversalLookup: GraphSubjectLookup, direction?: GraphTraversalDirection, depth?: number): Promise<{[key: string]: Graph.GraphMembershipTraversal}>

Parameter

membershipTraversalLookup

GraphSubjectLookup

Ambil turunan/leluhur daftar deskriptor tergantung pada arah.

direction

GraphTraversalDirection

Nilai defaultnya tidak diketahui.

depth

number

Nilai defaultnya adalah '1'.

Mengembalikan

Promise<{[key: string]: GraphMembershipTraversal}>

lookupSubjects(GraphSubjectLookup)

Atasi deskriptor untuk pengguna, grup, atau cakupan (Subjek) dalam batch.

function lookupSubjects(subjectLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphSubject}>

Parameter

subjectLookup

GraphSubjectLookup

Daftar deskriptor yang menentukan subset subjek yang akan diambil. Setiap deskriptor secara unik mengidentifikasi subjek di semua cakupan instans, tetapi hanya pada satu titik waktu.

Mengembalikan

Promise<{[key: string]: GraphSubject}>

querySubjects(GraphSubjectQuery)

Search untuk pengguna, atau/dan grup Azure Devops. Hasil akan dikembalikan dalam batch dengan tidak lebih dari 100 subjek grafik.

function querySubjects(subjectQuery: GraphSubjectQuery): Promise<GraphSubject[]>

Parameter

subjectQuery

GraphSubjectQuery

Kueri yang akan kita gunakan untuk mencari mencakup yang berikut ini: Kueri: istilah pencarian. Pencarian hanya akan cocok dengan awalan. SubjectKind: "Pengguna" atau "Grup" dapat ditentukan, baik atau ScopeDescriptor: Cakupan non-default dapat ditentukan, yaitu deskriptor cakupan proyek

Mengembalikan

Promise<GraphSubject[]>

removeMembership(string, string)

Menghapus keanggotaan antara kontainer dan subjek.

function removeMembership(subjectDescriptor: string, containerDescriptor: string): Promise<void>

Parameter

subjectDescriptor

string

Deskriptor untuk grup atau pengguna yang merupakan subjek anak dalam hubungan.

containerDescriptor

string

Deskriptor ke grup yang merupakan kontainer dalam hubungan.

Mengembalikan

Promise<void>

requestAccess(any)

function requestAccess(jsondocument: any): Promise<void>

Parameter

jsondocument

any

Mengembalikan

Promise<void>

resolve(IdentityMappings)

Peta batch daftar pengguna ke pengguna baru.

function resolve(mappings: IdentityMappings): Promise<ResolveDisconnectedUsersResponse>

Parameter

mappings

IdentityMappings

Daftar pemetaan.

Mengembalikan

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

function setAvatar(avatar: Avatar, subjectDescriptor: string): Promise<void>

Parameter

avatar

Avatar

subjectDescriptor

string

Mengembalikan

Promise<void>

translate(string, string)

Terjemahan Identitas - Titik akhir terjemahan seharusnya digunakan oleh tindakan jenewa.

function translate(masterId?: string, localId?: string): Promise<string>

Parameter

masterId

string

localId

string

Mengembalikan

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Melintasi keanggotaan deskriptor subjek yang diberikan.

function traverseMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembershipTraversal>

Parameter

subjectDescriptor

string

Ambil keturunan/leluhur deskriptor ini tergantung pada arahnya.

direction

GraphTraversalDirection

Nilai defaultnya tidak diketahui.

depth

number

Nilai defaultnya adalah '1'.

Mengembalikan

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Memperbarui properti grup Azure DevOps.

function updateGroup(groupDescriptor: string, patchDocument: JsonPatchDocument): Promise<GraphGroup>

Parameter

groupDescriptor

string

Deskriptor grup yang akan dimodifikasi.

patchDocument

JsonPatchDocument

Dokumen JSON+Patch yang berisi bidang untuk diubah.

Mengembalikan

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

function updateScope(scopeDescriptor: string, patchDocument: JsonPatchDocument): Promise<void>

Parameter

scopeDescriptor

string

patchDocument

JsonPatchDocument

Mengembalikan

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Petakan perwakilan layanan yang ada ke perwakilan layanan yang berbeda.

function updateServicePrincipal(updateContext: GraphServicePrincipalUpdateContext, servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>

Parameter

updateContext

GraphServicePrincipalUpdateContext

Subset perwakilan layanan grafik lengkap yang digunakan untuk menemukan subjek grafik secara unik di penyedia eksternal.

servicePrincipalDescriptor

string

Pendeskripsi perwakilan layanan yang akan diperbarui

Mengembalikan

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Memetakan pengguna yang sudah ada ke pengguna lain.

function updateUser(updateContext: GraphUserUpdateContext, userDescriptor: string): Promise<GraphUser>

Parameter

updateContext

GraphUserUpdateContext

Subset pengguna grafik lengkap yang digunakan untuk menemukan subjek grafik secara unik di penyedia eksternal.

userDescriptor

string

Pendeskripsi pengguna yang akan diperbarui

Mengembalikan

Promise<GraphUser>