GitRestClient class

リファレンス

パッケージ:: azure-devops-extension-api

VSS REST API への要求を行うために使用する (派生する) 基本クラス

Extends: RestClientBase

コンストラクター

GitRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

createAnnotatedTag(GitAnnotatedTag, string, string)	注釈付きタグを作成します。
createAttachment(any, string, string, number, string)	新しいファイルをプル要求にアタッチします。
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry は、プル要求に関連付けられている特定のコミットまたはコミットを新しいブランチに選択します。
createComment(Comment, string, number, number, string)	プル要求で特定のスレッドにコメントを作成します (スレッドごとに最大 500 個のコメントを作成できます)。
createCommitStatus(GitStatus, string, string, string)	Git コミットの状態を作成します。
createFavorite(GitRefFavorite, string)	参照のお気に入りを作成します
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	別のリポジトリの ref をこのリポジトリにフェッチすることを要求します。 2 つの既存のフォークを同期します。フォークを作成するには、href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"<を参照してください。/a><リポジトリエンドポイントを> する
createImportRequest(GitImportRequest, string, string)	インポート要求を作成します。
createLike(string, number, number, number, string)	コメントにいいねを追加します。
createMergeRequest(GitMergeParameters, string, string, boolean)	Git マージ操作を要求します。現在、マージは 2 つのコミットのみをサポートしています。
createPullRequest(GitPullRequest, string, string, boolean)	pull request を作成します。
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	イテレーションでプル要求の状態を作成します。この操作の結果は、要求本文で指定されたイテレーション ID を持つプル要求の状態の作成と同じ結果になります。
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	タグ (まだ存在しない場合) を作成し、指定されたプル要求のラベル (タグ) として追加します。必須フィールドは、新しいラベル (タグ) の名前だけです。
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	pull request にレビュー担当者を追加するか、投票を行います。
createPullRequestReviewers(IdentityRef[], string, number, string)	pull request にレビュー担当者を追加します。
createPullRequestStatus(GitPullRequestStatus, string, number, string)	プル要求の状態を作成します。
createPush(GitPush, string, string)	リポジトリに変更をプッシュします。
createRepository(GitRepositoryCreateOptions, string, string)	チームプロジェクトに Git リポジトリを作成します。
createRevert(GitAsyncRefOperationParameters, string, string)	プル要求に関連付けられている特定のコミットまたはコミットによって導入された変更を元に戻す新しいブランチを作成する操作を開始します。
createThread(GitPullRequestCommentThread, string, number, string)	プル要求でスレッドを作成します。
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	プル要求のレビュー担当者に、未具体化 ID を追加します。
deleteAttachment(string, string, number, string)	pull request 添付ファイルを削除します。
deleteComment(string, number, number, number, string)	プル要求の特定のスレッドに関連付けられているコメントを削除します。
deleteEnablementStatus(boolean, boolean, string[])	DELETE では、有効化状態と BillableCommitters データが DB から削除されます。有効化データを削除すると、影響を受けるリポジトリに対して有効データが実質的に無効になります。
deleteLike(string, number, number, number, string)	コメントのいいねを削除します。
deletePullRequestIterationStatus(string, number, number, number, string)	pull request イテレーションの状態を削除します。
deletePullRequestLabels(string, number, string, string, string)	プル要求に割り当てられている一連のラベル (タグ) を削除します。タグ自体は削除されません。
deletePullRequestReviewer(string, number, string, string)	pull request からレビュー担当者を削除します。
deletePullRequestStatus(string, number, number, string)	pull request の状態を削除します。
deleteRefFavorite(string, number)	指定した refs favorite を削除します。
deleteRepository(string, string)	Git リポジトリを削除する
deleteRepositoryFromRecycleBin(string, string)	論理的に削除された Git リポジトリを破棄 (ハード削除) します。
getAnnotatedTag(string, string, string)	注釈付きタグを取得します。
getAttachmentContent(string, string, number, string)	pull request 添付ファイルのファイルコンテンツを取得します。
getAttachments(string, number, string)	特定のプル要求にアタッチされているファイルの一覧を取得します。
getAttachmentZip(string, string, number, string)	pull request 添付ファイルのファイルコンテンツを取得します。
getBillableCommitters(string, Date, number, number)	特定の日付の Advanced Security サービスの実際の課金対象コミッターを取得します。
getBillableCommittersDetail(string, string, Date)	特定の日付の Advanced Security サービスの実際の課金対象コミッターの詳細を取得します。詳細な結果は、論理的に削除されたプロジェクトとリポジトリを意図的に除外して課金の問題を診断しません。
getBlob(string, string, string, boolean, string, boolean)	1 つの BLOB を取得します。
getBlobContent(string, string, string, boolean, string, boolean)	1 つの BLOB を取得します。
getBlobsZip(string[], string, string, string)	zip ファイルのダウンロードで 1 つ以上の BLOB を取得します。
getBlobZip(string, string, string, boolean, string, boolean)	1 つの BLOB を取得します。
getBranch(string, string, string, GitVersionDescriptor)	単一ブランチに関する統計情報を取得します。
getBranches(string, string, GitVersionDescriptor)	リポジトリ内のすべてのブランチに関する統計情報を取得します。
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	複数のコミットの統計を取得する
getChanges(string, string, string, number, number)	特定のコミットの変更を取得します。
getCherryPick(string, number, string)	チェリーピック ID を使用して、チェリーピック操作に関する情報を取得します。
getCherryPickConflict(string, number, number, string)	ID でチェリーピックの競合を 1 つ取得する
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	チェリーピックのすべての競合を取得する
getCherryPickForRefName(string, string, string)	特定のブランチのチェリーピック操作に関する情報を取得します。この操作は基になるオブジェクト構造のためにコストがかかるため、この API では最新の 1000 個のチェリーピック操作のみを確認します。
getCherryPickRelationships(string, string, string, boolean)	commitId を指定すると、同じチェリーピックファミリ内にあるコミットの一覧が返されます。
getComment(string, number, number, number, string)	プル要求の特定のスレッドに関連付けられているコメントを取得します。
getComments(string, number, number, string)	プル要求の特定のスレッドに関連付けられているすべてのコメントを取得します。
getCommit(string, string, string, number)	特定のコミットを取得します。
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	基本コミットとターゲットコミットの間で最も近い共通コミット (マージベース) を見つけ、基本コミットとターゲットコミット、または共通コミットとターゲットコミットの間の差分を取得します。
getCommits(string, GitQueryCommitsCriteria, string)	プロジェクトの Git コミットを取得する
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	検索条件に一致するプロジェクトの git コミットを取得する
getDeletedRepositories(string)	削除された Git リポジトリを取得します。
getEnablementStatus(string[], Date, number, number)	プロジェクトのリポジトリの GET 有効化状態。
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	過去 90 日間のリポジトリの推定課金対象コミッターを取得します。
getEstimatedBillablePushersOrg()	過去 90 日間の組織の見積もり課金対象プッシャーを取得します。
getEstimatedBillablePushersProject(string)	過去 90 日間のプロジェクトの見積もり課金対象プッシャーを取得します。
getFileDiffs(FileDiffsCriteria, string, string)	指定された各ファイルのファイルの相違を取得します
getForks(string, string, string, boolean)	コレクション内のリポジトリのすべてのフォークを取得します。
getForkSyncRequest(string, number, string, boolean)	特定のフォーク同期操作の詳細を取得します。
getForkSyncRequests(string, string, boolean, boolean)	このリポジトリで要求されたすべてのフォーク同期操作を取得します。
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	アイテムのコレクションのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。常にダウンロードとして返される zip 形式のコンテンツには適用されません。
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getImportRequest(string, string, number)	特定のインポート要求を取得します。
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	アイテムのコレクションのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。常にダウンロードとして返される zip 形式のコンテンツには適用されません。
getItemsBatch(GitItemRequestData, string, string)	パスまたは長いパスの一覧を指定して、リポジトリ/プロジェクト内の一連の項目からバッチを作成する処理を取得するための投稿
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。
getLikes(string, number, number, number, string)	コメントのいいねを取得します。
getMergeBases(string, string, string, string, string, string)	必要に応じて、フォーク間で 2 つのコミットのマージベースを検索します。 otherRepositoryId が指定されていない場合、マージベースはローカルリポジトリのNameOrId のコンテキスト内でのみ計算されます。
getMergeRequest(string, string, number, boolean)	特定のマージ操作の詳細を取得します。
getPermission(string, string, string)	セキュリティの詳細アクセス許可の状態を取得します。
getPullRequest(string, number, string, number, number, number, boolean, boolean)	pull request を取得します。
getPullRequestById(number, string)	pull request を取得します。
getPullRequestCommits(string, number, string)	指定したプル要求のコミットを取得します。
getPullRequestConflict(string, number, number, string)	ID でプル要求の競合を 1 つ取得する
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	プル要求のすべての競合を取得する
getPullRequestIteration(string, number, number, string)	プル要求の指定されたイテレーションを取得します。
getPullRequestIterationChanges(string, number, number, string, number, number, number)	2 つのイテレーションの間にプル要求で行われた変更を取得します。
getPullRequestIterationCommits(string, number, number, string, number, number)	プル要求の指定されたイテレーションのコミットを取得します。
getPullRequestIterations(string, number, string, boolean)	指定したプル要求のイテレーションの一覧を取得します。
getPullRequestIterationStatus(string, number, number, number, string)	特定の pull request イテレーションの状態を ID で取得します。状態 ID は、すべてのイテレーションにわたって pull request 内で一意です。
getPullRequestIterationStatuses(string, number, number, string)	プル要求のイテレーションに関連付けられているすべての状態を取得します。
getPullRequestLabel(string, number, string, string, string)	プル要求に割り当てられている 1 つのラベル (タグ) を取得します。
getPullRequestLabels(string, number, string, string)	プル要求に割り当てられているすべてのラベル (タグ) を取得します。
getPullRequestProperties(string, number, string)	pull request の外部プロパティを取得します。
getPullRequestQuery(GitPullRequestQuery, string, string)	この API は、特定のコミットに関連するプル要求を見つけるために使用されます。これを使用して、特定のマージコミットを作成した pull request を見つけるか、特定のコミットをマージしたすべてのプル要求を検索するために使用できます。入力は、それぞれがコミットのリストを含むクエリのリストです。検索対象のコミットごとに、コミットのディクショナリ (pull request を>) が返されます。
getPullRequestReviewer(string, number, string, string)	プル要求の特定のレビュー担当者に関する情報を取得する
getPullRequestReviewers(string, number, string)	pull request のレビュー担当者を取得する
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	指定した条件に一致するすべてのプル要求を取得します。
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	指定した条件に一致するすべてのプル要求を取得します。
getPullRequestStatus(string, number, number, string)	ID で特定のプル要求の状態を取得します。状態 ID は、すべてのイテレーションにわたって pull request 内で一意です。
getPullRequestStatuses(string, number, string)	プル要求に関連付けられているすべての状態を取得します。
getPullRequestThread(string, number, number, string, number, number)	プル要求でスレッドを取得します。
getPullRequestWorkItemRefs(string, number, string)	プル要求に関連付けられている作業項目の一覧を取得します。
getPush(string, number, string, number, boolean)	特定のプッシュを取得します。
getPushCommits(string, number, string, number, number, boolean)	特定のプッシュに関連付けられているコミットの一覧を取得します。
getPushes(string, string, number, number, GitPushSearchCriteria)	指定したリポジトリに関連付けられているプッシュを取得します。
getRecycleBinRepositories(string)	ごみ箱から論理的に削除された Git リポジトリを取得します。
getRefFavorite(string, number)	お気に入りの ID の refs favorite を取得します。
getRefFavorites(string, string, string)	リポジトリと ID の refs のお気に入りを取得します。
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	指定されたリポジトリの ref を照会し、それらを返します。
getRepositories(string, boolean, boolean, boolean)	Git リポジトリを取得します。
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	名前と改ページによってフィルター処理された Git リポジトリを取得します。
getRepository(string, string)	Git リポジトリを取得します。
getRepositoryWithParent(string, boolean, string)	Git リポジトリを取得します。
getRevert(string, number, string)	元に戻す操作に関する情報を、元に戻す ID で取得します。
getRevertConflict(string, number, number, string)	ID で元に戻す 1 つの競合を取得する
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	元に戻すすべての競合を取得する
getRevertForRefName(string, string, string)	特定のブランチの元に戻す操作に関する情報を取得します。
getStatuses(string, string, string, number, number, boolean)	Git コミットに関連付けられている状態を取得します。
getSuggestions(string, string, boolean)	特定のリポジトリまたはチームプロジェクトの pull request 候補を取得します。
getThreads(string, number, string, number, number)	プル要求内のすべてのスレッドを取得します。
getTree(string, string, string, string, boolean, string)	Tree エンドポイントは、指定したツリーの下にあるオブジェクトのコレクションを返します。ツリーは Git リポジトリ内のフォルダーです。
getTreeZip(string, string, string, string, boolean, string)	Tree エンドポイントは、指定したツリーの下にあるオブジェクトのコレクションを返します。ツリーは Git リポジトリ内のフォルダーです。
queryImportRequests(string, string, boolean)	リポジトリのインポート要求を取得します。
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	論理的に削除された Git リポジトリを回復します。最近削除されたリポジトリは、ハード削除されて回復不能になる前に、一定期間論理的な削除状態になります。
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	特定のプル要求に関する電子メール通知を一連の受信者に送信する
updateCherryPickConflict(GitConflict, string, number, number, string)	マージ競合の解決を更新する
updateCherryPickConflicts(GitConflict[], string, number, string)	複数のマージ競合の解決を更新する
updateComment(Comment, string, number, number, number, string)	プル要求の特定のスレッドに関連付けられているコメントを更新します。
updateEnablementStatus(AdvSecEnablementUpdate[])	リポジトリの POST 有効化の状態。
updateImportRequest(GitImportRequest, string, string, number)	失敗したインポート要求を再試行するか破棄します。
updatePullRequest(GitPullRequest, string, number, string)	pull request を更新する
updatePullRequestConflict(GitConflict, string, number, number, string)	マージ競合の解決を更新する
updatePullRequestConflicts(GitConflict[], string, number, string)	複数のマージ競合の解決を更新する
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	pull request iteration statuses コレクションを更新します。サポートされている操作の種類は `remove`のみです。
updatePullRequestProperties(JsonPatchDocument, string, number, string)	pull request 外部プロパティを作成または更新します。パッチ操作は、`add`、`replace`、または `remove`できます。 `add` 操作の場合、パスは空にすることができます。パスが空の場合、値はキーと値のペアのリストである必要があります。 `replace` 操作の場合、パスを空にすることはできません。パスが存在しない場合は、プロパティがコレクションに追加されます。 `remove` 操作の場合、パスを空にすることはできません。パスが存在しない場合、アクションは実行されません。
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	校閲者のエントリを編集します。これらのフィールドは修正可能です:isFlagged、hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	プル要求で複数のレビュー担当者の投票をリセットします。注: このエンドポイントは投票の更新のみをサポートしますが、必要なレビュー担当者の更新 (ポリシーの使用) や表示名はサポートしていません。
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	pull request statuses コレクションを更新します。サポートされている操作の種類は `remove`のみです。
updateRef(GitRefUpdate, string, string, string, string)	ブランチをロックまたはロック解除します。
updateRefs(GitRefUpdate[], string, string, string)	refs(branchs) の作成、更新、または削除。
updateRepository(GitRepository, string, string)	Git リポジトリを新しいリポジトリ名または新しい既定のブランチで更新します。
updateRevertConflict(GitConflict, string, number, number, string)	マージ競合の解決を更新する
updateRevertConflicts(GitConflict[], string, number, string)	複数のマージ競合の解決を更新する
updateThread(GitPullRequestCommentThread, string, number, number, string)	プル要求のスレッドを更新します。

