Source Control - Update

Tjänst:: Automation

API-version:: 2024-10-23

Uppdatera en källkontroll.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
automationAccountName	path	True	string	Namnet på automationskontot.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på en Azure-resursgrupp.
sourceControlName	path	True	string	Källkontrollnamnet.
subscriptionId	path	True	string	Hämtar prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
properties.autoSync	boolean	Automatisk synkronisering av källkontrollen. Standardvärdet är false.
properties.branch	string	Källkontrollens lagringsplatsgren.
properties.description	string	Användarbeskrivningen för källkontrollen.
properties.folderPath	string	Källkontrollens mappsökväg. Sökvägen måste vara relativ.
properties.publishRunbook	boolean	Automatisk publicering av källkontrollen. Standardvärdet är sant.
properties.securityToken	SourceControlSecurityTokenProperties	Auktoriseringstoken för lagringsplatsen för källkontrollen.

Svar

Name	Typ	Description
200 OK	SourceControl	OKEJ
Other Status Codes	ErrorResponse	Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Update a source control

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorResponse	Felsvar på ett åtgärdsfel
SourceControl	Definition av källkontrollen.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Parametrarna som angetts för uppdateringskällans kontrollåtgärd.
sourceType	Källtypen. Måste vara en av VsoGit, VsoTfvc, GitHub.
systemData	Metadata som rör skapande och senaste ändring av resursen.
tokenType	Tokentypen. Måste vara antingen PersonalAccessToken eller Oauth.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Felsvar på ett åtgärdsfel

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

SourceControl

Objekt

Definition av källkontrollen.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.autoSync	boolean	Automatisk synkronisering av källkontrollen. Standardvärdet är false.
properties.branch	string	Källkontrollens lagringsplatsgren. Inkludera gren som tom sträng för VsoTfvc.
properties.creationTime	string (date-time)	Skapandetiden.
properties.description	string	Beskrivningen.
properties.folderPath	string	Källkontrollens mappsökväg.
properties.lastModifiedTime	string (date-time)	Den senaste ändrade tiden.
properties.publishRunbook	boolean	Automatisk publicering av källkontrollen. Standardvärdet är sant.
properties.repoUrl	string	Källkontrollens lagringsplats-URL.
properties.sourceType	sourceType	Källtypen. Måste vara en av VsoGit, VsoTfvc, GitHub.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SourceControlSecurityTokenProperties

Objekt

Name	Typ	Description
accessToken	string maxLength: 1024	Åtkomsttoken.
refreshToken	string maxLength: 1024	Uppdaterings-token.
tokenType	tokenType	Tokentypen. Måste vara antingen PersonalAccessToken eller Oauth.

SourceControlUpdateParameters

Objekt

Parametrarna som angetts för uppdateringskällans kontrollåtgärd.

Name	Typ	Description
properties.autoSync	boolean	Automatisk synkronisering av källkontrollen. Standardvärdet är false.
properties.branch	string	Källkontrollens lagringsplatsgren.
properties.description	string	Användarbeskrivningen för källkontrollen.
properties.folderPath	string	Källkontrollens mappsökväg. Sökvägen måste vara relativ.
properties.publishRunbook	boolean	Automatisk publicering av källkontrollen. Standardvärdet är sant.
properties.securityToken	SourceControlSecurityTokenProperties	Auktoriseringstoken för lagringsplatsen för källkontrollen.

sourceType

Uppräkning

Källtypen. Måste vara en av VsoGit, VsoTfvc, GitHub.

Värde	Description
VsoGit
VsoTfvc
GitHub

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

tokenType

Uppräkning

Tokentypen. Måste vara antingen PersonalAccessToken eller Oauth.

Värde	Description
PersonalAccessToken
Oauth

Dela via

Source Control - Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Update a source control

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorResponse

SourceControl

SourceControlSecurityTokenProperties

SourceControlUpdateParameters

sourceType

systemData

tokenType