Source Control - Update

Služba:: Automation

Verze rozhraní API:: 2024-10-23

Aktualizace správy zdrojového kódu

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationAccountName	path	True	string	Název účtu Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Název skupiny prostředků Azure
sourceControlName	path	True	string	Název správy zdrojového kódu.
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
properties.autoSync	boolean	Automatická synchronizace správy zdrojového kódu. Výchozí hodnota je False.
properties.branch	string	Větev úložiště správy zdrojového kódu.
properties.description	string	Popis uživatele správy zdrojového kódu.
properties.folderPath	string	Cesta ke složce správy zdrojového kódu. Cesta musí být relativní.
properties.publishRunbook	boolean	Automatické publikování správy zdrojového kódu. Výchozí hodnota je true.
properties.securityToken	SourceControlSecurityTokenProperties	Autorizační token pro úložiště správy zdrojového kódu.

Odpovědi

Name	Typ	Description
200 OK	SourceControl	OK
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update a source control

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorResponse	Chybová odpověď selhání operace
SourceControl	Definice správy zdrojového kódu
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Parametry zadané pro operaci správy zdrojového kódu aktualizace.
sourceType	Typ zdroje. Musí to být jeden z VsoGit, VsoTfvc, GitHub.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
tokenType	Typ tokenu. Musí to být PersonalAccessToken nebo Oauth.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Chybová odpověď selhání operace

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

SourceControl

Objekt

Definice správy zdrojového kódu

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.autoSync	boolean	Automatická synchronizace správy zdrojového kódu. Výchozí hodnota je False.
properties.branch	string	Větev úložiště správy zdrojového kódu. Zahrňte větev jako prázdný řetězec pro VsoTfvc.
properties.creationTime	string (date-time)	Čas vytvoření.
properties.description	string	Popis.
properties.folderPath	string	Cesta ke složce správy zdrojového kódu.
properties.lastModifiedTime	string (date-time)	Čas poslední změny.
properties.publishRunbook	boolean	Automatické publikování správy zdrojového kódu. Výchozí hodnota je true.
properties.repoUrl	string	Adresa URL úložiště správy zdrojového kódu.
properties.sourceType	sourceType	Typ zdroje. Musí to být jeden z VsoGit, VsoTfvc, GitHub.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SourceControlSecurityTokenProperties

Objekt

Name	Typ	Description
accessToken	string maxLength: 1024	Přístupový token.
refreshToken	string maxLength: 1024	Obnovovací token.
tokenType	tokenType	Typ tokenu. Musí to být PersonalAccessToken nebo Oauth.

SourceControlUpdateParameters

Objekt

Parametry zadané pro operaci správy zdrojového kódu aktualizace.

Name	Typ	Description
properties.autoSync	boolean	Automatická synchronizace správy zdrojového kódu. Výchozí hodnota je False.
properties.branch	string	Větev úložiště správy zdrojového kódu.
properties.description	string	Popis uživatele správy zdrojového kódu.
properties.folderPath	string	Cesta ke složce správy zdrojového kódu. Cesta musí být relativní.
properties.publishRunbook	boolean	Automatické publikování správy zdrojového kódu. Výchozí hodnota je true.
properties.securityToken	SourceControlSecurityTokenProperties	Autorizační token pro úložiště správy zdrojového kódu.

sourceType

Výčet

Typ zdroje. Musí to být jeden z VsoGit, VsoTfvc, GitHub.

Hodnota	Description
VsoGit
VsoTfvc
GitHub

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

tokenType

Výčet

Typ tokenu. Musí to být PersonalAccessToken nebo Oauth.

Hodnota	Description
PersonalAccessToken
Oauth

Sdílet prostřednictvím

Source Control - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Update a source control

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

ErrorResponse

SourceControl

SourceControlSecurityTokenProperties

SourceControlUpdateParameters

sourceType

systemData

tokenType