コンストラクターの詳細

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

パラメーター

options: IVssRestClientOptions

プロパティの詳細

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

プロパティ値

string

メソッドの詳細

createAnnotatedTag(GitAnnotatedTag, string, string)

注釈付きタグを作成します。

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

パラメーター

tagObject: GitAnnotatedTag

作成するタグの詳細を含むオブジェクト。

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID または名前。

戻り値

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

新しいファイルをプル要求にアタッチします。

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

パラメーター

content: any

アップロードするコンテンツ

fileName: string

ファイルの名前。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry は、プル要求に関連付けられている特定のコミットまたはコミットを新しいブランチに選択します。

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

パラメーター

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

戻り値

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

プル要求で特定のスレッドにコメントを作成します (スレッドごとに最大 500 個のコメントを作成できます)。

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

パラメーター

comment: Comment

作成するコメント。コメントは最大 150,000 文字です。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

目的のコメントが含まれているスレッドの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Git コミットの状態を作成します。

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

パラメーター

gitCommitStatusToCreate: GitStatus

作成する Git コミット状態オブジェクト。

commitId: string

Git コミットの ID。

repositoryId: string

リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

参照のお気に入りを作成します

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

パラメーター

favorite: GitRefFavorite

作成する参照のお気に入り。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

別のリポジトリの ref をこのリポジトリにフェッチすることを要求します。 2 つの既存のフォークを同期します。フォークを作成するには、href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"<を参照してください。/a><リポジトリエンドポイントを> する

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

