共用方式為


Repositories - List

擷取 Git 存放庫。

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

URI 參數

名稱 位於 必要 類型 Description
organization
path True

string

Azure DevOps 組織的名稱。

project
path

string

專案識別碼或專案名稱

api-version
query True

string

要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。

includeAllUrls
query

boolean

[選擇性]True 是表示 包含所有遠端 URL。 預設值為 false。

includeHidden
query

boolean

[選擇性]True 是表示 包含隱藏的存放庫。 預設值為 false。

includeLinks
query

boolean

[選擇性]True 是表示 包含參考連結。 預設值為 false。

回應

名稱 類型 Description
200 OK

GitRepository[]

成功作業

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

名稱 Description
vso.code 授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力,並透過服務勾點取得版本控制事件的通知。

範例

Sample Request

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

Sample Response

{
  "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

名稱 類型 Description
_links

ReferenceLinks

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

defaultBranch

string

id

string

isDisabled

boolean

如果存放庫已停用,則為 True。 否則為 false。

isFork

boolean

True 是表示 如果存放庫建立為分叉。

isInMaintenance

boolean

如果存放庫處於維護中,則為 True。 否則為 false。

name

string

parentRepository

GitRepositoryRef

project

TeamProjectReference

表示 TeamProject 的淺層參考。

remoteUrl

string

size

integer

存放庫的壓縮大小 (位元組) 。

sshUrl

string

url

string

validRemoteUrls

string[]

webUrl

string

GitRepositoryRef

名稱 類型 Description
collection

TeamProjectCollectionReference

此分支所在的 Team 專案集合

id

string

isFork

boolean

True 是表示 如果存放庫已建立為分叉

name

string

project

TeamProjectReference

表示 TeamProject 的淺層參考。

remoteUrl

string

sshUrl

string

url

string

ProjectState

專案狀態。

名稱 類型 Description
all

string

所有專案,不論刪除以外的狀態為何。

createPending

string

專案已排入佇列以建立,但程式尚未啟動。

deleted

string

專案已刪除。

deleting

string

Project 正在刪除。

new

string

Project 正在建立中。

unchanged

string

專案尚未變更。

wellFormed

string

Project 已完全建立並可供使用。

ProjectVisibility

專案可見度。

名稱 類型 Description
private

string

只有具有明確存取權的使用者才能看到專案。

public

string

專案對全部可見。

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

名稱 類型 Description
links

object

連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。

TeamProjectCollectionReference

TeamProjectCollection 的參考物件。

名稱 類型 Description
avatarUrl

string

集合虛擬人偶 URL。

id

string

集合識別碼。

name

string

集合名稱。

url

string

集合 REST URL。

TeamProjectReference

表示 TeamProject 的淺層參考。

名稱 類型 Description
abbreviation

string

專案縮寫。

defaultTeamImageUrl

string

預設小組身分識別影像的 URL。

description

string

如果有任何) ,專案的描述 (。

id

string

專案識別碼。

lastUpdateTime

string

專案上次更新時間。

name

string

專案名稱。

revision

integer

專案修訂。

state

ProjectState

專案狀態。

url

string

物件完整版本的 URL。

visibility

ProjectVisibility

專案可見度。