Source Control - Update
更新源代码管理。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}?api-version=2024-10-23
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
automation
|
path | True |
string |
自动化帐户的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
source
|
path | True |
string |
源代码管理的名称。 |
|
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.autoSync |
boolean |
源代码管理自动同步。 默认值为 false。 |
| properties.branch |
string |
源代码管理的存储库分支。 |
| properties.description |
string |
源代码管理的用户说明。 |
| properties.folderPath |
string |
源代码管理的文件夹路径。 路径必须是相对路径。 |
| properties.publishRunbook |
boolean |
源代码管理自动发布。 默认值为 true。 |
| properties.securityToken |
源代码管理存储库的授权令牌。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
Azure 运营顺利完成。 |
|
| Other Status Codes |
意外的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流程。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
Update a source control
示例请求
PATCH https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourceControls/sampleSourceControl?api-version=2024-10-23
{
"properties": {
"description": "my description",
"autoSync": true,
"branch": "master",
"folderPath": "/folderOne/folderTwo",
"publishRunbook": true,
"securityToken": {
"accessToken": "******",
"tokenType": "PersonalAccessToken"
}
}
}
示例响应
{
"name": "sampleSourceControl",
"id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl",
"properties": {
"description": "my description",
"autoSync": true,
"branch": "master",
"creationTime": "2017-03-28T22:59:00.937+00:00",
"folderPath": "/folderOne/folderTwo",
"lastModifiedTime": "2017-03-28T22:59:00.937+00:00",
"publishRunbook": true,
"repoUrl": "https://sampleUser.visualstudio.com/myProject/_git/myRepository",
"sourceType": "VsoGit"
}
}
定义
| 名称 | 说明 |
|---|---|
|
created |
创建资源的标识的类型。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Source |
源代码管理的定义。 |
|
Source |
|
|
Source |
提供给更新源代码管理作的参数。 |
|
Source |
源类型。 必须是 VsoGit、VsoTfvc、GitHub 之一。 |
|
system |
与创建和上次修改资源相关的元数据。 |
|
Token |
令牌类型。 必须是 PersonalAccessToken 或 Oauth。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
附加信息。 |
| type |
string |
附加信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
SourceControl
源代码管理的定义。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string (arm-id) |
资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
| name |
string |
资源的名称 |
| properties.autoSync |
boolean |
源代码管理自动同步。 默认值为 false。 |
| properties.branch |
string |
源代码管理的存储库分支。 将分支作为 VsoTfvc 的空字符串包含在内。 |
| properties.creationTime |
string (date-time) |
创建时间。 |
| properties.description |
string |
说明。 |
| properties.folderPath |
string |
源代码管理的文件夹路径。 |
| properties.lastModifiedTime |
string (date-time) |
上次修改时间。 |
| properties.publishRunbook |
boolean |
源代码管理自动发布。 默认值为 true。 |
| properties.repoUrl |
string |
源代码管理的存储库 URL。 |
| properties.sourceType |
源类型。 必须是 VsoGit、VsoTfvc、GitHub 之一。 |
|
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
| type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
SourceControlSecurityTokenProperties
| 名称 | 类型 | 说明 |
|---|---|---|
| accessToken |
string maxLength: 1024 |
访问令牌。 |
| refreshToken |
string maxLength: 1024 |
刷新令牌。 |
| tokenType |
令牌类型。 必须是 PersonalAccessToken 或 Oauth。 |
SourceControlUpdateParameters
提供给更新源代码管理作的参数。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.autoSync |
boolean |
源代码管理自动同步。 默认值为 false。 |
| properties.branch |
string |
源代码管理的存储库分支。 |
| properties.description |
string |
源代码管理的用户说明。 |
| properties.folderPath |
string |
源代码管理的文件夹路径。 路径必须是相对路径。 |
| properties.publishRunbook |
boolean |
源代码管理自动发布。 默认值为 true。 |
| properties.securityToken |
源代码管理存储库的授权令牌。 |
SourceType
源类型。 必须是 VsoGit、VsoTfvc、GitHub 之一。
| 值 | 说明 |
|---|---|
| VsoGit |
VsoGit |
| VsoTfvc |
VsoTfvc |
| GitHub |
GitHub |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |
TokenType
令牌类型。 必须是 PersonalAccessToken 或 Oauth。
| 值 | 说明 |
|---|---|
| PersonalAccessToken |
个人访问令牌 |
| Oauth |
Oauth |