パラメーター

syncParams: GitForkSyncRequestParameters

ソースリポジトリと ref マッピング。

repositoryNameOrId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

includeLinks: boolean

リンクを含める場合は True

戻り値

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

インポート要求を作成します。

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

パラメーター

importRequest: GitImportRequest

作成するインポート要求。

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの名前または ID。

戻り値

Promise<GitImportRequest>

createLike(string, number, number, number, string)

コメントにいいねを追加します。

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

コメントを含むスレッドの ID。

commentId: number

コメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Git マージ操作を要求します。現在、マージは 2 つのコミットのみをサポートしています。

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

パラメーター

mergeParameters: GitMergeParameters

親の commitId とマージコミットの混乱。

project: string

プロジェクト ID またはプロジェクト名

repositoryNameOrId: string

リポジトリの名前または ID。

includeLinks: boolean

リンクを含める場合は True

戻り値

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

pull request を作成します。

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

パラメーター

gitPullRequestToCreate: GitPullRequest

作成するプル要求。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

project: string

プロジェクト ID またはプロジェクト名

supportsIterations: boolean

true の場合、pull request への後続のプッシュは個別に確認できます。この機能が必要ない場合は、パフォーマンス上の理由から大きなプル要求の場合は false に設定します。

戻り値

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

イテレーションでプル要求の状態を作成します。この操作の結果は、要求本文で指定されたイテレーション ID を持つプル要求の状態の作成と同じ結果になります。

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

パラメーター

status: GitPullRequestStatus

作成するプル要求の状態。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

タグ (まだ存在しない場合) を作成し、指定されたプル要求のラベル (タグ) として追加します。必須フィールドは、新しいラベル (タグ) の名前だけです。

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

パラメーター

label: WebApiCreateTagRequestData

プル要求に割り当てるラベル。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID またはプロジェクト名。

戻り値

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

pull request にレビュー担当者を追加するか、投票を行います。

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

パラメーター

reviewer: IdentityRefWithVote

校閲者の投票。<br/>校閲者の ID がここに含まれている場合は、reviewerID パラメーターと一致する必要があります。<br/>レビュー担当者は、この方法で独自の投票を設定できます。他のレビュー担当者を追加する場合は、投票を 0 に設定する必要があります。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

reviewerId: string

レビュー担当者の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

pull request にレビュー担当者を追加します。

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

パラメーター

reviewers: IdentityRef[]

pull request に追加するレビュー担当者。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

プル要求の状態を作成します。

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

パラメーター

status: GitPullRequestStatus

作成するプル要求の状態。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

リポジトリに変更をプッシュします。

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

パラメーター

push: GitPush

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

チームプロジェクトに Git リポジトリを作成します。

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

パラメーター

gitRepositoryToCreate: GitRepositoryCreateOptions

リポジトリ名、チームプロジェクト、親リポジトリを指定します。要求がプロジェクトスコープ (プロジェクト ID を含む) の場合は、gitRepositoryToCreate からチームプロジェクト情報を省略できます。

project: string

プロジェクト ID またはプロジェクト名

sourceRef: string

[省略可能]フォークリポジトリの作成時に使用するソース参照を指定する

戻り値

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

プル要求に関連付けられている特定のコミットまたはコミットによって導入された変更を元に戻す新しいブランチを作成する操作を開始します。

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

パラメーター

revertToCreate: GitAsyncRefOperationParameters

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

戻り値

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

プル要求でスレッドを作成します。

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

パラメーター

commentThread: GitPullRequestCommentThread

作成するスレッド。スレッドには、少なくとも 1 つのコメントが含まれている必要があります。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

プル要求のレビュー担当者に、未具体化 ID を追加します。

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

パラメーター

reviewer: IdentityRefWithVote

pull request に追加するレビュー担当者。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

pull request 添付ファイルを削除します。

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

パラメーター

fileName: string

削除する添付ファイルの名前。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deleteComment(string, number, number, number, string)

プル要求の特定のスレッドに関連付けられているコメントを削除します。

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

目的のコメントが含まれているスレッドの ID。

commentId: number

コメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE では、有効化状態と BillableCommitters データが DB から削除されます。有効化データを削除すると、影響を受けるリポジトリに対して有効データが実質的に無効になります。

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

パラメーター

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

戻り値

Promise<void>

deleteLike(string, number, number, number, string)

コメントのいいねを削除します。

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

コメントを含むスレッドの ID。

commentId: number

コメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

pull request イテレーションの状態を削除します。

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。

statusId: number

プル要求の状態の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

プル要求に割り当てられている一連のラベル (タグ) を削除します。タグ自体は削除されません。

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

labelIdOrName: string

要求されたラベルの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID またはプロジェクト名。

戻り値

Promise<void>

deletePullRequestReviewer(string, number, string, string)

pull request からレビュー担当者を削除します。

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

reviewerId: string

削除するレビュー担当者の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deletePullRequestStatus(string, number, number, string)

pull request の状態を削除します。

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

statusId: number

プル要求の状態の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deleteRefFavorite(string, number)

指定した refs favorite を削除します。

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

favoriteId: number

削除する参照のお気に入りの ID。

戻り値

Promise<void>

deleteRepository(string, string)

Git リポジトリを削除する

function deleteRepository(repositoryId: string, project?: string): Promise<void>

パラメーター

repositoryId: string

リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

論理的に削除された Git リポジトリを破棄 (ハード削除) します。

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

戻り値

Promise<void>

getAnnotatedTag(string, string, string)

注釈付きタグを取得します。

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID または名前。

objectId: string

取得するタグの ObjectId (Sha1Id)。

戻り値

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

pull request 添付ファイルのファイルコンテンツを取得します。

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

パラメーター

fileName: string

添付ファイルの名前。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ArrayBuffer>

getAttachments(string, number, string)

特定のプル要求にアタッチされているファイルの一覧を取得します。

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

pull request 添付ファイルのファイルコンテンツを取得します。

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

パラメーター

fileName: string

添付ファイルの名前。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

特定の日付の Advanced Security サービスの実際の課金対象コミッターを取得します。

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

billingDate: Date

UTC が必要です。指定しない場合、既定値は前の請求日になります。

skip: number

ページングをシミュレートするには、結果セットの X 行をスキップします。

take: number

ページングをシミュレートするために、結果セットの Y 行を返します。

戻り値

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

特定の日付の Advanced Security サービスの実際の課金対象コミッターの詳細を取得します。詳細な結果は、論理的に削除されたプロジェクトとリポジトリを意図的に除外して課金の問題を診断しません。

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

includeDetails: string

課金対象のコミッターに関するすべての詳細を返します。

billingDate: Date

UTC が必要です。指定しない場合、既定値は前の請求日になります。

戻り値

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

1 つの BLOB を取得します。

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

パラメーター

repositoryId: string

リポジトリの名前または ID。

sha1: string

ファイルの SHA1 ハッシュ。 "Git/Items/Get Item" エンドポイントを使用して、ファイルの SHA1 を取得できます。

project: string

プロジェクト ID またはプロジェクト名

download: boolean

true の場合は、ブラウザーでレンダリングするのではなく、ダウンロードを求めるメッセージを表示します。注: $formatが zip の場合、この値の既定値は true になります

fileName: string

ダウンロードに使用する fileName を指定します。

resolveLfs: boolean

true の場合は、LFS ポインターファイルの場合は、BLOB を LFS コンテンツに解決してみてください。 octet-stream Accept ヘッダーまたは $format 型とのみ互換性があります

戻り値

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

1 つの BLOB を取得します。

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

sha1: string

ファイルの SHA1 ハッシュ。 "Git/Items/Get Item" エンドポイントを使用して、ファイルの SHA1 を取得できます。

project: string

プロジェクト ID またはプロジェクト名

download: boolean

fileName: string

ダウンロードに使用する fileName を指定します。

resolveLfs: boolean

戻り値

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

zip ファイルのダウンロードで 1 つ以上の BLOB を取得します。

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

パラメーター

blobIds: string[]

zip ファイルで返される BLOB ID (SHA1 ハッシュ)。

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

filename: string

戻り値

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

1 つの BLOB を取得します。

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

sha1: string

ファイルの SHA1 ハッシュ。 "Git/Items/Get Item" エンドポイントを使用して、ファイルの SHA1 を取得できます。

project: string

プロジェクト ID またはプロジェクト名

download: boolean

fileName: string

ダウンロードに使用する fileName を指定します。

resolveLfs: boolean

戻り値

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

単一ブランチに関する統計情報を取得します。

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

パラメーター

repositoryId: string

リポジトリの名前または ID。

name: string

ブランチの名前。

project: string

プロジェクト ID またはプロジェクト名

baseVersionDescriptor: GitVersionDescriptor

ベースとして使用するコミットまたはブランチを識別します。

戻り値

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

リポジトリ内のすべてのブランチに関する統計情報を取得します。

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

baseVersionDescriptor: GitVersionDescriptor

ベースとして使用するコミットまたはブランチを識別します。

戻り値

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

複数のコミットの統計を取得する

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

パラメーター

searchCriteria: GitQueryBranchStatsCriteria

比較するベースコミットとターゲットコミットの一覧。

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

特定のコミットの変更を取得します。

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

パラメーター

commitId: string

コミットの ID。

repositoryId: string

リポジトリの ID またはフレンドリ名。フレンドリ名を使用するには、projectId も指定する必要があります。

project: string

プロジェクト ID またはプロジェクト名

top: number

返される変更の最大数。

skip: number

スキップする変更の数。

戻り値

Promise<GitCommitChanges>

getCherryPick(string, number, string)

チェリーピック ID を使用して、チェリーピック操作に関する情報を取得します。

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

cherryPickId: number

チェリーピックの ID。

repositoryId: string

リポジトリの ID。

戻り値

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

ID でチェリーピックの競合を 1 つ取得する

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

repositoryId: string

cherryPickId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

チェリーピックのすべての競合を取得する

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

パラメーター

repositoryId: string

cherryPickId: number

project: string

プロジェクト ID またはプロジェクト名

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

戻り値

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

特定のブランチのチェリーピック操作に関する情報を取得します。この操作は基になるオブジェクト構造のためにコストがかかるため、この API では最新の 1000 個のチェリーピック操作のみを確認します。

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

refName: string

チェリーピック操作に使用される GitAsyncRefOperationParameters generatedRefName。

戻り値

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

commitId を指定すると、同じチェリーピックファミリ内にあるコミットの一覧が返されます。

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

パラメーター

repositoryNameOrId: string

commitId: string

project: string

プロジェクト ID またはプロジェクト名

includeLinks: boolean

戻り値

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

プル要求の特定のスレッドに関連付けられているコメントを取得します。

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

目的のコメントが含まれているスレッドの ID。

commentId: number

コメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Comment>

getComments(string, number, number, string)

プル要求の特定のスレッドに関連付けられているすべてのコメントを取得します。

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

スレッドの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Comment[]>

getCommit(string, string, string, number)

特定のコミットを取得します。

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

パラメーター

commitId: string

コミットの ID。

repositoryId: string

リポジトリの ID またはフレンドリ名。フレンドリ名を使用するには、projectId も指定する必要があります。

project: string

プロジェクト ID またはプロジェクト名

changeCount: number

