Git - Update From Git

Aktualizuje pracovní prostor potvrzeními nasdílenými do připojené větve.

Note

Podpora plánu nasazení v tomto rozhraní API je součástí beta verze a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití. Všechny ostatní funkce tohoto rozhraní API jsou obecně dostupné. Pokud chcete použít podporu plánu nasazení, volající musí jako hodnotu parametru betadotazu zadat true hodnotu .

Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete toto rozhraní API použít, musí být přihlašovací údaje Git volajícího nakonfigurované pomocí rozhraní UPDATE MY Git CREDENTIALS API. Ke kontrole konfigurace přihlašovacích údajů Gitu můžete použít rozhraní API Získat moje přihlašovací údaje Gitu .

Aktualizace má vliv jenom na položky v pracovním prostoru, které byly změněny v těchto potvrzeních. Pokud se volá po připojení ainicializaci rozhraní API připojení, provede úplnou aktualizaci celého pracovního prostoru.

Dovolení

Volající musí mít roli přispěvatele nebo vyšší roli pracovního prostoru.

Požadované delegovaná rozsahy

Workspace.GitUpdate.All

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita Podpora
Uživatel Ano
Hlavní služba a Spravované identity Podporováno pouze v případech, kdy všechny položky zahrnuté v operaci podporují instanční objekty.

Rozhraní

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

Parametry identifikátoru URI

Název V Vyžadováno Typ Description
workspaceId
path True

string (uuid)

ID pracovního prostoru.

beta
query

boolean

Nastavte na true povolení beta funkčnosti, včetně podpory plánu nasazení. Pokud tuto možnost vynecháte nebo nastavíte falsena možnost , budou přístupné pouze obecně dostupné funkce a vstup plánu nasazení se nepřijme.

Text požadavku

Název Vyžadováno Typ Description
remoteCommitHash True

string

Vzdálená úplná hodnota hash potvrzení SHA

conflictResolution

WorkspaceConflictResolution

Řešeníkonfliktůch Pokud jsou položky v konfliktu a není zadáno řešení konfliktů, operace aktualizace se nespustí.

options

UpdateOptions

Možnosti, které se mají použít v aktualizaci z operace Gitu

workspaceHead

string

Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Tato hodnota může být null až po inicializaci připojení. V jiných případech systém ověří, že daná hodnota je v souladu s hlavou známou systémem.

Odpovědi

Název Typ Description
200 OK

Žádost byla úspěšně dokončena.

202 Accepted

Žádost byla přijata, probíhá aktualizace z Gitu.

Hlavičky

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

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • WorkspaceNotConnectedToGit – Pracovní prostor není připojený k Gitu.

  • WorkspaceHasNoCapacityAssigned – k pracovnímu prostoru není přiřazena žádná kapacita.

  • WorkspaceHeadMismatch – Hlavička v požadavku neodpovídá hlavičce v systému.

  • WorkspacePreviousOperationInProgress – Probíhá předchozí operace.

  • MissingDependency – V operaci aktualizace chybí závislost.

  • PotentialDuplicateDisplayNameAndType – Operace aktualizace vytvoří duplicitní zobrazovaný název a typ.

  • DependencyDeletionFailed – Operace aktualizace odstraní pevnou závislost.

  • InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru.

  • PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Příklady

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

Update a workspace from Git with options example

Ukázkový požadavek

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
        }
      }
    ]
  }
}

Ukázková odpověď

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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

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 with a deployment plan example

