Git - Initialize Connection

Служба:

Core

Версия API:

v1

Инициализация подключения для рабочей области, подключенной к Git.
Этот API поддерживает длительные операции (LRO).

Чтобы использовать этот API, учетные данные вызывающего объекта должны быть настроены с помощью API обновления учетных данных Git . Вы можете использовать API получения учетных данных Git для проверки конфигурации учетных данных Git.

Этот API должен вызываться после успешного вызова API Connect . Чтобы завершить полную синхронизацию рабочей области, используйте операцию "Обязательное действие " для вызова соответствующей операции синхронизации либо фиксации в Git , либо update from Git.

Разрешения

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

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

Workspace.ReadWrite.All

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

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/initializeConnection

Параметры URI

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

Текст запроса

Имя	Тип	Описание
initializationStrategy	InitializationStrategy	Стратегия, необходимая для процесса инициализации, когда содержимое существует как на удаленной стороне, так и на стороне рабочей области. С течением времени могут добавляться дополнительные стратегии.

Ответы

Имя	Тип	Описание
200 OK	InitializeGitConnectionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят, инициализировать подключение во время выполнения. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: WorkspaceNotConnectedToGit — Рабочая область не подключена к git. WorkspaceHasNoCapacityAssigned— не назначена емкость рабочей области. Отсутствует политика инициализацииPolicy. Политика инициализации отсутствует. НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений в рабочей области. PrincipalTypeNotSupported — тип удостоверения вызывающего объекта не поддерживается.

Примеры

Initialize the connection of a workspace connected to a Git example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/initializeConnection

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

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

200

{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}

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

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
InitializationStrategy	Стратегия, необходимая для процесса инициализации, когда содержимое существует как на удаленной стороне, так и на стороне рабочей области. С течением времени могут добавляться дополнительные стратегии.
InitializeGitConnectionRequest	Содержит данные запроса на подключение Git инициализации.
InitializeGitConnectionResponse	Содержит данные ответа на подключение Git инициализации.
RequiredAction	Необходимое действие после завершения процесса инициализации. С течением времени могут добавляться дополнительные действия.

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	Сведения об ошибках, связанных с ресурсом.

InitializationStrategy

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

Стратегия, необходимая для процесса инициализации, когда содержимое существует как на удаленной стороне, так и на стороне рабочей области. С течением времени могут добавляться дополнительные стратегии.

Значение	Описание
None	Стратегия не определена.
PreferRemote	Предпочитаете удаленное содержимое Git.
PreferWorkspace	Предпочитайте содержимое на стороне рабочей области.

InitializeGitConnectionRequest

Object

Содержит данные запроса на подключение Git инициализации.

Имя	Тип	Описание
initializationStrategy	InitializationStrategy	Стратегия, необходимая для процесса инициализации, когда содержимое существует как на удаленной стороне, так и на стороне рабочей области. С течением времени могут добавляться дополнительные стратегии.

InitializeGitConnectionResponse

Object

Содержит данные ответа на подключение Git инициализации.

Имя	Тип	Описание
remoteCommitHash	string	Хэш удаленной полной фиксации SHA.
requiredAction	RequiredAction	Необходимое действие после завершения процесса инициализации. С течением времени могут добавляться дополнительные действия.
workspaceHead	string	Полный хэш SHA, с которым синхронизируется рабочая область.

RequiredAction

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

Необходимое действие после завершения процесса инициализации. С течением времени могут добавляться дополнительные действия.

Значение	Описание
CommitToGit	Требуется фиксация в Git.
None	Никаких действий не требуется.
UpdateFromGit	Требуется обновление из Git.