az storage file symbolic-link

Manage storage file symbolic-link.

Commands

Name	Description	Type	Status
az storage file symbolic-link create	NFS only. Creates a symbolic link to the specified file.	Core	GA
az storage file symbolic-link show	NFS only. Gets the symbolic link for the file client.	Core	GA

az storage file symbolic-link create

Edit

NFS only. Creates a symbolic link to the specified file.

az storage file symbolic-link create --path
                                     --share-name
                                     --target
                                     [--account-key]
                                     [--account-name]
                                     [--auth-mode {key, login}]
                                     [--backup-intent --enable-file-backup-request-intent]
                                     [--connection-string]
                                     [--file-creation-time]
                                     [--file-endpoint]
                                     [--file-last-write-time]
                                     [--group]
                                     [--lease]
                                     [--metadata]
                                     [--owner]
                                     [--sas-token]
                                     [--timeout]

Examples

Create a symbolic link to an NFS file specified by path.

az storage file symbolic-link create --account-name MyAccount --share-name share --path link_path --target target_path --metadata meta1=value1 meta2=value2 --file-creation-time now --file-last-write-time now --owner 6 --group 7

Required Parameters

--path -p

The path to the file within the file share.

--share-name -s

The file share name.

--target

Specifies the file path the symbolic link will point to. The file path can be either relative or absolute.

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

Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.

Property	Value
Parameter group:	Storage Account Arguments

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

Property	Value
Parameter group:	Storage Account Arguments

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

Property	Value
Accepted values:	key, login

--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property	Value
Default value:	False

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--file-creation-time

Creation time for the file.

--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property	Value
Parameter group:	Storage Account Arguments

--file-last-write-time

Last write time for the file.

--group

The owning group of the file.

--lease

Lease id, required if the file has an active lease.

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--owner

The owner of the file.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.

Property	Value
Parameter group:	Storage Account Arguments

--timeout

Request timeout in seconds. Applies to each call to the service.

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