az automation source-control

Reference

Note

This reference is part of the automation extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az automation source-control command. Learn more about extensions.

Manage source control.

Commands

Name	Description	Type	Status
az automation source-control create	Create a source control.	Extension	GA
az automation source-control delete	Delete the source control.	Extension	GA
az automation source-control list	List a list of source controls.	Extension	GA
az automation source-control show	Get the source control identified by source control name.	Extension	GA
az automation source-control sync-job	Manage source control sync jobs.	Extension	GA
az automation source-control sync-job create	Create the sync job for a source control.	Extension	GA
az automation source-control sync-job list	List a list of source control sync jobs.	Extension	GA
az automation source-control sync-job show	Get the source control sync job identified by job id.	Extension	GA
az automation source-control sync-job stream	Manage sync job stream.	Extension	GA
az automation source-control sync-job stream list	List a list of sync job streams identified by sync job id.	Extension	GA
az automation source-control sync-job stream show	Get a sync job stream identified by stream id.	Extension	GA
az automation source-control sync-job update	Update the sync job for a source control.	Extension	GA
az automation source-control update	Update a source control.	Extension	GA

az automation source-control create

Create a source control.

az automation source-control create --account
                                    --name
                                    --resource-group
                                    [--access-token]
                                    [--auto-sync {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--branch]
                                    [--description]
                                    [--folder-path]
                                    [--publish-runbook {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--refresh-token]
                                    [--repo-url]
                                    [--source-type {GitHub, VsoGit, VsoTfvc}]
                                    [--token-type {Oauth, PersonalAccessToken}]

Examples

Create source control

az automation source-control create -g rg --automation-account-name myAutomationAccount --name source-control --repo-url https://github.com/myAccount/myRepo.git --branch master --source-type GitHub --folder-path / --access-token ghp_MOCKED_GITHUB_TOKEN --token-type PersonalAccessToken --publish-runbook false

Required Parameters

--account --automation-account-name

The name of the automation account.

--name --source-control-name -n

The source control name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--access-token

The access token.

--auto-sync

The auto async of the source control. Default is false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--branch

The repo branch of the source control. Include branch as empty string for VsoTfvc.

--description

The user description of the source control.

--folder-path

The folder path of the source control. Path must be relative.

--publish-runbook

The auto publish of the source control. Default is true.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--refresh-token

The refresh token.

--repo-url

The repo url of the source control.

--source-type

The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.

Accepted values: GitHub, VsoGit, VsoTfvc

--token-type

The token type. Must be either PersonalAccessToken or Oauth.

Accepted values: Oauth, PersonalAccessToken

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation source-control delete

Delete the source control.

az automation source-control delete [--account]
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete the source control

az automation source-control delete -g rg --automation-account-name myAutomationAccount --name sourceControl -y

Optional Parameters

--account --automation-account-name

The name of the automation account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --source-control-name -n

The name of source control.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation source-control list

List a list of source controls.

az automation source-control list --account
                                  --resource-group
                                  [--filter]
                                  [--max-items]
                                  [--next-token]

Examples

List source control

az automation source-control list -g rg --automation-account-name myAutomationAccount

Required Parameters

--account --automation-account-name

The name of the automation account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--filter

The filter to apply on the operation.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation source-control show

Get the source control identified by source control name.

az automation source-control show [--account]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Get information about the source control

az automation source-control show -g rg --automation-account-name myAutomationAccount --name sourceControl

Optional Parameters

--account --automation-account-name

The name of the automation account.

--ids

--name --source-control-name -n

The name of source control.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation source-control update

Update a source control.

az automation source-control update [--access-token]
                                    [--account]
                                    [--add]
                                    [--auto-sync {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--branch]
                                    [--description]
                                    [--folder-path]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--name]
                                    [--publish-runbook {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--refresh-token]
                                    [--remove]
                                    [--repo-url]
                                    [--resource-group]
                                    [--set]
                                    [--source-type {GitHub, VsoGit, VsoTfvc}]
                                    [--subscription]
                                    [--token-type {Oauth, PersonalAccessToken}]

Examples

Update source control properties

az automation source-control update -g rg --automation-account-name myAutomationAccount --name sourceControl --access-token ghp_GITHUB_TOKEN --token-type PersonalAccessToken --publish-runbook True

Optional Parameters

--access-token

The access token.

--account --automation-account-name

The name of the automation account.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--auto-sync

The auto async of the source control. Default is false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--branch

The repo branch of the source control. Include branch as empty string for VsoTfvc.

--description

The user description of the source control.

--folder-path

The folder path of the source control. Path must be relative.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--name --source-control-name -n

The name of source control.

--publish-runbook

The auto publish of the source control. Default is true.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--refresh-token

The refresh token.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--repo-url

The repo url of the source control.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--source-type

The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.

Accepted values: GitHub, VsoGit, VsoTfvc

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--token-type

The token type. Must be either PersonalAccessToken or Oauth.

Accepted values: Oauth, PersonalAccessToken

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via

az automation source-control

Commands

az automation source-control create

Examples

Required Parameters

Optional Parameters

az automation source-control delete

Examples

Optional Parameters

az automation source-control list

Examples

Required Parameters

Optional Parameters

az automation source-control show

Examples

Optional Parameters

az automation source-control update

Examples

Optional Parameters

Additional resources