Ukázkový požadavek

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,
    "deploymentPlan": {
      "referenceType": "ByLogicalId",
      "logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

Ukázková odpověď

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

Definice

Název Description
ConflictResolutionPolicy

Zásady řešení konfliktů. V průběhu času se můžou přidat další zásady řešení konfliktů.

ConflictResolutionType

Typ řešení konfliktů. V průběhu času se můžou přidat další typy řešení konfliktů.

DeploymentPlanReferenceByItemId

Odkaz na plán nasazení podle ID položky.

DeploymentPlanReferenceByLogicalId

Odkaz na plán nasazení podle logického ID

DeploymentPlanReferenceType

Referenční typ plánu nasazení. V průběhu času je možné přidat další typy DeploymentPlanReferenceType.

ErrorParameter

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.

ErrorResponse

Odpověď na chybu.

ErrorResponseDetails

Podrobnosti o odpovědi na chybu.

ItemOptionsByLogicalIdEntry

Položka možností pro jednotlivé položky, která cílí na její položku podle logického ID. Každá cílová položka se může objevit najednou.

UpdateFromGitRequest

Obsahuje aktualizaci z dat požadavku Gitu.

UpdateOptions

Obsahuje možnosti, které jsou povolené pro aktualizaci z Gitu.

WorkspaceConflictResolution

Základní data řešení konfliktů.

ConflictResolutionPolicy

Zásady řešení konfliktů. V průběhu času se můžou přidat další zásady řešení konfliktů.

Hodnota Description
PreferRemote

Preferujte vzdálený obsah na straně Gitu.

PreferWorkspace

Upřednostněte obsah na straně pracovního prostoru.

ConflictResolutionType

Typ řešení konfliktů. V průběhu času se můžou přidat další typy řešení konfliktů.

Hodnota Description
Workspace

Řešeníkonfliktůch

DeploymentPlanReferenceByItemId

Odkaz na plán nasazení podle ID položky.

Název Typ Description
itemId

string (uuid)

ID položky plánu nasazení.

referenceType string:

ByItemId

Referenční typ plánu nasazení.

DeploymentPlanReferenceByLogicalId

Odkaz na plán nasazení podle logického ID

Název Typ Description
logicalId

string (uuid)

Logické ID položky plánu nasazení.

referenceType string:

ByLogicalId

Referenční typ plánu nasazení.

DeploymentPlanReferenceType

Referenční typ plánu nasazení. V průběhu času je možné přidat další typy DeploymentPlanReferenceType.

Hodnota Description
ByItemId

Na plán nasazení odkazuje ID položky.

ByLogicalId

Na plán nasazení odkazuje jeho logické ID.

ErrorParameter

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

Název Typ Description
message

string

Popis významu parametru čitelný člověkem.

name

string

Identifikátor parametru.

value

string

Hodnota parametru.

ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.

Název Typ Description
resourceId

string

ID prostředku, které je součástí chyby.

resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Odpověď na chybu.

Název Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.

isRetriable

boolean

Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.

message

string

Lidské čitelné vyjádření chyby.

moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě

parameters

ErrorParameter[]

Strukturované parametry poskytují další strojově čitelný kontext chyby.

relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

requestId

string (uuid)

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Podrobnosti o odpovědi na chybu.

Název Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.

message

string

Lidské čitelné vyjádření chyby.

parameters

ErrorParameter[]

Strukturované parametry poskytují další strojově čitelný kontext chyby.

relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

ItemOptionsByLogicalIdEntry

Položka možností pro jednotlivé položky, která cílí na její položku podle logického ID. Každá cílová položka se může objevit najednou.

Název Typ Description
logicalId

string (uuid)

Logické ID cílové položky.

options

object

Možnosti pro cílovou položku. Názvy vlastností jsou názvy možností platné pro typ položky; hodnoty jsou hodnoty možností. Možnosti podporované konkrétním typem položky najdete v dokumentaci k rozhraní API daného typu Update-Definition položky.

UpdateFromGitRequest

Obsahuje aktualizaci z dat požadavku Gitu.

Název Typ Description
conflictResolution

WorkspaceConflictResolution

Řešeníkonfliktůch Pokud jsou položky v konfliktu a není zadáno řešení konfliktů, operace aktualizace se nespustí.

options

UpdateOptions

Možnosti, které se mají použít v aktualizaci z operace Gitu

remoteCommitHash

string

Vzdálená úplná hodnota hash potvrzení SHA

workspaceHead

string

Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Tato hodnota může být null až po inicializaci připojení. V jiných případech systém ověří, že daná hodnota je v souladu s hlavou známou systémem.

UpdateOptions

Obsahuje možnosti, které jsou povolené pro aktualizaci z Gitu.

Název Typ Description
allowOverrideItems

boolean

Souhlas uživatele s přepsání příchozích položek během aktualizace z procesu Gitu Pokud jsou k dispozici příchozí položky a není zadána možnost přepsání položek nebo je zadána jako nepravda, operace aktualizace se nespustí. Výchozí hodnotou je nepravda.

deploymentPlan DeploymentPlanReference:

Odkaz na položku plánu nasazení pro orchestraci nasazení Po poskytnutí plán řídí pořadí nasazení položek a provádí akce před nasazením nebo po nasazení. Pokud chybí nebo hodnota null, operace se chová jako dnes. V současné době se podporuje pouze odkazový ByLogicalId typ. Podpora plánu nasazení je aktuálně v beta verzi. Tuto vlastnost lze použít pouze v případě, že je parametr beta dotazu nastavený true a může se změnit na základě zpětné vazby.

itemOptionsByLogicalId

ItemOptionsByLogicalIdEntry[]

Možnosti aktualizace jednotlivých položek Každá položka cílí na svoji položku podle logického ID a použije na tuto položku své možnosti.

WorkspaceConflictResolution

Základní data řešení konfliktů.

Název Typ Description
conflictResolutionPolicy

ConflictResolutionPolicy

Zásady řešení konfliktů. V průběhu času se můžou přidat další zásady řešení konfliktů.

conflictResolutionType

ConflictResolutionType

Typ řešení konfliktů. V průběhu času se můžou přidat další typy řešení konfliktů.