Source Control - Update

Service:: Automation

Version d'API:: 2024-10-23

Mettez à 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=2024-10-23

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nom d’un groupe de ressources Azure.
sourceControlName	path	True	string	Nom du contrôle de code source.
subscriptionId	path	True	string	Obtient les informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. 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 de l’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 dépôt 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 pourquoi l’opération a échoué.

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=2024-10-23

{
  "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
createdByType	Type d’identité qui a créé la ressource.
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 contrôle de code source de mise à jour.
sourceType	Type de source. Doit être l’un de VsoGit, VsoTfvc, GitHub.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tokenType	Type de jeton. Doit être PersonalAccessToken ou Oauth.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

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

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

SourceControl

Object

Définition du contrôle de code source.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
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. Inclure la branche en tant que chaîne vide pour VsoTfvc.
properties.creationTime	string (date-time)	Heure de création.
properties.description	string	Description.
properties.folderPath	string	Chemin du dossier du contrôle de code source.
properties.lastModifiedTime	string (date-time)	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 dépôt du contrôle de code source.
properties.sourceType	sourceType	Type de source. Doit être l’un de VsoGit, VsoTfvc, GitHub.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SourceControlSecurityTokenProperties

Object

Nom	Type	Description
accessToken	string maxLength: 1024	Jeton d’accès.
refreshToken	string maxLength: 1024	Jeton de rafraîchissement
tokenType	tokenType	Type de jeton. Doit être PersonalAccessToken ou Oauth.

SourceControlUpdateParameters

Object

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

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 de l’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 dépôt du contrôle de code source.

sourceType

Énumération

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

Valeur	Description
VsoGit
VsoTfvc
GitHub

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

tokenType

Énumération

Type de jeton. Doit être PersonalAccessToken ou Oauth.

Valeur	Description
PersonalAccessToken
Oauth

Partager via

Source Control - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Update a source control

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorResponse

SourceControl

SourceControlSecurityTokenProperties

SourceControlUpdateParameters

sourceType

systemData

tokenType