Source Control - Update

Ссылка

Служба:: Automation

Версия API:: 2023-11-01

Обновление системы управления версиями.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}?api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string	Имя группы ресурсов Azure. Шаблон регулярного выражения: `^[-\w\._]+$`
sourceControlName	path	True	string	Имя системы управления версиями.
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

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

Имя	Тип	Описание
properties.autoSync	boolean	Автоматическая синхронизация системы управления версиями. Значение по умолчанию — false.
properties.branch	string	Ветвь репозитория системы управления версиями.
properties.description	string	Описание пользователя системы управления версиями.
properties.folderPath	string	Путь к папке системы управления версиями. Путь должен быть относительным.
properties.publishRunbook	boolean	Автоматическая публикация системы управления версиями. Значение по умолчанию — true.
properties.securityToken	SourceControlSecurityTokenProperties	Маркер авторизации для репозитория системы управления версиями.

Ответы

Имя	Тип	Описание
200 OK	SourceControl	ОК
Other Status Codes	ErrorResponse	Ответ об ошибке автоматизации, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update a source control

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

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourceControls/sampleSourceControl?api-version=2023-11-01

{
  "properties": {
    "branch": "master",
    "folderPath": "/folderOne/folderTwo",
    "autoSync": true,
    "publishRunbook": true,
    "securityToken": {
      "accessToken": "******",
      "tokenType": "PersonalAccessToken"
    },
    "description": "my description"
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl",
  "name": "sampleSourceControl",
  "properties": {
    "creationTime": "2017-03-28T22:59:00.937+00:00",
    "lastModifiedTime": "2017-03-28T22:59:00.937+00:00",
    "repoUrl": "https://sampleUser.visualstudio.com/myProject/_git/myRepository",
    "branch": "master",
    "folderPath": "/folderOne/folderTwo",
    "autoSync": true,
    "publishRunbook": true,
    "sourceType": "VsoGit",
    "description": "my description"
  }
}

Определения

Имя	Описание
ErrorResponse	Ответ об ошибке при сбое операции
SourceControl	Определение системы управления версиями.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Параметры, предоставленные для операции обновления системы управления версиями.
sourceType	Тип источника данных. Должен быть одним из vsoGit, VsoTfvc, GitHub.
tokenType	Тип токена. Должен иметь значение PersonalAccessToken или Oauth.

ErrorResponse

Ответ об ошибке при сбое операции

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

SourceControl

Определение системы управления версиями.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса
name	string	Имя ресурса.
properties.autoSync	boolean	Автоматическая синхронизация системы управления версиями. Значение по умолчанию — false.
properties.branch	string	Ветвь репозитория системы управления версиями. Включите ветвь как пустую строку для VsoTfvc.
properties.creationTime	string	Время создания.
properties.description	string	Описание.
properties.folderPath	string	Путь к папке системы управления версиями.
properties.lastModifiedTime	string	Время последнего изменения.
properties.publishRunbook	boolean	Автоматическая публикация системы управления версиями. Значение по умолчанию — true.
properties.repoUrl	string	URL-адрес репозитория системы управления версиями.
properties.sourceType	sourceType	Тип источника данных. Должен быть одним из vsoGit, VsoTfvc, GitHub.
type	string	Тип ресурса.

SourceControlSecurityTokenProperties

Имя	Тип	Описание
accessToken	string	Маркер доступа.
refreshToken	string	Маркер обновления.
tokenType	tokenType	Тип токена. Должен иметь значение PersonalAccessToken или Oauth.

SourceControlUpdateParameters

Параметры, предоставленные для операции обновления системы управления версиями.

Имя	Тип	Описание
properties.autoSync	boolean	Автоматическая синхронизация системы управления версиями. Значение по умолчанию — false.
properties.branch	string	Ветвь репозитория системы управления версиями.
properties.description	string	Описание пользователя системы управления версиями.
properties.folderPath	string	Путь к папке системы управления версиями. Путь должен быть относительным.
properties.publishRunbook	boolean	Автоматическая публикация системы управления версиями. Значение по умолчанию — true.
properties.securityToken	SourceControlSecurityTokenProperties	Маркер авторизации для репозитория системы управления версиями.

sourceType

Тип источника данных. Должен быть одним из vsoGit, VsoTfvc, GitHub.

Имя	Тип	Описание
GitHub	string
VsoGit	string
VsoTfvc	string

tokenType

Тип токена. Должен иметь значение PersonalAccessToken или Oauth.

Имя	Тип	Описание
Oauth	string
PersonalAccessToken	string

Поделиться через