Share via

az sentinel source-control

  • Reference

Note

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

Manage source control with sentinel.

Commands

Name Description Type Status
az sentinel source-control create

Create a source control.

 Extension Experimental
az sentinel source-control delete

Delete a source control.

 Extension Experimental
az sentinel source-control list

Get all source controls, without source control items.

 Extension Experimental
az sentinel source-control list-repository

Get a list of repositories metadata.

 Extension Experimental
az sentinel source-control show

Get a source control by its identifier.

 Extension Experimental
az sentinel source-control update

Create a source control.

 Extension Experimental

az sentinel source-control create

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a source control.

az sentinel source-control create --name
                                  --resource-group
                                  --workspace-name
                                  [--content-types]
                                  [--description]
                                  [--display-name]
                                  [--etag]
                                  [--id]
                                  [--last-deployment-info]
                                  [--repo-type {DevOps, Github}]
                                  [--repository]
                                  [--repository-info]
                                  [--version {V1, V2}]

Required Parameters

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

Source control Id.

--resource-group -g

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

--workspace-name -w
Experimental

The name of the workspace.

Optional Parameters

--content-types

Array of source control content types. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

A description of the source control.

--display-name

The display name of the source control.

--etag

Etag of the azure resource.

--id

The id (a Guid) of the source control.

--last-deployment-info

Information regarding the latest deployment for the source control. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--repo-type

The repository type of the source control.

Accepted values: DevOps, Github
--repository

Repository metadata. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--repository-info

Information regarding the resources created in user's repository. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

The version number associated with the source control.

Accepted values: V1, V2
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 sentinel source-control delete

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a source control.

az sentinel source-control delete [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--workspace-name]
                                  [--yes]

Optional Parameters

--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-id -n

Source control Id.

--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.

--workspace-name -w
Experimental

The name of the workspace.

--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 sentinel source-control list

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get all source controls, without source control items.

az sentinel source-control list --resource-group
                                --workspace-name

Required Parameters

--resource-group -g

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

--workspace-name -w
Experimental

The name of the workspace.

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 sentinel source-control list-repository

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a list of repositories metadata.

az sentinel source-control list-repository --repo-type {DevOps, Github}
                                           --resource-group
                                           --workspace-name

Required Parameters

--repo-type

The type of repository.

Accepted values: DevOps, Github
--resource-group -g

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

--workspace-name -w
Experimental

The name of the workspace.

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 sentinel source-control show

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a source control by its identifier.

az sentinel source-control show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--workspace-name]

Optional Parameters

--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-id -n

Source control Id.

--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.

--workspace-name -w
Experimental

The name of the workspace.

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 sentinel source-control update

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a source control.

az sentinel source-control update [--add]
                                  [--content-types]
                                  [--description]
                                  [--display-name]
                                  [--etag]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--id]
                                  [--ids]
                                  [--last-deployment-info]
                                  [--name]
                                  [--remove]
                                  [--repo-type {DevOps, Github}]
                                  [--repository]
                                  [--repository-info]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--version {V1, V2}]
                                  [--workspace-name]

Optional Parameters

--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>.

--content-types

Array of source control content types. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

A description of the source control.

--display-name

The display name of the source control.

--etag

Etag of the azure resource.

--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
--id

The id (a Guid) of the source control.

--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.

--last-deployment-info

Information regarding the latest deployment for the source control. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Source control Id.

--remove

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

--repo-type

The repository type of the source control.

Accepted values: DevOps, Github
--repository

Repository metadata. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--repository-info

Information regarding the resources created in user's repository. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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>.

--subscription

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

--version

The version number associated with the source control.

Accepted values: V1, V2
--workspace-name -w
Experimental

The name of the workspace.

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.