GraphRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
コンストラクター
| Graph |
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
GraphRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
addMembership(string, string)
コンテナーとサブジェクトの間に新しいメンバーシップを作成します。
function addMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>パラメーター
- subjectDescriptor
-
string
リレーションシップ内の子サブジェクトにすることができるグループまたはユーザーへの記述子。
- containerDescriptor
-
string
リレーションシップ内のコンテナーにできるグループへの記述子。
戻り値
Promise<GraphMembership>
checkMembershipExistence(string, string)
コンテナーとサブジェクトの間にメンバーシップ関係が存在するかどうかを確認します。
function checkMembershipExistence(subjectDescriptor: string, containerDescriptor: string): Promise<boolean>パラメーター
- subjectDescriptor
-
string
リレーションシップの子サブジェクトであるグループまたはユーザー。
- containerDescriptor
-
string
リレーションシップ内のコンテナーであるグループ。
戻り値
Promise<boolean>
createGroup(GraphGroupCreationContext, string, string[])
新しい Azure DevOps グループを作成するか、既存の AAD グループを具体化します。
function createGroup(creationContext: GraphGroupCreationContext, scopeDescriptor?: string, groupDescriptors?: string[]): Promise<GraphGroup>パラメーター
- creationContext
- GraphGroupCreationContext
外部プロバイダーでグラフの件名を一意に検索するために使用される完全なグラフ グループのサブセット。
- scopeDescriptor
-
string
グループを作成するスコープ (コレクション、プロジェクト) を参照する記述子。 省略すると、外側のアカウントまたはorganizationのスコープに が作成されます。 VSTS グループに対してのみ有効です。
- groupDescriptors
-
string[]
グラフ グループを結合するグループを参照する記述子のコンマ区切りリスト
戻り値
Promise<GraphGroup>
createScope(GraphScopeCreationContext, string)
function createScope(creationContext: GraphScopeCreationContext, scopeDescriptor?: string): Promise<GraphScope>パラメーター
- creationContext
- GraphScopeCreationContext
- scopeDescriptor
-
string
戻り値
Promise<GraphScope>
createServicePrincipal(GraphServicePrincipalCreationContext, string[])
既存の AAD サービス プリンシパルを ADO アカウントに具体化します。
function createServicePrincipal(creationContext: GraphServicePrincipalCreationContext, groupDescriptors?: string[]): Promise<GraphServicePrincipal>パラメーター
- creationContext
- GraphServicePrincipalCreationContext
外部プロバイダーでグラフの件名を一意に検索するために使用される完全なグラフ サービス プリンシパルのサブセット。
- groupDescriptors
-
string[]
グラフ サービス プリンシパルを結合するグループの記述子のコンマ区切りの一覧
戻り値
Promise<GraphServicePrincipal>
createUser(GraphUserCreationContext, string[])
既存の AAD または MSA ユーザーを ADO アカウントに具体化します。
function createUser(creationContext: GraphUserCreationContext, groupDescriptors?: string[]): Promise<GraphUser>パラメーター
- creationContext
- GraphUserCreationContext
外部プロバイダーでグラフの件名を一意に検索するために使用される完全なグラフ ユーザーのサブセット。
- groupDescriptors
-
string[]
グラフ ユーザーが参加させるグループの記述子のコンマ区切りのリスト
戻り値
Promise<GraphUser>
deleteAvatar(string)
function deleteAvatar(subjectDescriptor: string): Promise<void>パラメーター
- subjectDescriptor
-
string
戻り値
Promise<void>
deleteGroup(string)
すべての親グループから Azure DevOps グループを削除します。
function deleteGroup(groupDescriptor: string): Promise<void>パラメーター
- groupDescriptor
-
string
削除するグループの記述子。
戻り値
Promise<void>
deleteScope(string)
function deleteScope(scopeDescriptor: string): Promise<void>パラメーター
- scopeDescriptor
-
string
戻り値
Promise<void>
deleteServicePrincipal(string)
サービス プリンシパルを無効にします。
function deleteServicePrincipal(servicePrincipalDescriptor: string): Promise<void>パラメーター
- servicePrincipalDescriptor
-
string
削除するサービス プリンシパルの記述子。
戻り値
Promise<void>
deleteUser(string)
ユーザーを無効にします。
function deleteUser(userDescriptor: string): Promise<void>パラメーター
- userDescriptor
-
string
削除するユーザーの記述子。
戻り値
Promise<void>
getAvatar(string, AvatarSize, string)
function getAvatar(subjectDescriptor: string, size?: AvatarSize, format?: string): Promise<Avatar>パラメーター
- subjectDescriptor
-
string
- size
- AvatarSize
- format
-
string
戻り値
Promise<Avatar>
getCachePolicies()
getDescriptor(string)
ストレージ キーを記述子に解決する
function getDescriptor(storageKey: string): Promise<GraphDescriptorResult>パラメーター
- storageKey
-
string
解決するサブジェクト (ユーザー、グループ、スコープなど) のストレージ キー
戻り値
Promise<GraphDescriptorResult>
getFederatedProviderData(string, string, number)
特定のグラフのサブジェクトとプロバイダー名に使用できるフェデレーション プロバイダー認証データの完全なセットを取得します。
function getFederatedProviderData(subjectDescriptor: string, providerName: string, versionHint?: number): Promise<GraphFederatedProviderData>パラメーター
- subjectDescriptor
-
string
データを取得するグラフの件名の記述子
- providerName
-
string
データを取得するプロバイダーの名前 (例: "github.com"
- versionHint
-
number
オプティミスティック キャッシュコンカレンシーとアクセス トークンエラーの再試行をサポートするために使用できるバージョン ヒント。これはヒントのみであり、応答の特定のバージョンを保証しないことに注意してください
戻り値
Promise<GraphFederatedProviderData>
getGroup(string)
記述子でグループを取得します。
function getGroup(groupDescriptor: string): Promise<GraphGroup>パラメーター
- groupDescriptor
-
string
目的のグラフ グループの記述子。
戻り値
Promise<GraphGroup>
getMemberByDescriptor(string)
このエンドポイントは、そのメンバーが削除されたか、すべてのメンバーシップが削除された場合でも、システムで有効になったメンバーの結果を返します。 メンバーの現在の有効性は、無効なプロパティによって示されます。false の場合は省略されます。
function getMemberByDescriptor(memberDescriptor: string): Promise<GraphMember>パラメーター
- memberDescriptor
-
string
目的のメンバーの記述子。
戻り値
Promise<GraphMember>
getMembership(string, string)
コンテナーとサブジェクトの間のメンバーシップ関係を取得します。
function getMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>パラメーター
- subjectDescriptor
-
string
リレーションシップ内の子サブジェクトへの記述子。
- containerDescriptor
-
string
リレーションシップ内のコンテナーへの記述子。
戻り値
Promise<GraphMembership>
getMembershipState(string)
件名がアクティブか非アクティブかを確認します。
function getMembershipState(subjectDescriptor: string): Promise<GraphMembershipState>パラメーター
- subjectDescriptor
-
string
の状態をチェックするサブジェクト (ユーザー、グループ、スコープなど) の記述子
戻り値
Promise<GraphMembershipState>
getProviderInfo(string)
function getProviderInfo(userDescriptor: string): Promise<GraphProviderInfo>パラメーター
- userDescriptor
-
string
戻り値
Promise<GraphProviderInfo>
getScope(string)
記述子によって識別されるスコープを取得する
function getScope(scopeDescriptor: string): Promise<GraphScope>パラメーター
- scopeDescriptor
-
string
スコープを一意に識別する記述子。
戻り値
Promise<GraphScope>
getServicePrincipal(string)
記述子でサービス プリンシパルを取得します。
function getServicePrincipal(servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>パラメーター
- servicePrincipalDescriptor
-
string
目的のサービス プリンシパルの記述子。
戻り値
Promise<GraphServicePrincipal>
getStorageKey(string)
記述子をストレージ キーに解決します。
function getStorageKey(subjectDescriptor: string): Promise<GraphStorageKeyResult>パラメーター
- subjectDescriptor
-
string
戻り値
Promise<GraphStorageKeyResult>
getSubject(string)
記述子をユーザー、グループ、またはスコープに解決します。
function getSubject(subjectDescriptor: string): Promise<GraphSubject>パラメーター
- subjectDescriptor
-
string
目的のサブジェクトの記述子。
戻り値
Promise<GraphSubject>
getUser(string)
記述子でユーザーを取得します。
function getUser(userDescriptor: string): Promise<GraphUser>パラメーター
- userDescriptor
-
string
目的のユーザーの記述子。
戻り値
Promise<GraphUser>
listMemberships(string, GraphTraversalDirection, number)
この記述子がリレーションシップのメンバーであるすべてのメンバーシップを取得します。
function listMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembership[]>パラメーター
- subjectDescriptor
-
string
この記述子のすべての直接メンバーシップをフェッチします。
- direction
- GraphTraversalDirection
既定値は Up です。
- depth
-
number
メンバーシップ ツリーを上下に走査するエッジの最大数。 現在サポートされている値は '1' のみです。
戻り値
Promise<GraphMembership[]>
lookupMembers(GraphSubjectLookup)
現在のスコープ (通常はorganizationまたはアカウント) 内のすべての要求されたメンバーを取得します。
function lookupMembers(memberLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphMember}>パラメーター
- memberLookup
- GraphSubjectLookup
戻り値
Promise<{[key: string]: GraphMember}>
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)
指定されたサブジェクト記述子のメンバーシップを走査します。
function lookupMembershipTraversals(membershipTraversalLookup: GraphSubjectLookup, direction?: GraphTraversalDirection, depth?: number): Promise<{[key: string]: Graph.GraphMembershipTraversal}>パラメーター
- membershipTraversalLookup
- GraphSubjectLookup
方向に応じて、記述子の一覧の子孫/先祖をフェッチします。
- direction
- GraphTraversalDirection
既定値は Unknown です。
- depth
-
number
既定値は '1' です。
戻り値
Promise<{[key: string]: GraphMembershipTraversal}>
lookupSubjects(GraphSubjectLookup)
記述子を、バッチ内のユーザー、グループ、またはスコープ (サブジェクト) に解決します。
function lookupSubjects(subjectLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphSubject}>パラメーター
- subjectLookup
- GraphSubjectLookup
取得するサブジェクトのサブセットを指定する記述子のリスト。 各記述子は、すべてのインスタンス スコープでサブジェクトを一意に識別しますが、1 つの時点でのみ識別します。
戻り値
Promise<{[key: string]: GraphSubject}>
querySubjects(GraphSubjectQuery)
Azure Devops ユーザー、またはグループのSearch。 結果は、100 個以下のグラフサブジェクトを含むバッチで返されます。
function querySubjects(subjectQuery: GraphSubjectQuery): Promise<GraphSubject[]>パラメーター
- subjectQuery
- GraphSubjectQuery
検索に使用するクエリには、クエリ: 検索用語が含まれます。 検索はプレフィックス一致のみです。 SubjectKind: "User" または "Group" を指定できます。両方またはいずれかの ScopeDescriptor: 既定以外のスコープを指定できます (つまり、プロジェクト スコープ記述子)。
戻り値
Promise<GraphSubject[]>
removeMembership(string, string)
コンテナーとサブジェクトの間のメンバーシップを削除します。
function removeMembership(subjectDescriptor: string, containerDescriptor: string): Promise<void>パラメーター
- subjectDescriptor
-
string
リレーションシップの子サブジェクトであるグループまたはユーザーへの記述子。
- containerDescriptor
-
string
リレーションシップ内のコンテナーであるグループへの記述子。
戻り値
Promise<void>
requestAccess(any)
function requestAccess(jsondocument: any): Promise<void>パラメーター
- jsondocument
-
any
戻り値
Promise<void>
resolve(IdentityMappings)
ユーザーの一覧を新しいユーザーにバッチマップします。
function resolve(mappings: IdentityMappings): Promise<ResolveDisconnectedUsersResponse>パラメーター
- mappings
- IdentityMappings
マッピングの一覧。
戻り値
Promise<ResolveDisconnectedUsersResponse>
setAvatar(Avatar, string)
function setAvatar(avatar: Avatar, subjectDescriptor: string): Promise<void>パラメーター
- avatar
- Avatar
- subjectDescriptor
-
string
戻り値
Promise<void>
translate(string, string)
ID 変換 - 変換エンドポイントは、geneva アクションで使用されることになっています。
function translate(masterId?: string, localId?: string): Promise<string>パラメーター
- masterId
-
string
- localId
-
string
戻り値
Promise<string>
traverseMemberships(string, GraphTraversalDirection, number)
指定されたサブジェクト記述子のメンバーシップを走査します。
function traverseMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembershipTraversal>パラメーター
- subjectDescriptor
-
string
方向に応じて、この記述子の子孫/先祖をフェッチします。
- direction
- GraphTraversalDirection
既定値は Unknown です。
- depth
-
number
既定値は '1' です。
戻り値
Promise<GraphMembershipTraversal>
updateGroup(string, JsonPatchDocument)
Azure DevOps グループのプロパティを更新します。
function updateGroup(groupDescriptor: string, patchDocument: JsonPatchDocument): Promise<GraphGroup>パラメーター
- groupDescriptor
-
string
変更するグループの記述子。
- patchDocument
- JsonPatchDocument
変更するフィールドを含む JSON+Patch ドキュメント。
戻り値
Promise<GraphGroup>
updateScope(string, JsonPatchDocument)
function updateScope(scopeDescriptor: string, patchDocument: JsonPatchDocument): Promise<void>パラメーター
- scopeDescriptor
-
string
- patchDocument
- JsonPatchDocument
戻り値
Promise<void>
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)
既存のサービス プリンシパルを別のサービス プリンシパルにマップします。
function updateServicePrincipal(updateContext: GraphServicePrincipalUpdateContext, servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>パラメーター
- updateContext
- GraphServicePrincipalUpdateContext
外部プロバイダーでグラフの件名を一意に検索するために使用される完全なグラフ サービス プリンシパルのサブセット。
- servicePrincipalDescriptor
-
string
更新するサービス プリンシパルの記述子
戻り値
Promise<GraphServicePrincipal>
updateUser(GraphUserUpdateContext, string)
既存のユーザーを別のユーザーにマップします。
function updateUser(updateContext: GraphUserUpdateContext, userDescriptor: string): Promise<GraphUser>パラメーター
- updateContext
- GraphUserUpdateContext
外部プロバイダーでグラフの件名を一意に検索するために使用される完全なグラフ ユーザーのサブセット。
- userDescriptor
-
string
更新するユーザーの記述子
戻り値
Promise<GraphUser>