結果に含める変更の数。

戻り値

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

基本コミットとターゲットコミットの間で最も近い共通コミット (マージベース) を見つけ、基本コミットとターゲットコミット、または共通コミットとターゲットコミットの間の差分を取得します。

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

diffCommonCommit: boolean

true の場合は、共通コミットとターゲットコミットの間で相違します。 false の場合は、基本コミットとターゲットコミットの間で相違します。

top: number

返される変更の最大数。既定値は 100 です。

skip: number

スキップする変更の数

baseVersionDescriptor: GitBaseVersionDescriptor

基本コミットの記述子。

targetVersionDescriptor: GitTargetVersionDescriptor

ターゲットコミットの記述子。

戻り値

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

プロジェクトの Git コミットを取得する

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

パラメーター

repositoryId: string

リポジトリの ID またはフレンドリ名。フレンドリ名を使用するには、projectId も指定する必要があります。

searchCriteria: GitQueryCommitsCriteria

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

検索条件に一致するプロジェクトの git コミットを取得する

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

パラメーター

searchCriteria: GitQueryCommitsCriteria

検索オプション

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

skip: number

スキップするコミットの数。値は 3,000,000 を超えることはできません。

top: number

返されるコミットの最大数。値は 50,000 を超えることはできません。

includeStatuses: boolean

True を指定すると、追加のコミット状態情報が含まれます。

戻り値

Promise<GitCommitRef[]>

getDeletedRepositories(string)

削除された Git リポジトリを取得します。

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

プロジェクトのリポジトリの GET 有効化状態。

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

パラメーター

projectIds: string[]

Null の既定値はホスト内のすべてのプロジェクトで、返されるプロジェクトのリポジトリの状態の一覧

billingDate: Date

UTC が想定され、Null の既定値は UtcNow() であり、ある時点の状態に対して指定できます

skip: number

ページングをシミュレートするには、結果セットの X 行をスキップします。

take: number

ページングをシミュレートするために、結果セットの Y 行を返します。

戻り値

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

パラメーター

enableOnCreateHost: boolean

戻り値

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

パラメーター

enableOnCreateProjectId: string

戻り値

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

過去 90 日間のリポジトリの推定課金対象コミッターを取得します。

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

戻り値

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

過去 90 日間の組織の見積もり課金対象プッシャーを取得します。

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

戻り値

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

過去 90 日間のプロジェクトの見積もり課金対象プッシャーを取得します。

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

指定された各ファイルのファイルの相違を取得します

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

パラメーター

fileDiffsCriteria: FileDiffsCriteria

ファイルパラメーターオブジェクトの一覧

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの名前または ID

戻り値

Promise<FileDiff[]>

getForks(string, string, string, boolean)

コレクション内のリポジトリのすべてのフォークを取得します。

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

パラメーター

repositoryNameOrId: string

リポジトリの名前または ID。

collectionId: string

チームプロジェクトコレクション ID。

project: string

プロジェクト ID またはプロジェクト名

includeLinks: boolean

リンクを含める場合は True。

戻り値

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

特定のフォーク同期操作の詳細を取得します。

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

パラメーター

repositoryNameOrId: string

リポジトリの名前または ID。

forkSyncOperationId: number

同期要求の OperationId。

project: string

プロジェクト ID またはプロジェクト名

includeLinks: boolean

リンクを含める場合は True。

戻り値

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

このリポジトリで要求されたすべてのフォーク同期操作を取得します。

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

パラメーター

repositoryNameOrId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

includeAbandoned: boolean

破棄された要求を含める場合は True。

includeLinks: boolean

リンクを含める場合は True。

戻り値

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

1 つのアイテムのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 圧縮されたコンテンツには適用されません。これは常にダウンロードとして返されます。

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveHfs: boolean

Git HFS から実際のコンテンツを返すように Git HFS ポインターファイルを解決するには、true に設定します。既定値は true です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveHfs: boolean

Git HFS から実際のコンテンツを返すように Git HFS ポインターファイルを解決するには、true に設定します。既定値は true です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

アイテムのコレクションのアイテムメタデータやコンテンツを取得します。ダウンロードパラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。常にダウンロードとして返される zip 形式のコンテンツには適用されません。

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

includeLinks: boolean

項目へのリンクを含めるには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

zipForUnix: boolean

実行可能ファイルやシンボリックリンクなどの unix (および POSIX) システムのファイルアクセス許可を保持するには、true に設定します

戻り値

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveHfs: boolean

Git HFS から実際のコンテンツを返すように Git HFS ポインターファイルを解決するには、true に設定します。既定値は true です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveHfs: boolean

Git HFS から実際のコンテンツを返すように Git HFS ポインターファイルを解決するには、true に設定します。既定値は true です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<ArrayBuffer>

getImportRequest(string, string, number)

特定のインポート要求を取得します。

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの名前または ID。

importRequestId: number

インポート要求の一意識別子。

戻り値

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<GitItem>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveLfs: boolean

Git LFS ポインターファイルを解決して Git LFS から実際のコンテンツを返すには、true に設定します。既定値は false です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveLfs: boolean

Git LFS ポインターファイルを解決して Git LFS から実際のコンテンツを返すには、true に設定します。既定値は false です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

includeLinks: boolean

項目へのリンクを含めるには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

zipForUnix: boolean

実行可能ファイルやシンボリックリンクなどの unix (および POSIX) システムのファイルアクセス許可を保持するには、true に設定します

戻り値

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

パスまたは長いパスの一覧を指定して、リポジトリ/プロジェクト内の一連の項目からバッチを作成する処理を取得するための投稿

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

パラメーター

requestData: GitItemRequestData

要求データ属性: ItemDescriptors、IncludeContentMetadata、LatestProcessedChange、IncludeLinks。 ItemDescriptors: 取得する項目のコレクション (パス、バージョン、再帰レベルを含む)。 IncludeContentMetadata: すべてのアイテムのメタデータを含めるかどうか LatestProcessedChange: 最後に変更された各項目をコミットするために浅い ref を含めるかどうか。 IncludeLinks: 浅い参照に_links フィールドを含めるかどうか。

repositoryId: string

リポジトリの名前または ID

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveLfs: boolean

Git LFS ポインターファイルを解決して Git LFS から実際のコンテンツを返すには、true に設定します。既定値は false です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリの名前または ID。

path: string

項目のパス。

project: string

プロジェクト ID またはプロジェクト名

scopePath: string

パススコープ。既定値は null です。

recursionLevel: VersionControlRecursionType

この要求の再帰レベル。既定値は "none" で、再帰はありません。

includeContentMetadata: boolean

コンテンツメタデータを含めるには true に設定します。既定値は false です。

latestProcessedChange: boolean

最新の変更を含めるには、true に設定します。既定値は false です。

download: boolean

応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。

versionDescriptor: GitVersionDescriptor

バージョン記述子。既定値は、リポジトリの既定のブランチです。

includeContent: boolean

json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。

resolveLfs: boolean

Git LFS ポインターファイルを解決して Git LFS から実際のコンテンツを返すには、true に設定します。既定値は false です。

sanitize: boolean

svg ファイルをサニタイズして画像として返すには、true に設定します。 svg ファイルに対して要求された場合にのみ役立ちます。既定値は false です。

