Source Control - Update

Hizmet:

Automation

API Sürümü:

2024-10-23

Kaynak denetimini güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
automationAccountName	path	True	string	Otomasyon hesabının adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
sourceControlName	path	True	string	Kaynak denetiminin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.autoSync	boolean	Kaynak denetiminin otomatik olarak eşitlenmesi. Varsayılan değer false'tur.
properties.branch	string	Kaynak denetiminin depo dalı.
properties.description	string	Kaynak denetimin kullanıcı açıklaması.
properties.folderPath	string	Kaynak denetimin klasör yolu. Yol göreli olmalıdır.
properties.publishRunbook	boolean	Kaynak denetiminin otomatik olarak yayımlanması. Varsayılan değer doğrudur
properties.securityToken	SourceControlSecurityTokenProperties	Kaynak denetiminin deposu için yetkilendirme belirteci.

Yanıtlar

Name	Tür	Description
200 OK	SourceControl	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Update a source control

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
SourceControl	Kaynak denetiminin tanımı.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Güncelleştirme kaynağı denetim işlemine sağlanan parametreler.
SourceType	Kaynak türü. VsoGit, VsoTfvc, GitHub'dan biri olmalıdır.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
TokenType	Jeton türü. PersonalAccessToken veya Oauth olmalıdır.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

SourceControl

Nesne

Kaynak denetiminin tanımı.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.autoSync	boolean	Kaynak denetiminin otomatik olarak eşitlenmesi. Varsayılan değer false'tur.
properties.branch	string	Kaynak denetiminin depo dalı. VsoTfvc için boş dize olarak dal ekleyin.
properties.creationTime	string (date-time)	Oluşturma zamanı.
properties.description	string	Açıklama.
properties.folderPath	string	Kaynak denetimin klasör yolu.
properties.lastModifiedTime	string (date-time)	Son değiştirme zamanı.
properties.publishRunbook	boolean	Kaynak denetiminin otomatik olarak yayımlanması. Varsayılan değer doğrudur
properties.repoUrl	string	Kaynak denetiminin depo url'si.
properties.sourceType	SourceType	Kaynak türü. VsoGit, VsoTfvc, GitHub'dan biri olmalıdır.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

SourceControlSecurityTokenProperties

Nesne

Name	Tür	Description
accessToken	string maxLength: 1024	Erişim belirteci.
refreshToken	string maxLength: 1024	Yenileme belirteci.
tokenType	TokenType	Jeton türü. PersonalAccessToken veya Oauth olmalıdır.

SourceControlUpdateParameters

Nesne

Güncelleştirme kaynağı denetim işlemine sağlanan parametreler.

Name	Tür	Description
properties.autoSync	boolean	Kaynak denetiminin otomatik olarak eşitlenmesi. Varsayılan değer false'tur.
properties.branch	string	Kaynak denetiminin depo dalı.
properties.description	string	Kaynak denetimin kullanıcı açıklaması.
properties.folderPath	string	Kaynak denetimin klasör yolu. Yol göreli olmalıdır.
properties.publishRunbook	boolean	Kaynak denetiminin otomatik olarak yayımlanması. Varsayılan değer doğrudur
properties.securityToken	SourceControlSecurityTokenProperties	Kaynak denetiminin deposu için yetkilendirme belirteci.

SourceType

Numaralandırma

Kaynak türü. VsoGit, VsoTfvc, GitHub'dan biri olmalıdır.

Değer	Description
VsoGit	VsoGit
VsoTfvc	VsoTfvc
GitHub	GitHub (İngilizce)

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

TokenType

Numaralandırma

Jeton türü. PersonalAccessToken veya Oauth olmalıdır.

Değer	Description
PersonalAccessToken	PersonalAccessToken
Oauth	Oauth