Git - Update From Git

Служба:
Core
Версия API:
v1

Обновляет рабочую область с фиксациями, отправленными в подключенную ветвь.
Этот API поддерживает длительные операции (LRO).

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

Обновление влияет только на элементы рабочей области, которые были изменены в этих фиксациях. Если он вызывается после API подключения иинициализации, он выполнит полное обновление всей рабочей области.

Разрешения

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

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

Workspace.GitUpdate.All

Идентификаторы, поддерживаемые Microsoft Entra

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

Идентичность Поддержка
Пользователь Да
Представитель службы и управляемые удостоверения Поддерживается только в том случае, если все элементы , участвующие в операции, поддерживают субъекты-службы.

Интерфейс

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

Параметры URI

Имя. В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

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

Имя. Обязательно Тип Описание
remoteCommitHash True

string

Хэш удаленной полной фиксации SHA.
conflictResolution

WorkspaceConflictResolution

Разрешение конфликтов, используемое в обновлении из операции Git. Если элементы находятся в конфликте и разрешение конфликтов не указано, операция обновления не запустится.
options

UpdateOptions

Параметры, используемые в обновлении из операции Git
workspaceHead

string

Полный хэш SHA, с которым синхронизируется рабочая область. Это значение может иметь значение NULL только после инициализации соединения. В других случаях система проверяет соответствие заданного значения с головой, известной системе.

Ответы

Имя. Тип Описание
200 OK

Запрос успешно завершен.
202 Accepted

Запрос принят, обновление из Git выполняется.

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • WorkspaceNotConnectedToGit — Рабочая область не подключена к git.

  • WorkspaceHasNoCapacityAssigned— емкость, назначенная рабочей области, не назначена.

  • WorkspaceHeadMismatch — голова в запросе не соответствует голове в системе.

  • WorkspacePreviousOperationInProgresss — предыдущая операция по-прежнему выполняется.

  • ОтсутствуетDependency— зависимость отсутствует в операции обновления.

  • ПотенциальныйDuplicateDisplayNameAndType — операция обновления создаст повторяющееся отображаемое имя и тип.

  • DependencyDeletionFailed — операция обновления приведет к удалению жесткой зависимости.

  • НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений рабочей области.

  • PrincipalTypeNotSupported — тип удостоверения вызывающего объекта не поддерживается.

Примеры

Update a workspace from Git with options example
Update a workspace using data from a Git example

Update a workspace from Git with options example

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

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

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

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

Код состояния:
200
Код состояния:
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

Update a workspace using data from a Git example

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

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

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

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

Код состояния:
200
Код состояния:
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

Определения

Имя. Описание
ConflictResolutionPolicy

Политика разрешения конфликтов. С течением времени могут добавляться дополнительные политики разрешения конфликтов.
ConflictResolutionType

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

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

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

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

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

Запись параметров для каждого элемента, предназначенная для его элемента по логическому идентификатору. Каждый целевой элемент может отображаться не более одного раза.
UpdateFromGitRequest

Содержит обновление из данных запроса Git.
UpdateOptions

Содержит параметры, включенные для обновления из Git.
WorkspaceConflictResolution

Базовые данные о разрешении конфликтов.

ConflictResolutionPolicy

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

Политика разрешения конфликтов. С течением времени могут добавляться дополнительные политики разрешения конфликтов.

Значение Описание
PreferRemote

Предпочитаете удаленное содержимое Git.
PreferWorkspace

Предпочитайте содержимое на стороне рабочей области.

ConflictResolutionType

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

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

Значение Описание
Workspace

Разрешение конфликтов, представляющее уровень рабочей области.

ErrorParameter

Объект

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

Имя. Тип Описание
message

string

Читаемое человеком описание значения параметра.
name

string

Идентификатор параметра.
value

string

Значение параметра.

ErrorRelatedResource

Объект

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

Имя. Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя. Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
parameters

ErrorParameter[]

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

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

Имя. Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
parameters

ErrorParameter[]

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

ErrorRelatedResource

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

ItemOptionsByLogicalIdEntry

Объект

Запись параметров для каждого элемента, предназначенная для его элемента по логическому идентификатору. Каждый целевой элемент может отображаться не более одного раза.

Имя. Тип Описание
logicalId

string (uuid)

Логический идентификатор целевого элемента.
options

object

Параметры целевого элемента. Имена свойств являются именами параметров, допустимыми для типа элемента; значения параметра — это значения параметров. Параметры, поддерживаемые определенным типом элемента, см. в документации по API этого типа Update-Definition элемента.

UpdateFromGitRequest

Объект

Содержит обновление из данных запроса Git.

Имя. Тип Описание
conflictResolution

WorkspaceConflictResolution

Разрешение конфликтов, используемое в обновлении из операции Git. Если элементы находятся в конфликте и разрешение конфликтов не указано, операция обновления не запустится.
options

UpdateOptions

Параметры, используемые в обновлении из операции Git
remoteCommitHash

string

Хэш удаленной полной фиксации SHA.
workspaceHead

string

Полный хэш SHA, с которым синхронизируется рабочая область. Это значение может иметь значение NULL только после инициализации соединения. В других случаях система проверяет соответствие заданного значения с головой, известной системе.

UpdateOptions

Объект

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

Имя. Тип Описание
allowOverrideItems

boolean

Согласие пользователя переопределить входящие элементы во время обновления из процесса Git. Если входящие элементы присутствуют и разрешенные элементы переопределения не указаны или предоставляются как false, операция обновления не запустится. По умолчанию используется значение false.
itemOptionsByLogicalId

ItemOptionsByLogicalIdEntry[]

Параметры обновления для каждого элемента. Каждая запись предназначена для элемента по логическому идентификатору и применяет его параметры к этому элементу.

WorkspaceConflictResolution

Объект

Базовые данные о разрешении конфликтов.

Имя. Тип Описание
conflictResolutionPolicy

ConflictResolutionPolicy

Политика разрешения конфликтов. С течением времени могут добавляться дополнительные политики разрешения конфликтов.
conflictResolutionType

ConflictResolutionType

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