戻り値

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

コメントのいいねを取得します。

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

コメントを含むスレッドの ID。

commentId: number

コメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

必要に応じて、フォーク間で 2 つのコミットのマージベースを検索します。 otherRepositoryId が指定されていない場合、マージベースはローカルリポジトリのNameOrId のコンテキスト内でのみ計算されます。

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

パラメーター

repositoryNameOrId: string

ローカルリポジトリの ID または名前。

commitId: string

最初のコミット。通常は、マージの可能性があるターゲットブランチのヒントです。

otherCommitId: string

その他のコミット。通常は、マージの可能性があるソースブランチのヒントです。

project: string

プロジェクト ID またはプロジェクト名

otherCollectionId: string

otherCommitId が存在するコレクション ID。

otherRepositoryId: string

otherCommitId が存在するリポジトリ ID。

戻り値

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

特定のマージ操作の詳細を取得します。

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryNameOrId: string

リポジトリの名前または ID。

mergeOperationId: number

マージ要求の OperationId。

includeLinks: boolean

リンクを含める場合は True

戻り値

Promise<GitMerge>

getPermission(string, string, string)

セキュリティの詳細アクセス許可の状態を取得します。

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

パラメーター

projectName: string

repositoryId: string

リポジトリユーザーがアクセスしようとしている

permission: string

要求されているアクセス許可は、"viewAlert" "dismissAlert" "manage" "viewEnablement" または "repoRead" である必要があります

戻り値

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

pull request を取得します。

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

取得するプル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

maxCommentLength: number

使用されません。

skip: number

使用されません。

top: number

使用されません。

includeCommits: boolean

true の場合、関連付けられたコミットと共にプル要求が返されます。

includeWorkItemRefs: boolean

true の場合、関連付けられている作業項目参照と共にプル要求が返されます。

戻り値

Promise<GitPullRequest>

getPullRequestById(number, string)

pull request を取得します。

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

パラメーター

pullRequestId: number

取得するプル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

指定したプル要求のコミットを取得します。

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

パラメーター

repositoryId: string

リポジトリの ID または名前。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

ID でプル要求の競合を 1 つ取得する

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

repositoryId: string

pullRequestId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

プル要求のすべての競合を取得する

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

パラメーター

repositoryId: string

プル要求のリポジトリ。

pullRequestId: number

pull request ID。

project: string

プロジェクト ID またはプロジェクト名

skip: number

スキップする競合。

top: number

スキップ後に返される競合。

includeObsolete: boolean

古い競合が含まれます。

excludeResolved: boolean

既に解決されている競合を除外します。

onlyResolved: boolean

解決された競合のみを返します。

戻り値

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

プル要求の指定されたイテレーションを取得します。

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

パラメーター

repositoryId: string

リポジトリの ID または名前。

pullRequestId: number

プル要求の ID。

iterationId: number

返される pull request イテレーションの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

2 つのイテレーションの間にプル要求で行われた変更を取得します。

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。 <br/> Iteration 1 はプル要求が作成されたときのソースブランチのヘッドであり、ソースブランチへのプッシュがある場合は後続のイテレーションが作成されます。使用できる値は、1 からこのプル要求の最大イテレーションまでの範囲です。

project: string

プロジェクト ID またはプロジェクト名

top: number

随意。取得する変更の数。既定値は 100、最大値は 2000 です。

skip: number

随意。無視する変更の数。たとえば、変更 101 から 150 を取得するには、上位 50 に設定し、100 にスキップします。

compareTo: number

比較対象のプル要求イテレーションの ID。既定値は 0 で、ソースブランチとターゲットブランチ間の共通コミットとの比較が行われていることを示します。

戻り値

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

プル要求の指定されたイテレーションのコミットを取得します。

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

パラメーター

repositoryId: string

リポジトリの ID または名前。

pullRequestId: number

プル要求の ID。

iterationId: number

コミットの取得元となるイテレーションの ID。

project: string

プロジェクト ID またはプロジェクト名

top: number

返されるコミットの最大数。バッチごとに返すことができるコミットの最大数は 500 です。

skip: number

スキップするコミットの数。

戻り値

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

指定したプル要求のイテレーションの一覧を取得します。

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

パラメーター

repositoryId: string

リポジトリの ID または名前。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

includeCommits: boolean

true の場合は、各イテレーションに関連付けられているコミットを応答に含めます。

戻り値

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

特定の pull request イテレーションの状態を ID で取得します。状態 ID は、すべてのイテレーションにわたって pull request 内で一意です。

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。

statusId: number

プル要求の状態の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

プル要求のイテレーションに関連付けられているすべての状態を取得します。

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

プル要求に割り当てられている 1 つのラベル (タグ) を取得します。

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

labelIdOrName: string

要求されたラベルの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID またはプロジェクト名。

戻り値

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

プル要求に割り当てられているすべてのラベル (タグ) を取得します。

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID またはプロジェクト名。

戻り値

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

pull request の外部プロパティを取得します。

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

この API は、特定のコミットに関連するプル要求を見つけるために使用されます。これを使用して、特定のマージコミットを作成した pull request を見つけるか、特定のコミットをマージしたすべてのプル要求を検索するために使用できます。入力は、それぞれがコミットのリストを含むクエリのリストです。検索対象のコミットごとに、コミットのディクショナリ (pull request を>) が返されます。

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

パラメーター

queries: GitPullRequestQuery

実行するクエリの一覧。

repositoryId: string

リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

プル要求の特定のレビュー担当者に関する情報を取得する

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

reviewerId: string

レビュー担当者の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

pull request のレビュー担当者を取得する

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

指定した条件に一致するすべてのプル要求を取得します。

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

searchCriteria: GitPullRequestSearchCriteria

この検索条件に一致するプル要求が返されます。

project: string

プロジェクト ID またはプロジェクト名

maxCommentLength: number

使用されません。

skip: number

無視するプル要求の数。たとえば、結果 101 から 150 を取得するには、top を 50 に設定し、100 にスキップします。

top: number

取得するプル要求の数。

戻り値

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

指定した条件に一致するすべてのプル要求を取得します。

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

searchCriteria: GitPullRequestSearchCriteria

この検索条件に一致するプル要求が返されます。

maxCommentLength: number

使用されません。

skip: number

無視するプル要求の数。たとえば、結果 101 から 150 を取得するには、top を 50 に設定し、100 にスキップします。

top: number

取得するプル要求の数。

戻り値

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

ID で特定のプル要求の状態を取得します。状態 ID は、すべてのイテレーションにわたって pull request 内で一意です。

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

statusId: number

プル要求の状態の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

プル要求に関連付けられているすべての状態を取得します。

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

プル要求でスレッドを取得します。

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

スレッドの ID。

project: string

プロジェクト ID またはプロジェクト名

iteration: number

指定した場合、スレッドの位置は、差分の右側としてこのイテレーションを使用して追跡されます。

baseIteration: number

指定した場合、スレッドの位置は、このイテレーションを差分の左側として使用して追跡されます。

戻り値

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

プル要求に関連付けられている作業項目の一覧を取得します。

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

パラメーター

repositoryId: string

リポジトリの ID または名前。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

特定のプッシュを取得します。

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

