Git - Get Status
Возвращает Git status
элементов в рабочей области, которые можно зафиксировать в Git.
Этот API поддерживает длительные операции (LRO).
Состояние указывает на изменения элементов с момента последней рабочей области и синхронизации удаленной ветви. Если оба расположения были изменены, API помечает конфликт.
Разрешения
Вызывающий объект должен иметь роль участника или более поздней рабочей области.
Обязательные делегированные области
Workspace.GitUpdate.All или Workspace.GitCommit.All
Поддерживаемые удостоверения Microsoft Entra
Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.
Тождество | Поддержка |
---|---|
Пользователь | Да |
субъекта-службы и управляемых удостоверений | Нет |
Интерфейс
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
Идентификатор рабочей области. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос успешно завершен. |
|
202 Accepted |
Запрос принят, получение состояния во время выполнения. Заголовки
|
|
Other Status Codes |
Распространенные коды ошибок:
|
Примеры
Get status example |
Get status no changes example |
Get status with conflict example |
Get status example
Образец запроса
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Пример ответа
{
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
"changes": [
{
"itemMetadata": {
"itemIdentifier": {
"objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
},
"itemType": "SemanticModel",
"displayName": "My new dataset in the workspace"
},
"workspaceChange": "Added",
"conflictType": "None"
},
{
"itemMetadata": {
"itemIdentifier": {
"logicalId": "1423f3b4-dba5-44c1-a94f-6ae4d776369a"
},
"itemType": "Report",
"displayName": "My deleted report in Git"
},
"remoteChange": "Deleted",
"conflictType": "None"
},
{
"itemMetadata": {
"itemIdentifier": {
"logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
"objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
},
"itemType": "SemanticModel",
"displayName": "Modified dataset in the workspace"
},
"workspaceChange": "Modified",
"conflictType": "None"
}
]
}
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
Get status no changes example
Образец запроса
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Пример ответа
{
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"changes": []
}
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
Get status with conflict example
Образец запроса
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Пример ответа
{
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
"changes": [
{
"itemMetadata": {
"itemIdentifier": {
"logicalId": "222e8d7b-4a95-4c02-8ccd-6faef5ba1bd2",
"objectId": "8853f3b4-dbb8-33c1-a84f-6ae4d776362a"
},
"itemType": "Report",
"displayName": "Modified report on both sides"
},
"remoteChange": "Modified",
"workspaceChange": "Modified",
"conflictType": "Conflict"
}
]
}
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
Определения
Имя | Описание |
---|---|
Change |
Изменение элемента. С течением времени могут добавляться дополнительные измененные типы. |
Conflict |
Изменение элемента в рабочей области и удаленном. С течением времени могут добавляться дополнительные измененные типы. |
Error |
Объект сведений об ошибках, связанных с ресурсом. |
Error |
Ответ на ошибку. |
Error |
Сведения об ответе на ошибку. |
Git |
Содержит ответ состояния. |
Item |
Содержит сведения об изменении элемента. |
Item |
Содержит идентификатор элемента. Необходимо определить хотя бы одно из свойств. |
Item |
Содержит метаданные элемента. |
Item |
Тип элемента. С течением времени могут добавляться дополнительные типы элементов. |
ChangeType
Изменение элемента. С течением времени могут добавляться дополнительные измененные типы.
Значение | Описание |
---|---|
Added |
Созданный элемент. |
Deleted |
Элемент удален. |
Modified |
Содержимое элемента было изменено. |
ConflictType
Изменение элемента в рабочей области и удаленном. С течением времени могут добавляться дополнительные измененные типы.
Значение | Описание |
---|---|
Conflict |
В рабочей области и удаленном Git существуют различные изменения элемента. |
None |
Изменения в элементе отсутствуют. |
SameChanges |
В рабочей области и удаленном Git имеются идентичные изменения. |
ErrorRelatedResource
Объект сведений об ошибках, связанных с ресурсом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса, участвующий в ошибке. |
resourceType |
string |
Тип ресурса, который участвует в ошибке. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
moreDetails |
Список дополнительных сведений об ошибке. |
|
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
|
requestId |
string |
Идентификатор запроса, связанного с ошибкой. |
ErrorResponseDetails
Сведения об ответе на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
GitStatusResponse
Содержит ответ состояния.
Имя | Тип | Описание |
---|---|---|
changes |
Список изменений в удаленном Git, которые не применяются к данной рабочей области, и изменения в рабочей области, которые не применяются к удаленной Git. |
|
remoteCommitHash |
string |
Хэш удаленной полной фиксации SHA. |
workspaceHead |
string |
Полный хэш SHA, с которым синхронизируется рабочая область. |
ItemChange
Содержит сведения об изменении элемента.
Имя | Тип | Описание |
---|---|---|
conflictType |
При наличии изменений на стороне рабочей области и удаленной стороне Git. |
|
itemMetadata |
Метаданные элемента. |
|
remoteChange |
Изменение на удаленной стороне Git. |
|
workspaceChange |
Изменение на стороне рабочей области. |
ItemIdentifier
Содержит идентификатор элемента. Необходимо определить хотя бы одно из свойств.
Имя | Тип | Описание |
---|---|---|
logicalId |
string uuid |
Логический идентификатор элемента. Если логический идентификатор недоступен, так как элемент еще не добавлен в рабочую область, можно использовать идентификатор объекта. |
objectId |
string uuid |
Идентификатор объекта элемента. Если идентификатор объекта недоступен, так как элемент был удален из рабочей области, можно использовать логический идентификатор. |
ItemMetadata
Содержит метаданные элемента.
Имя | Тип | Описание |
---|---|---|
displayName |
string |
Отображаемое имя элемента. Предпочитает отображаемое имя элемента рабочей области, если оно существует, в противном случае displayName использует отображаемое имя удаленного элемента. |
itemIdentifier |
Идентификатор элемента. |
|
itemType |
Тип элемента. |
ItemType
Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Значение | Описание |
---|---|
Dashboard |
Панель мониторинга PowerBI. |
DataPipeline |
Конвейер данных. |
Datamart |
Datamart PowerBI. |
Environment |
Среда. |
Eventhouse |
Хранилище событий. |
Eventstream |
Поток событий. |
GraphQLApi |
API для элемента GraphQL. |
KQLDashboard |
Панель мониторинга KQL. |
KQLDatabase |
База данных KQL. |
KQLQueryset |
Набор запросов KQL. |
Lakehouse |
Озеро. |
MLExperiment |
Эксперимент машинного обучения. |
MLModel |
Модель машинного обучения. |
MirroredDatabase |
Зеркальная база данных. |
MirroredWarehouse |
Зеркальный склад. |
MountedDataFactory |
ПодключеннаяdataFactory. |
Notebook |
Записная книжка. |
PaginatedReport |
Отчет с разбивкой на страницы PowerBI. |
Reflex |
Рефлекс. |
Report |
Отчет PowerBI. |
SQLDatabase |
База данных SQLDatabase. |
SQLEndpoint |
Конечная точка SQL. |
SemanticModel |
Семантическая модель PowerBI. |
SparkJobDefinition |
Определение задания Spark. |
Warehouse |
Склад. |