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

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Имя организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
includeAllUrls	query		boolean	[необязательно] Значение true, чтобы включить все удаленные URL-адреса. Значение по умолчанию — false.
includeHidden	query		boolean	[необязательно] Значение true для включения скрытых репозиториев. Значение по умолчанию — false.
includeLinks	query		boolean	[необязательно] Значение true для включения ссылочных ссылок. Значение по умолчанию — false.

Ответы

Имя	Тип	Описание
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

Области

Имя	Описание
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"
    }
  ]
}

Определения

Имя	Описание
GitRepository
GitRepositoryRef
ProjectState	Состояние проекта.
ProjectVisibility	Видимость проекта.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
TeamProjectCollectionReference	Ссылочный объект для TeamProjectCollection.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.

GitRepository

Object

Имя	Тип	Описание
_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

Имя	Тип	Описание
collection	TeamProjectCollectionReference	Коллекция командных проектов, в которой находится этот вил
id	string (uuid)
isFork	boolean	Значение true, если репозиторий был создан в качестве вилки
name	string
project	TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
remoteUrl	string
sshUrl	string
url	string

ProjectState

Перечисление

Состояние проекта.

Значение	Описание
all	Все проекты независимо от состояния, кроме deleted.
createPending	Проект был поставлен в очередь для создания, но процесс еще не запущен.
deleted	Проект удален.
deleting	Проект находится в процессе удаления.
new	Проект находится в процессе создания.
unchanged	Проект не был изменен.
wellFormed	Проект полностью создан и готов к использованию.

ProjectVisibility

Перечисление

Видимость проекта.

Значение	Описание
private	Проект отображается только пользователям с явным доступом.
public	Проект виден всем.

ReferenceLinks

Object

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

TeamProjectCollectionReference

Object

Ссылочный объект для TeamProjectCollection.

Имя	Тип	Описание
avatarUrl	string	URL-адрес аватара коллекции.
id	string (uuid)	Идентификатор коллекции.
name	string	Имя коллекции.
url	string	URL-адрес REST коллекции.

TeamProjectReference

Object

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
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	Видимость проекта.