パラメーター

repositoryId: string

リポジトリの名前または ID。

pushId: number

プッシュの ID。

project: string

プロジェクト ID またはプロジェクト名

includeCommits: number

結果に含めるコミットの数。

includeRefUpdates: boolean

true の場合は、プッシュによって更新された ref の一覧を含めます。

戻り値

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

特定のプッシュに関連付けられているコミットの一覧を取得します。

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

パラメーター

repositoryId: string

リポジトリの ID またはフレンドリ名。フレンドリ名を使用するには、projectId も指定する必要があります。

pushId: number

プッシュの ID。

project: string

プロジェクト ID またはプロジェクト名

top: number

返されるコミットの最大数 ("上位 x コミットの取得")。

skip: number

スキップするコミットの数。

includeLinks: boolean

リソースの REST URL リンクを含めないようにするには、false に設定します。既定値は true です。

戻り値

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

指定したリポジトリに関連付けられているプッシュを取得します。

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

skip: number

スキップするプッシュの数。

top: number

返されるプッシュの数。

searchCriteria: GitPushSearchCriteria

検索条件属性: fromDate、toDate、pusherId、refName、includeRefUpdates、または includeLinks。 fromDate: 検索の開始日。 toDate: 検索対象の終了日。pusherId: プッシュを送信したユーザーの ID。 refName: 考慮するブランチ名。 includeRefUpdates: true の場合は、プッシュによって更新された ref の一覧を含めます。 includeLinks: 浅い参照に_links フィールドを含めるかどうか。

戻り値

Promise<GitPush[]>

getRecycleBinRepositories(string)

ごみ箱から論理的に削除された Git リポジトリを取得します。

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

お気に入りの ID の refs favorite を取得します。

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

favoriteId: number

要求された ref favorite の ID。

戻り値

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

リポジトリと ID の refs のお気に入りを取得します。

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

identityId: string

お気に入りを取得する ID の ID。 null の場合は、要求する ID が使用されます。

戻り値

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

identityId: string

戻り値

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)

指定されたリポジトリの ref を照会し、それらを返します。

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<PagedList<GitRef>>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

filter: string

[省略可能]refs に適用するフィルター (で始まる)。

includeLinks: boolean

[省略可能]referenceLinks を結果に含めるかどうかを指定します。既定値は false です。

includeStatuses: boolean

[省略可能]各 ref の最初の 1,000 個までのコミット状態が含まれます。既定値は false です。

includeMyBranches: boolean

[省略可能]ユーザーが所有するブランチ、ユーザーのお気に入りのブランチ、既定のブランチのみが含まれます。既定値は false です。フィルターパラメーターと組み合わせることはできません。

latestStatusesOnly: boolean

[省略可能]True を指定すると、各 ref のチップコミット状態のみが含まれます。このオプションでは、includeStatuses を true にする必要があります。既定値は false です。

peelTags: boolean

[省略可能]注釈付きタグによって、PeeledObjectId プロパティが設定されます。既定値は false です。

filterContains: string

[省略可能]refs (contains) に適用するフィルター。

戻り値

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Git リポジトリを取得します。

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

includeLinks: boolean

[省略可能]参照リンクを含める場合は True。既定値は false です。

includeAllUrls: boolean

[省略可能]True を指定すると、すべてのリモート URL が含まれます。既定値は false です。

includeHidden: boolean

[省略可能]True を指定すると、非表示のリポジトリが含まれます。既定値は false です。

戻り値

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

名前と改ページによってフィルター処理された Git リポジトリを取得します。

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

パラメーター

projectId: string

チームプロジェクトの ID または名前。

includeLinks: boolean

[省略可能]参照リンクを含める場合は True。既定値は false です。

includeAllUrls: boolean

[省略可能]True を指定すると、すべてのリモート URL が含まれます。既定値は false です。

includeHidden: boolean

[省略可能]True を指定すると、非表示のリポジトリが含まれます。既定値は false です。

filterContains: string

[省略可能]refs (contains) に適用するフィルター。

top: number

[省略可能]返されるリポジトリの最大数。 500 より大きくすることはできません。指定されていないが continuationToken が指定されている場合、top は既定で 100 になります。

continuationToken: string

改ページ位置の変更に使用される継続トークン。

戻り値

Promise<PagedList<GitRepository>>

getRepository(string, string)

Git リポジトリを取得します。

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

パラメーター

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Git リポジトリを取得します。

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

パラメーター

repositoryId: string

リポジトリの名前または ID。

includeParent: boolean

親リポジトリを含める場合は True。認証された呼び出しでのみ使用できます。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitRepository>

getRevert(string, number, string)

元に戻す操作に関する情報を、元に戻す ID で取得します。

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

revertId: number

元に戻す操作の ID。

repositoryId: string

リポジトリの ID。

戻り値

Promise<GitRevert>

getRevertConflict(string, number, number, string)

ID で元に戻す 1 つの競合を取得する

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

repositoryId: string

revertId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

元に戻すすべての競合を取得する

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

パラメーター

repositoryId: string

revertId: number

project: string

プロジェクト ID またはプロジェクト名

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

戻り値

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

特定のブランチの元に戻す操作に関する情報を取得します。

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

refName: string

元に戻す操作に使用される GitAsyncRefOperationParameters generatedRefName。

戻り値

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

Git コミットに関連付けられている状態を取得します。

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

パラメーター

commitId: string

Git コミットの ID。

repositoryId: string

リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

top: number

随意。取得する状態の数。既定値は 1000 です。

skip: number

随意。無視する状態の数。既定値は 0 です。たとえば、結果 101 から 150 を取得するには、top を 50 に設定し、100 にスキップします。

latestOnly: boolean

フラグは、Context.Name と Context.Genreでグループ化された最新の状態のみを取得するかどうかを示します。

戻り値

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

特定のリポジトリまたはチームプロジェクトの pull request 候補を取得します。

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

パラメーター

repositoryId: string

Git リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

preferCompareBranch: boolean

true の場合は、プル要求のターゲットブランチとして、既定のブランチよりも比較ブランチを優先します。

戻り値

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

プル要求内のすべてのスレッドを取得します。

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

パラメーター

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

iteration: number

指定した場合、スレッドの位置は、このイテレーションを差分の右側として使用して追跡されます。

baseIteration: number

指定した場合、スレッドの位置は、このイテレーションを差分の左側として使用して追跡されます。

戻り値

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

Tree エンドポイントは、指定したツリーの下にあるオブジェクトのコレクションを返します。ツリーは Git リポジトリ内のフォルダーです。

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

パラメーター

repositoryId: string

リポジトリ ID。

sha1: string

ツリーオブジェクトの SHA1 ハッシュ。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID。

recursive: boolean

再帰的に検索します。このツリーの下にツリーを含めます。既定値は false です。

fileName: string

.zip ファイルが返される場合に使用する名前。既定値はオブジェクト ID です。

戻り値

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

Tree エンドポイントは、指定したツリーの下にあるオブジェクトのコレクションを返します。ツリーは Git リポジトリ内のフォルダーです。

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

パラメーター

repositoryId: string

リポジトリ ID。

sha1: string

ツリーオブジェクトの SHA1 ハッシュ。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

プロジェクト ID。

recursive: boolean

