Partilhar via


Git - Get Status

Retorna o Git status de itens no espaço de trabalho que podem ser confirmados no Git.
Esta API suporta operações de longa duração (LRO).

O status indica alterações nos itens desde o último espaço de trabalho e sincronização de ramificação remota. Se os itens remoto e de espaço de trabalho foram modificados, a API sinaliza um conflito.

Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando Update My Git Credentials API. Você pode usar a API Get My Git Credentials para verificar a configuração das credenciais do Git.

Permissions

O chamador deve ter uma função de de espaço de trabalho de contribuidor ou superior.

Escopos delegados necessários

Workspace.GitUpdate.All ou Workspace.GitCommit.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity Support
User Yes
Entidade de serviço e identidades geridas Yes

Interface

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

Parâmetros URI

Nome Em Necessário Tipo Descrição
workspaceId
path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Nome Tipo Descrição
200 OK

GitStatusResponse

Pedido concluído com sucesso.

202 Accepted

Pedido aceite, obter o estado em curso.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • WorkspaceNotConnectedToGit - O espaço de trabalho não está conectado ao git.

  • WorkspaceHasNoCapacityAssigned - O espaço de trabalho não está na capacidade.

  • InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes.

  • PrincipalTypeNotSupported - O tipo de identidade do chamador não é suportado.

Exemplos

Get status example
Get status no changes example
Get status with conflict example

Get status example

Pedido 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

Pedido 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

Pedido 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

Definições

Nome Descrição
ChangeType

Uma alteração de um item. Tipos alterados adicionais podem ser adicionados ao longo do tempo.

ConflictType

Uma alteração de um item no espaço de trabalho e remoto. Tipos alterados adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

GitStatusResponse

Contém a resposta de status.

ItemChange

Contém as informações de alteração do item.

ItemIdentifier

Contém o identificador do item. Pelo menos uma das propriedades deve ser definida.

ItemMetadata

Contém os metadados do item.

ItemType

O tipo do item. Tipos de itens 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 espaço de trabalho e remoto. Tipos alterados adicionais podem ser adicionados ao longo do tempo.

Valor Descrição
None

Não há alterações no item.

Conflict

Há diferentes alterações no item no espaço de trabalho e no Git remoto.

SameChanges

Há alterações idênticas no item no espaço de trabalho e no Git remoto.

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 de 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 uma comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível por humanos do erro.

moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

requestId

string

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 uma comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível por humanos do erro.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

GitStatusResponse

Contém a resposta de status.

Nome Tipo Descrição
changes

ItemChange[]

Uma lista de alterações no Git remoto que não são aplicadas ao espaço de trabalho específico e alterações no espaço de trabalho que não são aplicadas ao Git remoto.

remoteCommitHash

string

Hash de confirmação SHA completo remoto.

workspaceHead

string

Hash SHA completo com o qual o espaço de trabalho está sincronizado.

ItemChange

Contém as informações de alteração do item.

Nome Tipo Descrição
conflictType

ConflictType

Quando há alterações no lado do espaço de trabalho e no lado remoto do Git.

itemMetadata

ItemMetadata

Os metadados do item.

remoteChange

ChangeType

Mude no lado remoto do Git.

workspaceChange

ChangeType

Altere no lado do espaço de trabalho.

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 espaço de trabalho, você poderá usar a ID do objeto.

objectId

string (uuid)

A ID do objeto do item. Quando a ID do objeto não estiver disponível porque o item foi excluído do espaço de trabalho, você poderá usar a ID lógica.

ItemMetadata

Contém os metadados do item.

Nome Tipo Descrição
displayName

string

O nome para exibição do item. Prefere o nome de exibição do item de espaço de trabalho se ele existir, caso contrário, displayName usa o nome de exibição do item remoto.

itemIdentifier

ItemIdentifier

O identificador do item.

itemType

ItemType

O tipo de item.

ItemType

O tipo do item. Tipos de itens 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 caderno.

SparkJobDefinition

Uma definição de trabalho de faísca.

MLExperiment

Uma experiência de aprendizagem automática.

MLModel

Um modelo de aprendizagem automática.

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

Uma API para o item GraphQL.

MountedDataFactory

Um MountedDataFactory.

SQLDatabase

Um SQLDatabase.

CopyJob

Um trabalho de cópia.

VariableLibrary

Uma VariableLibrary.

Dataflow

Um fluxo de dados.

ApacheAirflowJob

Um ApacheAirflowJob.

WarehouseSnapshot

Um instantâneo do Warehouse.

DigitalTwinBuilder

Um DigitalTwinBuilder.

DigitalTwinBuilderFlow

Um fluxo de construtor de gêmeos digitais.

MirroredAzureDatabricksCatalog

Um catálogo de databricks azure espelhado.

Map

Um mapa.

AnomalyDetector

Um detetor de anomalias.

UserDataFunction

Uma função de dados do usuário.

GraphModel

Um GraphModel.

GraphQuerySet

Um Graph QuerySet.

SnowflakeDatabase

Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.

OperationsAgent

Um Agente de Operações.

CosmosDBDatabase

Uma base de dados Cosmos DB.

Ontology

Uma ontologia.

EventSchemaSet

Um EventoSchemaSet.