Source Control - Update

Служба:

Automation

Версия API:

2024-10-23

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
sourceControlName	path	True	string	Имя системы управления версиями.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (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	Автоматическая публикация системы управления версиями. Значение по умолчанию — истинно.
properties.securityToken	SourceControlSecurityTokenProperties	Маркер авторизации для репозитория системы управления версиями.

Ответы

Имя	Тип	Описание
200 OK	SourceControl	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Update a source control

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

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python update_source_control_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.source_control.update(
        resource_group_name="rg",
        automation_account_name="sampleAccount9",
        source_control_name="sampleSourceControl",
        parameters={
            "properties": {
                "autoSync": True,
                "branch": "master",
                "description": "my description",
                "folderPath": "/folderOne/folderTwo",
                "publishRunbook": True,
                "securityToken": {"accessToken": "******", "tokenType": "PersonalAccessToken"},
            }
        },
    )
    print(response)


# x-ms-original-file: 2024-10-23/sourceControl/updateSourceControl_patch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: 2024-10-23/sourceControl/updateSourceControl_patch.json
func ExampleSourceControlClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSourceControlClient().Update(ctx, "rg", "sampleAccount9", "sampleSourceControl", armautomation.SourceControlUpdateParameters{
		Properties: &armautomation.SourceControlUpdateProperties{
			Description:    to.Ptr("my description"),
			AutoSync:       to.Ptr(true),
			Branch:         to.Ptr("master"),
			FolderPath:     to.Ptr("/folderOne/folderTwo"),
			PublishRunbook: to.Ptr(true),
			SecurityToken: &armautomation.SourceControlSecurityTokenProperties{
				AccessToken: to.Ptr("******"),
				TokenType:   to.Ptr(armautomation.TokenTypePersonalAccessToken),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armautomation.SourceControlClientUpdateResponse{
	// 	SourceControl: armautomation.SourceControl{
	// 		Name: to.Ptr("sampleSourceControl"),
	// 		ID: to.Ptr("/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl"),
	// 		Properties: &armautomation.SourceControlProperties{
	// 			Description: to.Ptr("my description"),
	// 			AutoSync: to.Ptr(true),
	// 			Branch: to.Ptr("master"),
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T22:59:00.937+00:00"); return t}()),
	// 			FolderPath: to.Ptr("/folderOne/folderTwo"),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T22:59:00.937+00:00"); return t}()),
	// 			PublishRunbook: to.Ptr(true),
	// 			RepoURL: to.Ptr("https://sampleUser.visualstudio.com/myProject/_git/myRepository"),
	// 			SourceType: to.Ptr(armautomation.SourceTypeVsoGit),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to update a source control.
 *
 * @summary update a source control.
 * x-ms-original-file: 2024-10-23/sourceControl/updateSourceControl_patch.json
 */
async function updateASourceControl() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.sourceControlOperations.update(
    "rg",
    "sampleAccount9",
    "sampleSourceControl",
    {
      description: "my description",
      autoSync: true,
      branch: "master",
      folderPath: "/folderOne/folderTwo",
      publishRunbook: true,
      securityToken: { accessToken: "******", tokenType: "PersonalAccessToken" },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

200

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

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
SourceControl	Определение системы управления версиями.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Параметры, предоставленные операции управления версиями обновления.
SourceType	Исходный тип. Должен быть одним из VsoGit, VsoTfvc, GitHub.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TokenType	Тип токена. Должно быть либо PersonalAccessToken, либо Oauth.

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SourceControl

Объект

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

Имя	Тип	Описание
id	string (arm-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	Автоматическая публикация системы управления версиями. Значение по умолчанию — истинно.
properties.repoUrl	string	URL-адрес репозитория системы управления версиями.
properties.sourceType	SourceType	Исходный тип. Должен быть одним из VsoGit, VsoTfvc, GitHub.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SourceControlSecurityTokenProperties

Объект

Имя	Тип	Описание
accessToken	string maxLength: 1024	Маркер доступа.
refreshToken	string maxLength: 1024	Токен обновления.
tokenType	TokenType	Тип токена. Должно быть либо PersonalAccessToken, либо Oauth.

SourceControlUpdateParameters

Объект

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

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

SourceType

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

Исходный тип. Должен быть одним из VsoGit, VsoTfvc, GitHub.

Значение	Описание
VsoGit	VsoGit
VsoTfvc	VsoTfvc
GitHub	GitHub

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TokenType

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

Тип токена. Должно быть либо PersonalAccessToken, либо Oauth.

Значение	Описание
PersonalAccessToken	PersonalAccessToken
Oauth	Oauth