New-AzStorageShareSASToken
Generate Shared Access Signature token for Azure Storage share.
Syntax
SasPolicy
New-AzStorageShareSASToken
[-ShareName] <String>
-Policy <String>
[-Protocol <String>]
[-IPAddressOrRange <String>]
[-StartTime <DateTime>]
[-ExpiryTime <DateTime>]
[-FullUri]
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
SasPermission
New-AzStorageShareSASToken
[-ShareName] <String>
[-Permission <String>]
[-Protocol <String>]
[-IPAddressOrRange <String>]
[-StartTime <DateTime>]
[-ExpiryTime <DateTime>]
[-FullUri]
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The New-AzStorageShareSASToken cmdlet generates a shared access signature token for an Azure Storage share.
Examples
Example 1: Generate a shared access signature token for a share
New-AzStorageShareSASToken -ShareName "ContosoShare" -Permission "rwdl"
This command creates a shared access signature token for the share named ContosoShare.
Example 2: Generate multiple shared access signature token by using the pipeline
Get-AzStorageShare -Prefix "test" | New-AzStorageShareSASToken -Permission "rwdl"
This command gets all the Storage shares that match the prefix test.
The command passes them to the current cmdlet by using the pipeline operator.
The current cmdlet creates a shared access token for each Storage share that has the specified permissions.
Example 3: Generate a shared access signature token that uses a shared access policy
New-AzStorageShareSASToken -ShareName "ContosoShare" -Policy "ContosoPolicy03"
This command creates a shared access signature token for the Storage share named ContosoShare that has the policy named ContosoPolicy03.
Parameters
-Context
Specifies an Azure Storage context.
To obtain a context, use the New-AzStorageContext cmdlet.
Parameter properties
Type: IStorageContext
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ExpiryTime
Specifies the time at which the shared access signature becomes invalid.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FullUri
Indicates that this cmdlet return the full blob URI and the shared access signature token.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IPAddressOrRange
Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70.
The range is inclusive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Permission
Specifies the permissions in the token to access the share and files under the share.
It is important to note that this is a string, like rwd (for Read, Write and Delete).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SasPermission
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Policy
Specifies the stored access policy for a share.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SasPolicy
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Protocol
Specifies the protocol permitted for a request.
The acceptable values for this parameter are:
HttpsOnly
HttpsOrHttp
The default value is HttpsOrHttp.
Parameter properties
Type: String
Default value: None Accepted values: HttpsOnly, HttpsOrHttp Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ShareName
Specifies the name of the Storage share.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: N, Name
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-StartTime
Specifies the time at which the shared access signature becomes valid.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
Notes
Keywords: common, azure, services, data, storage, blob, queue, table
