Share via

az tsi access-policy

  • Reference

Note

This reference is part of the timeseriesinsights extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az tsi access-policy command. Learn more about extensions.

Manage access policy with timeseriesinsights.

Commands

Name Description Type Status
az tsi access-policy create

Create an access policy in the specified environment.

 Extension GA
az tsi access-policy delete

Delete the access policy with the specified name in the specified subscription, resource group, and environment.

 Extension GA
az tsi access-policy list

List all the available access policies associated with the environment.

 Extension GA
az tsi access-policy show

Get the access policy with the specified name in the specified environment.

 Extension GA
az tsi access-policy update

Update the access policy with the specified name in the specified subscription, resource group, and environment.

 Extension GA

az tsi access-policy create

Create an access policy in the specified environment.

az tsi access-policy create --access-policy-name
                            --environment-name
                            --resource-group
                            [--description]
                            [--principal-object-id]
                            [--roles]

Examples

AccessPoliciesCreate

az tsi access-policy create --name "ap1" --environment-name "env1" --description "some description" --principal-object-id "aGuid" --roles Reader Contributor --resource-group "rg1"

Required Parameters

--access-policy-name --name -n

Name of the access policy.

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

--resource-group -g

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

Optional Parameters

--description

An description of the access policy.

--principal-object-id

The objectId of the principal in Azure Active Directory. Values from: az ad user, az ad sp.

--roles

The list of roles the principal is assigned on the environment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 tsi access-policy delete

Delete the access policy with the specified name in the specified subscription, resource group, and environment.

az tsi access-policy delete [--access-policy-name]
                            [--environment-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

AccessPoliciesDelete

az tsi access-policy delete --name "ap1" --environment-name "env1" --resource-group "rg1"

Optional Parameters

--access-policy-name --name -n

The name of the Time Series Insights access policy associated with the specified environment.

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

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

--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 tsi access-policy list

List all the available access policies associated with the environment.

az tsi access-policy list --environment-name
                          --resource-group

Examples

AccessPoliciesByEnvironment

az tsi access-policy list --environment-name "env1" --resource-group "rg1"

Required Parameters

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

--resource-group -g

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

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 tsi access-policy show

Get the access policy with the specified name in the specified environment.

az tsi access-policy show [--access-policy-name]
                          [--environment-name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

Examples

AccessPoliciesGet

az tsi access-policy show --name "ap1" --environment-name "env1" --resource-group "rg1"

Optional Parameters

--access-policy-name --name -n

The name of the Time Series Insights access policy associated with the specified environment.

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

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

--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 tsi access-policy update

Update the access policy with the specified name in the specified subscription, resource group, and environment.

az tsi access-policy update [--access-policy-name]
                            [--description]
                            [--environment-name]
                            [--ids]
                            [--resource-group]
                            [--roles]
                            [--subscription]

Examples

AccessPoliciesUpdate

az tsi access-policy update --name "ap1" --roles "Reader" --roles "Contributor" --environment-name "env1" --resource-group "rg1"

Optional Parameters

--access-policy-name --name -n

The name of the Time Series Insights access policy associated with the specified environment.

--description

An description of the access policy.

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

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

--resource-group -g

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

--roles

The list of roles the principal is assigned on the environment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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