Git - Connect

Service:

Core

API Version:

v1

Note

This API is in preview.

Connect a specific workspace to a git repository and branch.

This operation does not sync between the workspace and the connected branch. To complete the sync, use the Initialize Connection operation and follow with either the Commit To Git or the Update From Git operation.

Permissions

The caller must have an admin role for the workspace.

Required Delegated Scopes

Workspace.ReadWrite.All

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connect

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Required	Type	Description
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails	The Git provider details.

Responses

Name	Type	Description
200 OK		Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred WorkspaceAlreadyConnectedToGit - Workspace is already connected to git WorkspaceHasNoCapacityAssigned - Workspace is not on capacity InsufficientPrivileges - The caller does not have sufficient permissions on the workspace

Examples

Connect a workspace to a Git example

Sample Request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/connect

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  }
}

Sample Response

Status code:

200

Definitions

Name	Description
AzureDevOpsDetails	Azure DevOps provider details.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GitConnectRequest	Contains the Git connect request data.
GitProviderType	A Git provider type. Additional provider types may be added over time.

AzureDevOpsDetails

Azure DevOps provider details.

Name	Type	Description
branchName	string	The branch name. Maximum length is 250 characters.
directoryName	string	The directory name. Maximum length is 256 characters.
gitProviderType	string: AzureDevOps	A Git provider type. Additional provider types may be added over time.
organizationName	string	The organization name. Maximum length is 100 characters.
projectName	string	The project name. Maximum length is 100 characters.
repositoryName	string	The repository name. Maximum length is 128 characters.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

GitConnectRequest

Contains the Git connect request data.

Name	Type	Description
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails	The Git provider details.

GitProviderType

A Git provider type. Additional provider types may be added over time.

Name	Type	Description
AzureDevOps	string	Azure DevOps provider