New-AzStorageTableSASToken
Generates an SAS token for an Azure Storage table.
Syntax
New-AzStorageTableSASToken
[-Name] <String>
-Policy <String>
[-Protocol <SharedAccessProtocol>]
[-IPAddressOrRange <String>]
[-StartTime <DateTime>]
[-ExpiryTime <DateTime>]
[-FullUri]
[-StartPartitionKey <String>]
[-StartRowKey <String>]
[-EndPartitionKey <String>]
[-EndRowKey <String>]
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzStorageTableSASToken
[-Name] <String>
[-Permission <String>]
[-Protocol <SharedAccessProtocol>]
[-IPAddressOrRange <String>]
[-StartTime <DateTime>]
[-ExpiryTime <DateTime>]
[-FullUri]
[-StartPartitionKey <String>]
[-StartRowKey <String>]
[-EndPartitionKey <String>]
[-EndRowKey <String>]
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzStorageTableSASToken cmdlet generates a Shared Access Signature (SAS) token for an Azure Storage table.
Examples
Example 1: Generate an SAS token that has full permissions for a table
New-AzStorageTableSASToken -Name "ContosoResources" -Permission "raud"This command generates an SAS token with full permissions for the table named ContosoResources. That token is for read, add, update, and delete permissions.
Example 2: Generate an SAS token for a range of partitions
New-AzStorageTableSASToken -Name "ContosoResources" -Permission "raud" -StartPartitionKey "a" -EndPartitionKey "b"This command generates and SAS token with full permissions for the table named ContosoResources. The command limits the token to the range that the StartPartitionKey and EndPartitionKey parameters specify.
Example 3: Generate an SAS token that has a stored access policy for a table
New-AzStorageTableSASToken -Name "ContosoResources" -Policy "ClientPolicy01"This command generates an SAS token for the table named ContosoResources. The command specifies the stored access policy named ClientPolicy01.
Parameters
-Context
Specifies an Azure storage context. To obtain a storage 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 |
-EndPartitionKey
Specifies the partition key of the end of the range for the token that this cmdlet creates.
| Type: | String |
| Aliases: | endpk |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndRowKey
Specifies the row key for the end of the range for the token that this cmdlet creates.
| Type: | String |
| Aliases: | endrk |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpiryTime
Specifies when the SAS token expires.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullUri
Indicates that this cmdlet returns the full queue URI with the SAS 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 |
-Name
Specifies the name of an Azure Storage table. This cmdlet creates an SAS token for the table that this parameter specifies.
| Type: | String |
| Aliases: | N, Table |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Permission
Specifies permissions for an Azure Storage table.
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 a stored access policy, which includes the permissions for this SAS token.
| 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: | Nullable<T>[SharedAccessProtocol] |
| Accepted values: | HttpsOnly, HttpsOrHttp |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartPartitionKey
Specifies the partition key of the start of the range for the token that this cmdlet creates.
| Type: | String |
| Aliases: | startpk |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartRowKey
Specifies the row key for the start of the range for the token that this cmdlet creates.
| Type: | String |
| Aliases: | startrk |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
Specifies when the SAS token becomes valid.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
