Git - Get Connection

Служба:

Core

Версия API:

v1

Возвращает сведения о подключении Git для указанной рабочей области.

Разрешения

Вызывающий объект должен иметь роль участника или более поздней рабочей области.

Обязательные делегированные области

Workspace.Read.All или Workspace.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
учетные записи службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Ответы

Имя	Тип	Описание
200 OK	GitConnection	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка. НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений рабочей области.

Примеры

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Пример ответа

Код состояния:

200

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Пример ответа

Код состояния:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Определения

Имя	Описание
AzureDevOpsDetails	Сведения о поставщике Azure DevOps.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GitConnection	Содержит сведения о подключении Git.
GitConnectionState	Состояние подключения Git. С течением времени могут добавляться дополнительные типы состояний подключения.
GitHubDetails	Сведения о поставщике GitHub.
GitProviderType	Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.
GitSyncDetails	Содержит сведения о синхронизации.

AzureDevOpsDetails

Object

Сведения о поставщике Azure DevOps.

Имя	Тип	Описание
branchName	string maxLength: 250	Имя ветви. Максимальная длина составляет 250 символов.
directoryName	string maxLength: 256	Относительный путь к каталогу. Максимальная длина составляет 256 символов.
gitProviderType	string: AzureDevOps	Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.
organizationName	string maxLength: 100	Имя организации. Максимальная длина — 100 символов.
projectName	string maxLength: 100	Имя проекта. Максимальная длина — 100 символов.
repositoryName	string maxLength: 128	Имя репозитория. Максимальная длина — 128 символов.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GitConnection

Object

Содержит сведения о подключении Git.

Имя	Тип	Описание
gitConnectionState	GitConnectionState	Состояние подключения Git. С течением времени могут добавляться дополнительные типы состояний подключения.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Сведения о поставщике Git.
gitSyncDetails	GitSyncDetails	Содержит сведения о синхронизации.

GitConnectionState

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

Состояние подключения Git. С течением времени могут добавляться дополнительные типы состояний подключения.

Значение	Описание
NotConnected	Состояние не подключено.
Connected	Подключенное состояние.
ConnectedAndInitialized	Подключенное и инициализированное состояние.

GitHubDetails

Object

Сведения о поставщике GitHub.

Имя	Тип	Описание
branchName	string maxLength: 250	Имя ветви. Максимальная длина составляет 250 символов.
directoryName	string maxLength: 256	Относительный путь к каталогу. Максимальная длина составляет 256 символов.
gitProviderType	string: GitHub	Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.
ownerName	string maxLength: 100	Имя владельца. Максимальная длина — 100 символов.
repositoryName	string maxLength: 128	Имя репозитория. Максимальная длина — 128 символов.

GitProviderType

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

Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.

Значение	Описание
AzureDevOps	Поставщик Azure DevOps
GitHub	Поставщик GitHub

GitSyncDetails

Object

Содержит сведения о синхронизации.

Имя	Тип	Описание
head	string	Полный безопасный хэш-алгоритм 1 (SHA-1) синхронизированного идентификатора фиксации.
lastSyncTime	string (date-time)	Дата и время последнего состояния синхронизации.