Git - Connect

Служба:
Core
Версия API:
v1

Подключите определенную рабочую область к репозиторию и ветви Git.
Эта операция не синхронизируется между рабочей областью и подключенной ветвью. Чтобы завершить синхронизацию, используйте операцию инициализации подключения и выполните операцию "Фиксация для Git " или "Обновить из Git ".

Сведения о начале работы с GitHub см. в статье "Начало работы с интеграцией Git".

Чтобы получить идентификатор подключения, см. статью "Автоматизация интеграции Git".

Разрешения

Вызывающий объект должен иметь роль администратора для рабочей области.

Для настроенных учетных данных подключения Git вызывающий объект должен иметь разрешение на подключение.

Обязательные делегированные области

Workspace.ReadWrite.All

Ограничения

При использовании источника автоматических учетных данных этот API блокируется для поставщика GitHub и субъекта-службы.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Идентичность Поддержка
Пользователь Да
учетные записи службы и управляемые удостоверения Поддерживается только в том случае, если myGitCredentials.source — ConfiguredConnection

Интерфейс

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

Параметры URI

Имя. В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя. Обязательно Тип Описание
gitProviderDetails True GitProviderDetails:

Сведения о поставщике Git.
connectionSettings

GitConnectionSettings

Необязательные параметры подключения, применяемые во время подключения. Если опущено, применяются значения по умолчанию.
myGitCredentials GitCredentials:

Учетные данные Git для проверки подлинности в GitProvider. Эти учетные данные не предоставляются другим участникам рабочей области. Для GitHub это свойство является обязательным. Для AzureDevOps это свойство является необязательным. Если значение не задано, значение по умолчанию — AutomaticGitCredentials.

Ответы

Имя. Тип Описание
200 OK

Запрос успешно завершен.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • UnknownError — произошла ошибка.

  • WorkspaceAlreadyConnectedToGit — Рабочая область уже подключена к git.

  • WorkspaceHasNoCapacityAssigned— емкость, назначенная рабочей области, не назначена.

  • НедостаточноPrivileges — вызывающий имеет недостаточно разрешений рабочей области.

  • PrincipalTypeNotSupported — тип удостоверения вызывающего объекта не поддерживается.

Примеры

Connect a workspace to Azure DevOps example
Connect a workspace to Azure DevOps using configured connection example
Connect a workspace to Azure DevOps with connection settings example
Connect a workspace to GitHub example
Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Connect a workspace to Azure DevOps example

Образец запроса

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

Пример ответа

Код состояния:
200

Connect a workspace to Azure DevOps using configured connection example

Образец запроса

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/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Пример ответа

Код состояния:
200

Connect a workspace to Azure DevOps with connection settings example

Образец запроса

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"
  },
  "connectionSettings": {
    "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
  }
}

Пример ответа

Код состояния:
200

Connect a workspace to GitHub example

Образец запроса

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Пример ответа

Код состояния:
200

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Образец запроса

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "customDomainName": "my-enterprise.ghe.com",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Пример ответа

Код состояния:
200

Определения

Имя. Описание
AutomaticGitCredentials

Автоматические учетные данные Git.
AzureDevOpsDetails

Сведения о поставщике Azure DevOps.
ConfiguredConnectionGitCredentials

Настроенные учетные данные подключения Git.
ErrorParameter

Структурированный параметр, предоставляющий дополнительный контекст, доступный для чтения компьютера, об ошибке.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
GitAdditionalBranchChangingRoles

Дополнительные роли рабочей области за пределами администратора, которые могут изменять подключенную ветвь Git. С течением времени могут добавляться дополнительные значения.
GitConnectionSettings

Содержит параметры подключения Git.
GitConnectRequest

Содержит данные запроса Git connect.
GitCredentialsSource

Источник учетных данных Git. С течением времени могут добавляться дополнительные источники учетных данных Git.
GitHubDetails

Сведения о поставщике GitHub.
GitProviderType

Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.

AutomaticGitCredentials

Объект

Автоматические учетные данные Git.

Имя. Тип Описание
source string:

Automatic

Источник учетных данных Git.

