Skip to main content

WorkspaceGit

Properties

PropertyTypeAttributesDescription
gitCredentialsWorkspaceGitCredentialsRequiredThe Git credentials details
gitProviderDetailsWorkspaceGitProviderDetailsRequiredThe Git provider details. Changing these forces the connection to be recreated.
initializationStrategy'None' | 'PreferRemote' | 'PreferWorkspace'RequiredThe strategy used to reconcile the workspace and the repository when the connection is initialized
workspaceIdstringRequired, IdentifierThe Fabric workspace ID
gitConnectionState'NotConnected' | 'Connected' | 'ConnectedAndInitialized'Read-onlyThe Git connection state
gitSyncDetailsWorkspaceGitSyncDetailsRead-onlyDetails of the last sync between the workspace and the repository
optionsWorkspaceGitOptionsOptions applied to the initial sync from Git

WorkspaceGitCredentials

PropertyTypeAttributesDescription
source'Automatic' | 'ConfiguredConnection'RequiredThe Git credentials source. 'Automatic' is only supported for Azure DevOps.
connectionIdstringThe connection used to authenticate to the Git provider. Required when 'source' is 'ConfiguredConnection'.

WorkspaceGitProviderDetails

PropertyTypeAttributesDescription
branchNamestringRequiredThe branch name
directoryNamestringRequiredThe directory name. Must start with a forward slash.
gitProviderType'AzureDevOps' | 'GitHub'RequiredThe Git provider type. Changing this forces the connection to be recreated.
repositoryNamestringRequiredThe repository name
organizationNamestringThe Azure DevOps organization name. Required when 'gitProviderType' is 'AzureDevOps'.
ownerNamestringThe GitHub owner name. Required when 'gitProviderType' is 'GitHub'.
projectNamestringThe Azure DevOps project name. Required when 'gitProviderType' is 'AzureDevOps'.

WorkspaceGitSyncDetails

PropertyTypeAttributesDescription
headstringRead-onlyThe commit hash of the last sync
lastSyncTimestringRead-onlyThe date and time of the last sync

WorkspaceGitOptions

PropertyTypeAttributesDescription
allowOverrideItemsboolWhether incoming items may override existing workspace items during the initial sync from Git