Repositories - List

参考

Service:: Git

API Version:: 7.1-preview.1

检索 git 存储库。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
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。

响应

名称	类型	说明
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

名称	说明
vso.code	授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。此外，还允许通过服务挂钩搜索代码并获取有关版本控制事件的通知。

示例

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

定义

名称	说明
GitRepository
GitRepositoryRef
ProjectState	项目状态。
ProjectVisibility	项目可见性。
ReferenceLinks	表示 REST 引用链接集合的类。
TeamProjectCollectionReference	TeamProjectCollection 的引用对象。
TeamProjectReference	表示对 TeamProject 的浅表引用。

GitRepository

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
defaultBranch	string
id	string
isDisabled	boolean	如果存储库处于禁用状态，则为 True。否则为 False。
isFork	boolean	如此如果存储库创建为分支。
isInMaintenance	boolean	如果存储库处于维护状态，则为 True。否则为 False。
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	表示对 TeamProject 的浅表引用。
remoteUrl	string
size	integer	存储库) (字节的压缩大小。
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

名称	类型	说明
collection	TeamProjectCollectionReference	此分支所在的团队项目集合
id	string
isFork	boolean	如此如果存储库是作为分支创建的
name	string
project	TeamProjectReference	表示对 TeamProject 的浅表引用。
remoteUrl	string
sshUrl	string
url	string

ProjectState

项目状态。

名称	类型	说明
all	string	除“已删除”之外的所有项目，而不考虑状态。
createPending	string	项目已排队等待创建，但该过程尚未启动。
deleted	string	已删除项目。
deleting	string	正在删除项目。
new	string	项目正在创建中。
unchanged	string	项目尚未更改。
wellFormed	string	项目已完全创建并可供使用。

ProjectVisibility

项目可见性。

名称	类型	说明
private	string	项目仅对具有显式访问权限的用户可见。
public	string	该项目对所有人都可见。

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

TeamProjectCollectionReference

TeamProjectCollection 的引用对象。

名称	类型	说明
avatarUrl	string	集合头像 URL。
id	string	集合 ID。
name	string	集合名称。
url	string	集合 REST URL。

TeamProjectReference

表示对 TeamProject 的浅表引用。

名称	类型	说明
abbreviation	string	项目缩写。
defaultTeamImageUrl	string	默认团队标识图像的 URL。
description	string	如果有任何) ，则 (项目的说明。
id	string	项目标识符。
lastUpdateTime	string	项目上次更新时间。
name	string	项目名称。
revision	integer	项目修订。
state	ProjectState	项目状态。
url	string	对象完整版本的 URL。
visibility	ProjectVisibility	项目可见性。

通过