Repositories - List

Referência

Service:: Git

API Version:: 7.1-preview.1

Recuperar repositórios 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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da API.
includeAllUrls	query		boolean	[opcional] True para incluir todas as URLs remotas. O valor padrão é false.
includeHidden	query		boolean	[opcional] True para incluir repositórios ocultos. O valor padrão é false.
includeLinks	query		boolean	[opcional] True para incluir links de referência. O valor padrão é false.

Respostas

Nome	Tipo	Description
200 OK	GitRepository[]	operação bem-sucedida

Segurança

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

Nome	Description
vso.code	Concede a capacidade de ler o código-fonte e os metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

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"
    }
  ]
}

Definições

Nome	Description
GitRepository
GitRepositoryRef
ProjectState	Estado do projeto.
ProjectVisibility	Visibilidade do projeto.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TeamProjectCollectionReference	Objeto de referência para um TeamProjectCollection.
TeamProjectReference	Representa uma referência superficial a um TeamProject.

GitRepository

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
defaultBranch	string
id	string
isDisabled	boolean	True se o repositório estiver desabilitado. De outra forma, falso.
isFork	boolean	True se o repositório foi criado como um fork.
isInMaintenance	boolean	True se o repositório estiver em manutenção. De outra forma, falso.
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Representa uma referência superficial a um TeamProject.
remoteUrl	string
size	integer	Tamanho compactado (bytes) do repositório.
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Nome	Tipo	Description
collection	TeamProjectCollectionReference	Coleção de Projetos de Equipe em que esse Fork reside
id	string
isFork	boolean	True se o repositório foi criado como um fork
name	string
project	TeamProjectReference	Representa uma referência superficial a um TeamProject.
remoteUrl	string
sshUrl	string
url	string

ProjectState

Estado do projeto.

Nome	Tipo	Description
all	string	Todos os projetos, independentemente do estado, exceto Excluídos.
createPending	string	O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.
deleted	string	O projeto foi excluído.
deleting	string	O Project está em processo de exclusão.
new	string	O projeto está em processo de criação.
unchanged	string	O projeto não foi alterado.
wellFormed	string	O project é completamente criado e pronto para uso.

ProjectVisibility

Visibilidade do projeto.

Nome	Tipo	Description
private	string	O projeto só é visível para usuários com acesso explícito.
public	string	O projeto é visível para todos.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

TeamProjectCollectionReference

Objeto de referência para um TeamProjectCollection.

Nome	Tipo	Description
avatarUrl	string	URL do avatar da coleção.
id	string	ID da coleção.
name	string	Nome da Coleção.
url	string	URL REST da coleção.

TeamProjectReference

Representa uma referência superficial a um TeamProject.

Nome	Tipo	Description
abbreviation	string	Abreviação do projeto.
defaultTeamImageUrl	string	Url para a imagem de identidade de equipe padrão.
description	string	A descrição do projeto (se houver).
id	string	Identificador do projeto.
lastUpdateTime	string	Hora da última atualização do projeto.
name	string	Nome do projeto.
revision	integer	Revisão do projeto.
state	ProjectState	Estado do projeto.
url	string	URL para a versão completa do objeto.
visibility	ProjectVisibility	Visibilidade do projeto.

Partilhar via