Share via

az storage account blob-inventory-policy

  • Preview
  • Reference

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

Manage storage account Blob Inventory Policy.

Commands

Name Description Type Status
az storage account blob-inventory-policy create

Create Blob Inventory Policy for storage account.

 Core Preview
az storage account blob-inventory-policy delete

Delete Blob Inventory Policy associated with the specified storage account.

 Core Preview
az storage account blob-inventory-policy show

Show Blob Inventory Policy properties associated with the specified storage account.

 Core Preview
az storage account blob-inventory-policy update

Update Blob Inventory Policy associated with the specified storage account.

 Core Preview

az storage account blob-inventory-policy create

Edit
Preview

Command group 'storage account blob-inventory-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create Blob Inventory Policy for storage account.

az storage account blob-inventory-policy create --account-name
                                                --policy
                                                [--resource-group]

Examples

Create Blob Inventory Policy through json file for storage account.

az storage account blob-inventory-policy create -g myresourcegroup --account-name mystorageaccount --policy @policy.json

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.

--policy

The Storage Account Blob Inventory Policy, string in JSON format or json file path. See more details in https://docs.microsoft.com/azure/storage/blobs/blob-inventory#inventory-policy.

Optional Parameters

--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 storage account blob-inventory-policy delete

Edit
Preview

Command group 'storage account blob-inventory-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete Blob Inventory Policy associated with the specified storage account.

az storage account blob-inventory-policy delete --account-name
                                                [--resource-group]
                                                [--yes]

Examples

Delete Blob Inventory Policy associated with the specified storage account without prompt.

az storage account blob-inventory-policy delete -g ResourceGroupName --account-name storageAccountName -y

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.

Optional Parameters

--resource-group -g

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

--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 storage account blob-inventory-policy show

Edit
Preview

Command group 'storage account blob-inventory-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show Blob Inventory Policy properties associated with the specified storage account.

az storage account blob-inventory-policy show --account-name
                                              [--resource-group]

Examples

Show Blob Inventory Policy properties associated with the specified storage account without prompt.

az storage account blob-inventory-policy show -g ResourceGroupName --account-name storageAccountName

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.

Optional Parameters

--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 storage account blob-inventory-policy update

Edit
Preview

Command group 'storage account blob-inventory-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update Blob Inventory Policy associated with the specified storage account.

az storage account blob-inventory-policy update --account-name
                                                [--add]
                                                [--force-string]
                                                [--remove]
                                                [--resource-group]
                                                [--set]

Examples

Update Blob Inventory Policy associated with the specified storage account.

az storage account blob-inventory-policy update -g ResourceGroupName --account-name storageAccountName --set "policy.rules[0].name=newname"

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.

Optional Parameters

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

Default value: []
--force-string

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

Default value: False
--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
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.