Source Control - Update

Référence

Service:: Automation

Version d'API:: 2023-11-01

Mettre à jour un contrôle de code source.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure. Modèle d’expression régulière: `^[-\w\._]+$`
sourceControlName	path	True	string	Nom du contrôle de code source.
subscriptionId	path	True	string	Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
properties.autoSync	boolean	Synchronisation automatique du contrôle de code source. La valeur par défaut est false.
properties.branch	string	Branche de dépôt du contrôle de code source.
properties.description	string	Description utilisateur du contrôle de code source.
properties.folderPath	string	Chemin du dossier du contrôle de code source. Le chemin d’accès doit être relatif.
properties.publishRunbook	boolean	Publication automatique du contrôle de code source. La valeur par défaut est true.
properties.securityToken	SourceControlSecurityTokenProperties	Jeton d’autorisation pour le référentiel du contrôle de code source.

Réponses

Nom	Type	Description
200 OK	SourceControl	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur Automation décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Update a source control

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur d’un échec d’opération
SourceControl	Définition du contrôle de code source.
SourceControlSecurityTokenProperties
SourceControlUpdateParameters	Paramètres fournis à l’opération de mise à jour du contrôle de code source.
sourceType	Type de source. Doit être l’un de VsoGit, VsoTfvc, GitHub.
tokenType	Type de jeton. Doit être PersonalAccessToken ou Oauth.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

SourceControl

Définition du contrôle de code source.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource
name	string	nom de la ressource.
properties.autoSync	boolean	Synchronisation automatique du contrôle de code source. La valeur par défaut est false.
properties.branch	string	Branche de dépôt du contrôle de code source. Incluez la branche en tant que chaîne vide pour VsoTfvc.
properties.creationTime	string	Heure de création.
properties.description	string	Description.
properties.folderPath	string	Chemin du dossier du contrôle de code source.
properties.lastModifiedTime	string	Heure de la dernière modification.
properties.publishRunbook	boolean	Publication automatique du contrôle de code source. La valeur par défaut est true.
properties.repoUrl	string	URL du référentiel du contrôle de code source.
properties.sourceType	sourceType	Type de source. Doit être l’un de VsoGit, VsoTfvc, GitHub.
type	string	Type de la ressource.

SourceControlSecurityTokenProperties

Nom	Type	Description
accessToken	string	Jeton d’accès.
refreshToken	string	Le jeton d’actualisation.
tokenType	tokenType	Type de jeton. Doit être PersonalAccessToken ou Oauth.

SourceControlUpdateParameters

Paramètres fournis à l’opération de mise à jour du contrôle de code source.

Nom	Type	Description
properties.autoSync	boolean	Synchronisation automatique du contrôle de code source. La valeur par défaut est false.
properties.branch	string	Branche de dépôt du contrôle de code source.
properties.description	string	Description utilisateur du contrôle de code source.
properties.folderPath	string	Chemin du dossier du contrôle de code source. Le chemin d’accès doit être relatif.
properties.publishRunbook	boolean	Publication automatique du contrôle de code source. La valeur par défaut est true.
properties.securityToken	SourceControlSecurityTokenProperties	Jeton d’autorisation pour le référentiel du contrôle de code source.

sourceType

Type de source. Doit être l’un de VsoGit, VsoTfvc, GitHub.

Nom	Type	Description
GitHub	string
VsoGit	string
VsoTfvc	string

tokenType

Type de jeton. Doit être PersonalAccessToken ou Oauth.

Nom	Type	Description
Oauth	string
PersonalAccessToken	string

Partager via