Repositories - List

服務:

Git

API 版本:

7.1

擷取 Git 存放庫。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories?api-version=7.1

含選擇性參數:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories?includeLinks={includeLinks}&includeAllUrls={includeAllUrls}&includeHidden={includeHidden}&api-version=7.1

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 『7.1』 以使用此版本的 API。
includeAllUrls	query		boolean	[選擇性]True 是表示 包含所有遠端 URL。 默認值為 false。
includeHidden	query		boolean	[選擇性]True 是表示 包含隱藏的存放庫。 默認值為 false。
includeLinks	query		boolean	[選擇性]True 是表示 包含參考連結。 默認值為 false。

回應

名稱	類型	Description
200 OK	GitRepository[]	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

範圍

名稱	Description
vso.code	授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和元數據的能力。 也授與搜尋程式代碼的能力，並透過服務攔截取得版本控制事件的通知。

範例

範例要求

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories?api-version=7.1

範例回覆

狀態碼:

200

{
  "count": 3,
  "value": [
    {
      "id": "5febef5a-833d-4e14-b9c0-14cb638f91e6",
      "name": "AnotherRepository",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6",
      "project": {
        "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
        "name": "Fabrikam-Fiber-Git",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
        "state": "wellFormed"
      },
      "remoteUrl": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/AnotherRepository"
    },
    {
      "id": "278d5cd2-584d-4b63-824a-2ba458937249",
      "name": "Fabrikam-Fiber-Git",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249",
      "project": {
        "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
        "name": "Fabrikam-Fiber-Git",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
        "state": "wellFormed"
      },
      "defaultBranch": "refs/heads/master",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git"
    },
    {
      "id": "66efb083-777a-4cac-a350-a24b046be6be",
      "name": "TestGit",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/66efb083-777a-4cac-a350-a24b046be6be",
      "project": {
        "id": "281f9a5b-af0d-49b4-a1df-fe6f5e5f84d0",
        "name": "TestGit",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/281f9a5b-af0d-49b4-a1df-fe6f5e5f84d0",
        "state": "wellFormed"
      },
      "defaultBranch": "refs/heads/master",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/TestGit"
    }
  ]
}

定義

名稱	Description
GitRepository
GitRepositoryRef
ProjectState	項目狀態。
ProjectVisibility	項目可見度。
ReferenceLinks	表示 REST 參考連結集合的類別。
TeamProjectCollectionReference	TeamProjectCollection 的參考物件。
TeamProjectReference	表示 TeamProject 的淺層參考。

GitRepository

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
defaultBranch	string
id	string (uuid)
isDisabled	boolean	如果停用存放庫，則為 True。 否則為 False。
isFork	boolean	True 是表示 如果存放庫建立為分叉。
isInMaintenance	boolean	如果存放庫處於維護中，則為 True。 否則為 False。
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
size	integer (int64)	存放庫的壓縮大小 （位元元組） 。
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Object

名稱	類型	Description
collection	TeamProjectCollectionReference	此分支所在的Team專案集合
id	string (uuid)
isFork	boolean	True 是表示 如果存放庫建立為分叉
name	string
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
sshUrl	string
url	string

ProjectState

列舉型別

項目狀態。

值	Description
all	所有專案，不論狀態為何，但已刪除除外。
createPending	Project 已排入佇列以建立，但程式尚未啟動。
deleted	項目已刪除。
deleting	Project 正在刪除。
new	Project 正在建立中。
unchanged	專案尚未變更。
wellFormed	專案已完全建立並可供使用。

ProjectVisibility

列舉型別

項目可見度。

值	Description
private	只有具有明確存取權的使用者才能看到專案。
public	所有專案都可以看到。

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。

TeamProjectCollectionReference

Object

TeamProjectCollection 的參考物件。

名稱	類型	Description
avatarUrl	string	集合虛擬人偶 URL。
id	string (uuid)	集合標識碼。
name	string	集合名稱。
url	string	集合 REST URL。

TeamProjectReference

Object

表示 TeamProject 的淺層參考。

名稱	類型	Description
abbreviation	string	項目縮寫。
defaultTeamImageUrl	string	默認小組身分識別影像的 URL。
description	string	專案的描述（如果有的話）。
id	string (uuid)	項目標識碼。
lastUpdateTime	string (date-time)	專案上次更新時間。
name	string	專案名稱。
revision	integer (int64)	專案修訂。
state	ProjectState	項目狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	項目可見度。