Git - Get Status
Retorna o Git status de itens no workspace, que podem ser confirmados no Git.
Essa API dá suporte a LRO (operações de execução longa).
O status indica alterações nos itens desde o último workspace e a sincronização de ramificação remota. Se os itens remotos e de workspace foram modificados, a API sinaliza um conflito. A API não deve ser chamada enquanto a operação Atualizar do Git estiver em execução.
Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando a API Atualizar Minhas Credenciais do Git . Você pode usar a API Obter Minhas Credenciais do Git para verificar a configuração de credenciais do Git.
Permissions
O chamador deve ter um colaborador ou uma função de workspace superior.
Escopos delegados necessários
Workspace.GitUpdate.All ou Workspace.GitCommit.All
Limitações
| Tipo de limite | Valor |
|---|---|
| Cota unificada para APIs de plataforma | 500 chamadas/min |
| Limite de API | 50 chamadas/min |
Identidades com suporte do Microsoft Entra
Esta API dá suporte às identidades do Microsoft listadas nesta seção.
| Identity | Support |
|---|---|
| User | Yes |
| Entidade de serviço e identidades gerenciadas | Yes |
Interface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status?includeFilesDetails={includeFilesDetails}
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
A ID do workspace. |
|
include
|
query |
boolean |
Quando true, cada alteração de item na resposta inclui uma matriz fileChanges com detalhes de alteração por arquivo. |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK |
Solicitação concluída com êxito. |
|
| 202 Accepted |
Solicitação aceita, obter status em andamento. Cabeçalhos
|
|
| 429 Too Many Requests |
O limite de taxa de serviço foi excedido. O servidor retorna um Cabeçalhos Retry-After: integer |
|
| Other Status Codes |
Códigos de erro comuns:
|
Exemplos
| Get status example |
| Get status no changes example |
| Get status with conflict example |
| Get status with file details example |
Get status example
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Resposta de exemplo
{
"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
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Resposta de exemplo
{
"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
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
Resposta de exemplo
{
"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
Get status with file details example
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status?includeFilesDetails=True
Resposta de exemplo
{
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
"changes": [
{
"itemMetadata": {
"itemIdentifier": {
"objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
},
"itemType": "Notebook",
"displayName": "MyNotebook"
},
"workspaceChange": "Modified",
"remoteChange": "Modified",
"conflictType": "Conflict",
"fileChanges": [
{
"path": "notebook-content.py",
"workspaceChange": "Modified",
"remoteChange": "Modified",
"conflictType": "Conflict"
},
{
"path": "metadata.json",
"workspaceChange": "Modified",
"conflictType": "None"
},
{
"path": "config/settings.json",
"remoteChange": "Added",
"conflictType": "None"
}
]
},
{
"itemMetadata": {
"itemIdentifier": {
"objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789"
},
"itemType": "Report",
"displayName": "SalesReport"
},
"workspaceChange": "Modified",
"conflictType": "None",
"fileChanges": [
{
"path": "pages/page1.json",
"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
Definições
| Nome | Descrição |
|---|---|
|
Change |
Uma alteração de um item. Tipos alterados adicionais podem ser adicionados ao longo do tempo. |
|
Conflict |
Uma alteração de um item no workspace e no remoto. Tipos alterados adicionais podem ser adicionados ao longo do tempo. |
|
Error |
Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro. |
|
Error |
O objeto de detalhes do recurso relacionado ao erro. |
|
Error |
A resposta de erro. |
|
Error |
Os detalhes da resposta de erro. |
|
Git |
Contém informações sobre uma alteração no nível do arquivo em um item. |
|
Git |
Contém a resposta de status. |
|
Item |
Contém as informações de alteração do item. |
|
Item |
Contém o identificador do item. Pelo menos uma das propriedades deve ser definida. |
|
Item |
Contém os metadados do item. |
|
Item |
O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo. |
ChangeType
Uma alteração de um item. Tipos alterados adicionais podem ser adicionados ao longo do tempo.
| Valor | Descrição |
|---|---|
| Added |
Um item recém-criado. |
| Deleted |
O item foi excluído. |
| Modified |
O conteúdo do item foi modificado. |
ConflictType
Uma alteração de um item no workspace e no remoto. Tipos alterados adicionais podem ser adicionados ao longo do tempo.
| Valor | Descrição |
|---|---|
| None |
Não há alterações no item. |
| Conflict |
Há alterações diferentes no item no workspace e no Git remoto. |
| SameChanges |
Há alterações idênticas no item no workspace e no Git remoto. |
ErrorParameter
Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.
| Nome | Tipo | Descrição |
|---|---|---|
| message |
string |
Uma descrição legível pelo ser humano do significado do parâmetro. |
| name |
string |
O identificador de parâmetro. |
| value |
string |
O valor do parâmetro. |
ErrorRelatedResource
O objeto de detalhes do recurso relacionado ao erro.
| Nome | Tipo | Descrição |
|---|---|---|
| resourceId |
string |
A ID do recurso envolvida no erro. |
| resourceType |
string |
O tipo do recurso envolvido no erro. |
ErrorResponse
A resposta de erro.
| Nome | Tipo | Descrição |
|---|---|---|
| errorCode |
string |
Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários. |
| isRetriable |
boolean |
Quando true, a solicitação pode ser repetida. Use o |
| message |
string |
Uma representação legível humana do erro. |
| moreDetails |
Lista de detalhes de erro adicionais. |
|
| parameters |
Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro. |
|
| relatedResource |
Os detalhes do recurso relacionado ao erro. |
|
| requestId |
string (uuid) |
ID da solicitação associada ao erro. |
ErrorResponseDetails
Os detalhes da resposta de erro.
| Nome | Tipo | Descrição |
|---|---|---|
| errorCode |
string |
Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários. |
| message |
string |
Uma representação legível humana do erro. |
| parameters |
Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro. |
|
| relatedResource |
Os detalhes do recurso relacionado ao erro. |
GitFileChange
Contém informações sobre uma alteração no nível do arquivo em um item.
| Nome | Tipo | Descrição |
|---|---|---|
| conflictType |
O estado de conflito para este arquivo. |
|
| path |
string |
O caminho do arquivo relativo à raiz do item. Ele usa barras para frente e não tem nenhuma barra à esquerda. |
| remoteChange |
Altere no lado remoto do Git. |
|
| workspaceChange |
Alterar no lado do workspace. |
GitStatusResponse
Contém a resposta de status.
| Nome | Tipo | Descrição |
|---|---|---|
| changes |
Uma lista de alterações no Git remoto que não são aplicadas ao workspace fornecido e alterações no workspace que não são aplicadas ao Git remoto. |
|
| remoteCommitHash |
string |
Hash de confirmação SHA completo remoto. |
| workspaceHead |
string |
Hash SHA completo ao qual o workspace está sincronizado. |
ItemChange
Contém as informações de alteração do item.
| Nome | Tipo | Descrição |
|---|---|---|
| conflictType |
Quando há alterações no lado do workspace e no lado remoto do Git. |
|
| fileChanges |
Uma lista de alterações no nível do arquivo dentro do item. Populado somente quando o parâmetro de consulta includeFilesDetails é definido como true. |
|
| itemMetadata |
Os metadados do item. |
|
| remoteChange |
Altere no lado remoto do Git. |
|
| workspaceChange |
Alterar no lado do workspace. |
ItemIdentifier
Contém o identificador do item. Pelo menos uma das propriedades deve ser definida.
| Nome | Tipo | Descrição |
|---|---|---|
| logicalId |
string (uuid) |
A ID lógica do item. Quando a ID lógica não estiver disponível porque o item ainda não foi adicionado ao workspace, você poderá usar a ID do objeto. |
| objectId |
string (uuid) |
A ID do objeto do item. Quando a ID do objeto não está disponível porque o item foi excluído do workspace, você pode usar a ID lógica. |
ItemMetadata
Contém os metadados do item.
| Nome | Tipo | Descrição |
|---|---|---|
| displayName |
string |
O nome de exibição do item. Prefere o nome de exibição do item de workspace se ele existir, caso contrário, displayName usará o nome de exibição do item remoto. |
| itemIdentifier |
O identificador do item. |
|
| itemType |
O tipo de item. |
ItemType
O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
| Valor | Descrição |
|---|---|
| Dashboard |
Painel do PowerBI. |
| Report |
Relatório do PowerBI. |
| SemanticModel |
Modelo semântico do PowerBI. |
| PaginatedReport |
Relatório paginado do PowerBI. |
| Datamart |
Datamart do PowerBI. |
| Lakehouse |
Uma casa no lago. |
| Eventhouse |
Uma casa de eventos. |
| Environment |
Um ambiente. |
| KQLDatabase |
Um banco de dados KQL. |
| KQLQueryset |
Um conjunto de consultas KQL. |
| KQLDashboard |
Um painel KQL. |
| DataPipeline |
Um pipeline de dados. |
| Notebook |
Um notebook. |
| SparkJobDefinition |
Uma definição de trabalho do Spark. |
| MLExperiment |
Um experimento de aprendizado de máquina. |
| MLModel |
Um modelo de machine learning. |
| Warehouse |
Um armazém. |
| Eventstream |
Um fluxo de eventos. |
| SQLEndpoint |
Um ponto de extremidade SQL. |
| MirroredWarehouse |
Um armazém espelhado. |
| MirroredDatabase |
Um banco de dados espelhado. |
| Reflex |
Um Reflexo. |
| GraphQLApi |
Um item de API para GraphQL. |
| MountedDataFactory |
Um MountedDataFactory. |
| SQLDatabase |
Um SQLDatabase. |
| CopyJob |
Um trabalho de cópia. |
| VariableLibrary |
Um VariableLibrary. |
| Dataflow |
Um fluxo de dados. |
| ApacheAirflowJob |
Um ApacheAirflowJob. |
| WarehouseSnapshot |
Um instantâneo do Warehouse. |
| DigitalTwinBuilder |
Um DigitalTwinBuilder. |
| DigitalTwinBuilderFlow |
Um fluxo do Construtor de Gêmeos Digitais. |
| MirroredAzureDatabricksCatalog |
Um catálogo espelhado do Azure Databricks. |
| Map |
Um mapa. |
| AnomalyDetector |
Um Detector de Anomalias. |
| UserDataFunction |
Uma função de dados do usuário. |
| GraphModel |
Um GraphModel. |
| GraphQuerySet |
Um Graph QuerySet. |
| SnowflakeDatabase |
Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake. |
| OperationsAgent |
Um OperationsAgent. |
| CosmosDBDatabase |
Um banco de dados do Cosmos DB. |
| Ontology |
Uma ontologia. |
| EventSchemaSet |
Um EventSchemaSet. |
| DataAgent |
Um DataAgent. |
| MirroredCatalog |
Um MirroredCatalog. |
| PolicySet |
Um PolicySet. |
| AppBackend |
Um AppBackend. |
| OrgApp |
Um aplicativo de organização. |
| OrgAppAudience |
Uma audiência de aplicativo da organização. |
| DataBuildToolJob |
Um DataBuildToolJob. |
| AzureDatabricksStorage |
Um item de armazenamento com backup do OneLake para Azure Databricks. |
| Plan |
Um plano. |
| Monitoring |
Um item de monitoramento. |
| DeploymentPlan |
Um plano de implantação. |
| ShareSubscription |
Uma assinatura de compartilhamento. |
| Share |
Um compartilhamento. |
| Playbook |
Um guia estratégico. |
| MirroredOneLake |
Um item do OneLake espelhado. |
| PostgreSQLDatabase |
Um item de banco de dados PostgreSQL no Microsoft Fabric. |
| CustomStreamConnector |
Um item do Conector de Fluxo Personalizado no Microsoft Fabric. |