az storage account file-service-properties

Manage the properties of file service in storage account.

Commands

Name	Description	Type	Status
az storage account file-service-properties show	Show the properties of file service in storage account.	Core	GA
az storage account file-service-properties update	Update the properties of file service in storage account.	Core	GA

az storage account file-service-properties show

Show the properties of file service in storage account.

az storage account file-service-properties show --account-name
                                                [--resource-group]

Examples

Show the properties of file service in storage account.

az storage account file-service-properties show -n mystorageaccount -g MyResourceGroup

Required Parameters

--account-name -n

The storage account name.

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 file-service-properties update

Update the properties of file service in storage account.

az storage account file-service-properties update --account-name
                                                  [--add]
                                                  [--auth-methods]
                                                  [--channel-encryption]
                                                  [--delete-retention-days]
                                                  [--enable-delete-retention {false, true}]
                                                  [--enable-smb-multichannel {false, true}]
                                                  [--force-string]
                                                  [--kerb-ticket-encryption]
                                                  [--remove]
                                                  [--resource-group]
                                                  [--set]
                                                  [--versions]

Examples

Enable soft delete policy and set delete retention days to 100 for file service in storage account.

az storage account file-service-properties update --enable-delete-retention true --delete-retention-days 100 -n mystorageaccount -g MyResourceGroup

Disable soft delete policy for file service.

az storage account file-service-properties update --enable-delete-retention false -n mystorageaccount -g MyResourceGroup

Enable SMB Multichannel setting for file service.

az storage account file-service-properties update --enable-smb-multichannel -n mystorageaccount -g MyResourceGroup

Disable SMB Multichannel setting for file service.

az storage account file-service-properties update --enable-smb-multichannel false -n mystorageaccount -g MyResourceGroup

Set secured SMB setting for file service.

az storage account file-service-properties update --versions SMB2.1;SMB3.0;SMB3.1.1 --auth-methods NTLMv2;Kerberos --kerb-ticket-encryption RC4-HMAC;AES-256 --channel-encryption AES-128-CCM;AES-128-GCM;AES-256-GCM -n mystorageaccount -g MyResourceGroup

Required Parameters

--account-name -n

The storage account name.

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: []

--auth-methods

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

--channel-encryption

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

--delete-retention-days

Indicate the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

--enable-delete-retention

Enable file service properties for share soft delete.

accepted values: false, true

--enable-smb-multichannel --mc

Set SMB Multichannel setting for file service. Applies to Premium FileStorage only.

accepted values: false, true

--force-string

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

default value: False

--kerb-ticket-encryption -k

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'.

--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: []

--versions

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

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.