az storage advanced-platform-metric

Manage Advanced Platform Metric.

Commands

Name Description Type Status
az storage advanced-platform-metric create

Create the advanced platform metrics rule for the storage account.

 Core Preview
az storage advanced-platform-metric delete

Delete the advanced platform metrics rule for the storage account by rule type.

 Core Preview
az storage advanced-platform-metric list

List the advanced platform metrics rules associated with the storage account.

 Core Preview
az storage advanced-platform-metric show

Get the advanced platform metrics rule for the storage account by rule type.

 Core Preview
az storage advanced-platform-metric update

Update the advanced platform metrics rule for the storage account.

 Core Preview

az storage advanced-platform-metric create

Edit
Preview

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

Create the advanced platform metrics rule for the storage account.

az storage advanced-platform-metric create --account-name
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--advanced-platform-metrics-rule-type --name {ContainerLevelCapacityMetrics}]
                                           [--change-reference]
                                           [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--filter-type --rule-config-filter-type {AllContainersFilter, ContainerListFilter, ContainerPrefixFilter}]
                                           [--filter-values --rule-config-filter-values]

Examples

Create AllContainersFilter AdvancedPlatformMetric

az storage advanced-platform-metric create -g resource_group_name --account-name storage_account_name --enabled --rule-config-filter-type AllContainersFilter

Create ContainerPrefixFilter AdvancedPlatformMetric

az storage advanced-platform-metric create -g resource_group_name --account-name storage_account_name --enabled --rule-config-filter-type ContainerPrefixFilter --rule-config-filter-values logsprefix dataprefix

Create ContainerListFilter AdvancedPlatformMetric

az storage advanced-platform-metric create -g resource_group_name --account-name storage_account_name --enabled --rule-config-filter-type ContainerListFilter --rule-config-filter-values logs data

Required Parameters

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--advanced-platform-metrics-rule-type --name -n

The type of the advanced platform metrics rule.

Property Value
Default value: ContainerLevelCapacityMetrics
Accepted values: ContainerLevelCapacityMetrics
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--enabled

A boolean flag which enables the advanced platform metrics rule.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--filter-type --rule-config-filter-type

The type of filter applied to the rule. Possible values include: AllContainersFilter, ContainerPrefixFilter, ContainerListFilter.

Property Value
Parameter group: RuleConfig Arguments
Accepted values: AllContainersFilter, ContainerListFilter, ContainerPrefixFilter
--filter-values --rule-config-filter-values

The values for the filter applied to the rule. If filter type is AllContainersFilter, filter values should be empty. If filter type is ContainerPrefixFilter, filter values should contain a list of container prefixes. If filter type is ContainerListFilter, filter values should contain a list of container names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: RuleConfig 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 storage advanced-platform-metric delete

Edit
Preview

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

Delete the advanced platform metrics rule for the storage account by rule type.

az storage advanced-platform-metric delete [--account-name]
                                           [--acquire-policy-token]
                                           [--advanced-platform-metrics-rule-type --name {ContainerLevelCapacityMetrics}]
                                           [--change-reference]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete advanced platform metrics rule

az storage advanced-platform-metric delete -g resource_group_name --account-name storage_account_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.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--advanced-platform-metrics-rule-type --name -n

The type of the advanced platform metrics rule.

Property Value
Parameter group: Resource Id Arguments
Default value: ContainerLevelCapacityMetrics
Accepted values: ContainerLevelCapacityMetrics
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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 storage advanced-platform-metric list

Edit
Preview

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

List the advanced platform metrics rules associated with the storage account.

az storage advanced-platform-metric list --account-name
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List advanced platform metrics rules

az storage advanced-platform-metric list -g resource_group_name --account-name storage_account_name

Required Parameters

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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 storage advanced-platform-metric show

Edit
Preview

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

Get the advanced platform metrics rule for the storage account by rule type.

az storage advanced-platform-metric show [--account-name]
                                         [--advanced-platform-metrics-rule-type --name {ContainerLevelCapacityMetrics}]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

Get advanced platform metrics rule

az storage advanced-platform-metric show -g resource_group_name --account-name storage_account_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.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--advanced-platform-metrics-rule-type --name -n

The type of the advanced platform metrics rule.

Property Value
Parameter group: Resource Id Arguments
Default value: ContainerLevelCapacityMetrics
Accepted values: ContainerLevelCapacityMetrics
--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 storage advanced-platform-metric update

Edit
Preview

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

Update the advanced platform metrics rule for the storage account.

az storage advanced-platform-metric update [--account-name]
                                           [--acquire-policy-token]
                                           [--add]
                                           [--advanced-platform-metrics-rule-type --name {ContainerLevelCapacityMetrics}]
                                           [--change-reference]
                                           [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--filter-type --rule-config-filter-type {AllContainersFilter, ContainerListFilter, ContainerPrefixFilter}]
                                           [--filter-values --rule-config-filter-values]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

Examples

Update advanced platform metrics rule

az storage advanced-platform-metric update -g resource_group_name --account-name storage_account_name --enabled --rule-config-filter-type AllContainersFilter

Optional Parameters

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

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--advanced-platform-metrics-rule-type --name -n

The type of the advanced platform metrics rule.

Property Value
Parameter group: Resource Id Arguments
Accepted values: ContainerLevelCapacityMetrics
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--enabled

A boolean flag which enables the advanced platform metrics rule.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--filter-type --rule-config-filter-type

The type of filter applied to the rule. Possible values include: AllContainersFilter, ContainerPrefixFilter, ContainerListFilter.

Property Value
Parameter group: RuleConfig Arguments
Accepted values: AllContainersFilter, ContainerListFilter, ContainerPrefixFilter
--filter-values --rule-config-filter-values

The values for the filter applied to the rule. If filter type is AllContainersFilter, filter values should be empty. If filter type is ContainerPrefixFilter, filter values should contain a list of container prefixes. If filter type is ContainerListFilter, filter values should contain a list of container names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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