Share via

az tsi access-policy

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

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

--description

An description of the access policy.

Property Value
Parameter group: Properties Arguments
--principal-object-id

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

Property Value
Parameter group: Properties Arguments
--roles

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

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

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

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

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

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

Property Value
Parameter group: Resource Id Arguments
--environment-name

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

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

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

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

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

Examples

AccessPoliciesGet

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

Optional Parameters

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

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

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

Property Value
Parameter group: Resource Id Arguments
--environment-name

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

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

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

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

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

Property Value
Parameter group: Resource Id Arguments
--description

An description of the access policy.

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

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

Property Value
Parameter group: Resource Id 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
--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
--roles

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

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