Share via

az repos policy work-item-linking

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az repos policy work-item-linking command. Learn more about extensions.

Manage work item linking policy.

Commands

Name Description Type Status
az repos policy work-item-linking create

Create work item linking policy.

 Extension GA
az repos policy work-item-linking update

Update work item linking policy.

 Extension GA

az repos policy work-item-linking create

Create work item linking policy.

az repos policy work-item-linking create --blocking {false, true}
                                         --branch
                                         --enabled {false, true}
                                         --repository-id
                                         [--branch-match-type {exact, prefix}]
                                         [--detect {false, true}]
                                         [--org --organization]
                                         [--project]

Required Parameters

--blocking

Whether the policy should be blocking or not.

Property Value
Accepted values: false, true
--branch

Branch on which this policy should be applied. For example: master.

--enabled

Whether the policy is enabled or not.

Property Value
Accepted values: false, true
--repository-id

Id of the repository on which to apply the policy.

Optional Parameters

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

--branch-match-type

Determines how the branch argument is used to apply a policy. If value is 'exact', the policy will be applied on a branch which has an exact match on the --branch argument. If value is 'prefix' the policy is applied across all branch folders that match the prefix provided by the --branch argument.

Property Value
Default value: exact
Accepted values: exact, prefix
--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

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 repos policy work-item-linking update

Update work item linking policy.

az repos policy work-item-linking update --id --policy-id
                                         [--blocking {false, true}]
                                         [--branch]
                                         [--branch-match-type {exact, prefix}]
                                         [--detect {false, true}]
                                         [--enabled {false, true}]
                                         [--org --organization]
                                         [--project]
                                         [--repository-id]

Required Parameters

--id --policy-id

ID of the policy.

Optional Parameters

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

--blocking

Whether the policy should be blocking or not.

Property Value
Accepted values: false, true
--branch

Branch on which this policy should be applied. For example: master.

--branch-match-type

Determines how the branch argument is used to apply a policy. If value is 'exact', the policy will be applied on a branch which has an exact match on the --branch argument. If value is 'prefix' the policy is applied across all branch folders that match the prefix provided by the --branch argument.

Property Value
Accepted values: exact, prefix
--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--enabled

Whether the policy is enabled or not.

Property Value
Accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--repository-id

Id of the repository on which to apply the policy.

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