你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
New-AzStorageShareSASToken
Generate Shared Access Signature token for Azure Storage share.
Syntax
New-AzStorageShareSASToken
[-ShareName] <String>
-Policy <String>
[-Protocol <String>]
[-IPAddressOrRange <String>]
[-StartTime <DateTime>]
[-ExpiryTime <DateTime>]
[-FullUri]
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
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.
Type: | IStorageContext |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExpiryTime
Specifies the time at which the shared access signature becomes invalid.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FullUri
Indicates that this cmdlet return the full blob URI and the shared access signature token.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Policy
Specifies the stored access policy for a share.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Protocol
Specifies the protocol permitted for a request. The acceptable values for this parameter are:
- HttpsOnly
- HttpsOrHttp The default value is HttpsOrHttp.
Type: | String |
Accepted values: | HttpsOnly, HttpsOrHttp |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ShareName
Specifies the name of the Storage share.
Type: | String |
Aliases: | N, Name |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StartTime
Specifies the time at which the shared access signature becomes valid.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Notes
- Keywords: common, azure, services, data, storage, blob, queue, table