AzureDevOpsDetails

Объект

Сведения о поставщике Azure DevOps.

Имя. Тип Описание
branchName

string

maxLength: 250

Имя ветви. Максимальная длина составляет 250 символов.
directoryName

string

maxLength: 256

Относительный путь к каталогу. Максимальная длина составляет 256 символов.
gitProviderType string:

AzureDevOps

Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.
organizationName

string

maxLength: 100

Имя организации. Максимальная длина — 100 символов.
projectName

string

maxLength: 100

Имя проекта. Максимальная длина — 100 символов.
repositoryName

string

maxLength: 128

Имя репозитория. Максимальная длина — 128 символов.

ConfiguredConnectionGitCredentials

Объект

Настроенные учетные данные подключения Git.

Имя. Тип Описание
connectionId

string (uuid)

Идентификатор объекта подключения.
source string:

ConfiguredConnection

Источник учетных данных Git.

ErrorParameter

Объект

Структурированный параметр, предоставляющий дополнительный контекст, доступный для чтения компьютера, об ошибке.

Имя. Тип Описание
message

string

Читаемое человеком описание значения параметра.
name

string

Идентификатор параметра.
value

string

Значение параметра.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя. Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя. Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
parameters

ErrorParameter[]

Структурированные параметры, предоставляющие дополнительный контекст, доступный для чтения компьютера, об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя. Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
parameters

ErrorParameter[]

Структурированные параметры, предоставляющие дополнительный контекст, доступный для чтения компьютера, об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

GitAdditionalBranchChangingRoles

Перечисление

Дополнительные роли рабочей области за пределами администратора, которые могут изменять подключенную ветвь Git. С течением времени могут добавляться дополнительные значения.

Значение Описание
None

Дополнительные роли, кроме администратора, не могут изменять ветви. Это значение по умолчанию.
MemberAndContributor

Члены и участники также могут изменять ветви в дополнение к администраторам.

GitConnectionSettings

Объект

Содержит параметры подключения Git.

Имя. Тип Описание
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

Дополнительные роли рабочей области за пределами администратора, которые могут изменять подключенную ветвь Git.

GitConnectRequest

Объект

Содержит данные запроса Git connect.

Имя. Тип Описание
connectionSettings

GitConnectionSettings

Необязательные параметры подключения, применяемые во время подключения. Если опущено, применяются значения по умолчанию.
gitProviderDetails GitProviderDetails:

Сведения о поставщике Git.
myGitCredentials GitCredentials:

Учетные данные Git для проверки подлинности в GitProvider. Эти учетные данные не предоставляются другим участникам рабочей области. Для GitHub это свойство является обязательным. Для AzureDevOps это свойство является необязательным. Если значение не задано, значение по умолчанию — AutomaticGitCredentials.

GitCredentialsSource

Перечисление

Источник учетных данных Git. С течением времени могут добавляться дополнительные источники учетных данных Git.

Значение Описание
ConfiguredConnection

Учетные данные Git получаются через настроенное подключение.
Automatic

Учетные данные Git автоматически получаются системой, используя учетные данные по умолчанию, если они доступны.
None

Учетные данные Git не настроены.

GitHubDetails

Объект

Сведения о поставщике GitHub.

Имя. Тип Описание
branchName

string

maxLength: 250

Имя ветви. Максимальная длина составляет 250 символов.
customDomainName

string

maxLength: 100

Имя домена корпоративного GitHub, если оно не github.com. Поддерживаются только GitHub Enterprise с доменами расположения данных (ghe.com). Максимальная длина — 100 символов.
directoryName

string

maxLength: 256

Относительный путь к каталогу. Максимальная длина составляет 256 символов.
gitProviderType string:

GitHub

Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.
ownerName

string

maxLength: 100

Имя владельца. Максимальная длина — 100 символов.
repositoryName

string

maxLength: 128

Имя репозитория. Максимальная длина — 128 символов.

GitProviderType

Перечисление

Тип поставщика Git. С течением времени могут добавляться дополнительные типы поставщиков.

Значение Описание
AzureDevOps

Поставщик Azure DevOps
GitHub

Поставщик GitHub