Source Control - Update

Dienst:: Automation

API-Version:: 2024-10-23

Aktualisieren eines Quellcodeverwaltungssteuerelements.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automatisierungskontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
sourceControlName	path	True	string	Der Name der Quellcodeverwaltung.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.autoSync	boolean	Die automatische Synchronisierung der Quellcodeverwaltung. Der Standardwert ist "false".
properties.branch	string	Der Repository-Verzweigung der Quellcodeverwaltung.
properties.description	string	Die Benutzerbeschreibung der Quellcodeverwaltung.
properties.folderPath	string	Der Ordnerpfad der Quellcodeverwaltung. Der Pfad muss relativ sein.
properties.publishRunbook	boolean	Die automatische Veröffentlichung der Quellcodeverwaltung. Der Standardwert ist "true".
properties.securityToken	SourceControlSecurityTokenProperties	Das Autorisierungstoken für das Repository der Quellcodeverwaltung.

Antworten

Name	Typ	Beschreibung
200 OK	SourceControl	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update a source control

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SourceControl	Definition der Quellcodeverwaltung.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Die Parameter, die für den Update-Quellcodeverwaltungsvorgang bereitgestellt werden.
SourceType	Der Quelltyp. Muss eine von VsoGit, VsoTfvc, GitHub sein.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TokenType	Der Tokentyp. Muss entweder PersonalAccessToken oder Oauth sein.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SourceControl

Objekt

Definition der Quellcodeverwaltung.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.autoSync	boolean	Die automatische Synchronisierung der Quellcodeverwaltung. Der Standardwert ist "false".
properties.branch	string	Der Repository-Verzweigung der Quellcodeverwaltung. Verzweigung als leere Zeichenfolge für VsoTfvc einschließen.
properties.creationTime	string (date-time)	Die Erstellungszeit.
properties.description	string	Die Beschreibung.
properties.folderPath	string	Der Ordnerpfad der Quellcodeverwaltung.
properties.lastModifiedTime	string (date-time)	Die Uhrzeit der letzten Änderung.
properties.publishRunbook	boolean	Die automatische Veröffentlichung der Quellcodeverwaltung. Der Standardwert ist "true".
properties.repoUrl	string	Die Repository-URL des Quellcodeverwaltungs.
properties.sourceType	SourceType	Der Quelltyp. Muss eine von VsoGit, VsoTfvc, GitHub sein.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SourceControlSecurityTokenProperties

Objekt

Name	Typ	Beschreibung
accessToken	string maxLength: 1024	Das Zugriffstoken.
refreshToken	string maxLength: 1024	Der Aktualisierungs-Token.
tokenType	TokenType	Der Tokentyp. Muss entweder PersonalAccessToken oder Oauth sein.

SourceControlUpdateParameters

Objekt

Die Parameter, die für den Update-Quellcodeverwaltungsvorgang bereitgestellt werden.

Name	Typ	Beschreibung
properties.autoSync	boolean	Die automatische Synchronisierung der Quellcodeverwaltung. Der Standardwert ist "false".
properties.branch	string	Der Repository-Verzweigung der Quellcodeverwaltung.
properties.description	string	Die Benutzerbeschreibung der Quellcodeverwaltung.
properties.folderPath	string	Der Ordnerpfad der Quellcodeverwaltung. Der Pfad muss relativ sein.
properties.publishRunbook	boolean	Die automatische Veröffentlichung der Quellcodeverwaltung. Der Standardwert ist "true".
properties.securityToken	SourceControlSecurityTokenProperties	Das Autorisierungstoken für das Repository der Quellcodeverwaltung.

SourceType

Enumeration

Der Quelltyp. Muss eine von VsoGit, VsoTfvc, GitHub sein.

Wert	Beschreibung
VsoGit	VsoGit
VsoTfvc	VsoTfvc
GitHub	GitHub

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TokenType

Enumeration

Der Tokentyp. Muss entweder PersonalAccessToken oder Oauth sein.

Wert	Beschreibung
PersonalAccessToken	PersonalAccessToken
Oauth	Oauth

Freigeben über

Source Control - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Update a source control

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SourceControl

SourceControlSecurityTokenProperties

SourceControlUpdateParameters

SourceType

systemData

TokenType