Share via

az sentinel source-control

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--content-types

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

Property Value
Parameter group: Properties Arguments
--description

A description of the source control.

Property Value
Parameter group: Properties Arguments
--display-name

The display name of the source control.

Property Value
Parameter group: Properties Arguments
--etag

Etag of the azure resource.

Property Value
Parameter group: SourceControl Arguments
--id

The id (a Guid) of the source control.

Property Value
Parameter group: Properties 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.

Property Value
Parameter group: Properties Arguments
--repo-type

The repository type of the source control.

Property Value
Parameter group: Properties Arguments
Accepted values: DevOps, Github
--repository

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

Property Value
Parameter group: Properties Arguments
--repository-info

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

Property Value
Parameter group: Properties Arguments
--version

The version number associated with the source control.

Property Value
Parameter group: Properties Arguments
Accepted values: V1, V2
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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 --source-control-id]
                                  [--resource-group]
                                  [--subscription]
                                  [--workspace-name]
                                  [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --source-control-id -n

Source control Id.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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 --source-control-id]
                                [--resource-group]
                                [--subscription]
                                [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --source-control-id -n

Source control Id.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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 --source-control-id]
                                  [--remove]
                                  [--repo-type {DevOps, Github}]
                                  [--repository]
                                  [--repository-info]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--version {V1, V2}]
                                  [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--content-types

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

Property Value
Parameter group: Properties Arguments
--description

A description of the source control.

Property Value
Parameter group: Properties Arguments
--display-name

The display name of the source control.

Property Value
Parameter group: Properties Arguments
--etag

Etag of the azure resource.

Property Value
Parameter group: SourceControl Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--id

The id (a Guid) of the source control.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: 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.

Property Value
Parameter group: Properties Arguments
--name --source-control-id -n

Source control Id.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--repo-type

The repository type of the source control.

Property Value
Parameter group: Properties Arguments
Accepted values: DevOps, Github
--repository

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

Property Value
Parameter group: Properties Arguments
--repository-info

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

Property Value
Parameter group: Properties Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--version

The version number associated with the source control.

Property Value
Parameter group: Properties Arguments
Accepted values: V1, V2
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False