再帰的に検索します。このツリーの下にツリーを含めます。既定値は false です。

fileName: string

.zip ファイルが返される場合に使用する名前。既定値はオブジェクト ID です。

戻り値

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

リポジトリのインポート要求を取得します。

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの名前または ID。

includeAbandoned: boolean

True を指定すると、破棄されたインポート要求が結果に含まれます。

戻り値

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

論理的に削除された Git リポジトリを回復します。最近削除されたリポジトリは、ハード削除されて回復不能になる前に、一定期間論理的な削除状態になります。

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

パラメーター

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの ID。

戻り値

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

パラメーター

enableOnCreateHost: boolean

戻り値

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

パラメーター

enableOnCreateProjectId: string

enableOnStatus: boolean

戻り値

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

特定のプル要求に関する電子メール通知を一連の受信者に送信する

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

パラメーター

userMessage: ShareNotificationContext

repositoryId: string

Git リポジトリの ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

マージ競合の解決を更新する

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

複数のマージ競合の解決を更新する

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

パラメーター

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

プル要求の特定のスレッドに関連付けられているコメントを更新します。

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

パラメーター

comment: Comment

更新する必要があるコメントコンテンツ。コメントは最大 150,000 文字です。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

目的のコメントが含まれているスレッドの ID。

commentId: number

更新するコメントの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

リポジトリの POST 有効化の状態。

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

パラメーター

enablementUpdates: AdvSecEnablementUpdate[]

戻り値

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

失敗したインポート要求を再試行するか破棄します。

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

パラメーター

importRequestToUpdate: GitImportRequest

インポート要求の更新バージョン。現時点で許可されている唯一の変更は、[状態] を [キュー] または [破棄済み] に設定することです。

project: string

プロジェクト ID またはプロジェクト名

repositoryId: string

リポジトリの名前または ID。

importRequestId: number

更新するインポート要求の一意識別子。

戻り値

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

pull request を更新する

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

パラメーター

gitPullRequestToUpdate: GitPullRequest

更新する必要がある pull request コンテンツ。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

更新するプル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

マージ競合の解決を更新する

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

複数のマージ競合の解決を更新する

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

パラメーター

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

pull request iteration statuses コレクションを更新します。サポートされている操作の種類は removeのみです。

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

パラメーター

patchDocument: JsonPatchDocument

JSON パッチ形式でプル要求の状態に適用する操作。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

iterationId: number

プル要求イテレーションの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

pull request 外部プロパティを作成または更新します。パッチ操作は、add、replace、または removeできます。 add 操作の場合、パスは空にすることができます。パスが空の場合、値はキーと値のペアのリストである必要があります。 replace 操作の場合、パスを空にすることはできません。パスが存在しない場合は、プロパティがコレクションに追加されます。 remove 操作の場合、パスを空にすることはできません。パスが存在しない場合、アクションは実行されません。

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

パラメーター

patchDocument: JsonPatchDocument

JSON パッチ形式で追加、置換、または削除するプロパティ。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

校閲者のエントリを編集します。これらのフィールドは修正可能です:isFlagged、hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

パラメーター

reviewer: IdentityRefWithVote

校閲者データ。<br/>校閲者の ID がここに含まれている場合は、reviewerID パラメーターと一致する必要があります。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

reviewerId: string

レビュー担当者の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

プル要求で複数のレビュー担当者の投票をリセットします。注: このエンドポイントは投票の更新のみをサポートしますが、必要なレビュー担当者の更新 (ポリシーの使用) や表示名はサポートしていません。

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

パラメーター

patchVotes: IdentityRefWithVote[]

投票がゼロにリセットされるレビュー担当者の ID

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

pull request の ID

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

pull request statuses コレクションを更新します。サポートされている操作の種類は removeのみです。

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

パラメーター

patchDocument: JsonPatchDocument

JSON パッチ形式でプル要求の状態に適用する操作。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

ブランチをロックまたはロック解除します。

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

パラメーター

newRefInfo: GitRefUpdate

実行する ref 更新アクション (ロック/ロック解除)

repositoryId: string

リポジトリの名前または ID。

filter: string

ロック/ロック解除するブランチの名前

project: string

プロジェクト ID またはプロジェクト名

projectId: string

チームプロジェクトの ID または名前。リポジトリの ID を指定する場合は省略可能です。

戻り値

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

refs(branchs) の作成、更新、または削除。

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

パラメーター

refUpdates: GitRefUpdate[]

実行を試みる ref 更新プログラムの一覧

repositoryId: string

リポジトリの名前または ID。

project: string

プロジェクト ID またはプロジェクト名

projectId: string

チームプロジェクトの ID または名前。リポジトリの ID を指定する場合は省略可能です。

戻り値

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Git リポジトリを新しいリポジトリ名または新しい既定のブランチで更新します。

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

パラメーター

newRepositoryInfo: GitRepository

リポジトリの新しいリポジトリ名または新しい既定のブランチを指定する

repositoryId: string

リポジトリの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

マージ競合の解決を更新する

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

パラメーター

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

複数のマージ競合の解決を更新する

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

パラメーター

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

プル要求のスレッドを更新します。

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

パラメーター

commentThread: GitPullRequestCommentThread

更新する必要があるスレッドコンテンツ。

repositoryId: string

プル要求のターゲットブランチのリポジトリ ID。

pullRequestId: number

プル要求の ID。

threadId: number

更新するスレッドの ID。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<GitPullRequestCommentThread>

次の方法で共有

GitRestClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

GitRestClient(IVssRestClientOptions)

パラメーター

プロパティの詳細

RESOURCE_AREA_ID

プロパティ値

メソッドの詳細

createAnnotatedTag(GitAnnotatedTag, string, string)

パラメーター

戻り値

createAttachment(any, string, string, number, string)

パラメーター

戻り値

createCherryPick(GitAsyncRefOperationParameters, string, string)

パラメーター

戻り値

createComment(Comment, string, number, number, string)

パラメーター

戻り値

createCommitStatus(GitStatus, string, string, string)

パラメーター

戻り値

createFavorite(GitRefFavorite, string)

パラメーター

戻り値

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

パラメーター

戻り値

createImportRequest(GitImportRequest, string, string)

パラメーター

戻り値

createLike(string, number, number, number, string)

パラメーター

戻り値

createMergeRequest(GitMergeParameters, string, string, boolean)

パラメーター

戻り値

createPullRequest(GitPullRequest, string, string, boolean)

パラメーター

戻り値

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

パラメーター

戻り値

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

パラメーター

戻り値

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

パラメーター

戻り値

createPullRequestReviewers(IdentityRef[], string, number, string)

パラメーター

戻り値

createPullRequestStatus(GitPullRequestStatus, string, number, string)

パラメーター

戻り値

createPush(GitPush, string, string)

パラメーター

戻り値

createRepository(GitRepositoryCreateOptions, string, string)

パラメーター

戻り値

createRevert(GitAsyncRefOperationParameters, string, string)

パラメーター

戻り値

createThread(GitPullRequestCommentThread, string, number, string)

パラメーター

戻り値

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

パラメーター

戻り値

deleteAttachment(string, string, number, string)

パラメーター

戻り値

deleteComment(string, number, number, number, string)

パラメーター