New-AzureStorageContainerSASToken
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
New-AzureStorageContainerSASToken
Generate a shared access signature token for an Azure storage container.
Syntax
Parameter Set: SasPermission
New-AzureStorageContainerSASToken [-Name] <String> [-Context <AzureStorageContext> ] [-ExpiryTime <DateTime> ] [-FullUri] [-Permission <String> ] [-StartTime <DateTime> ] [ <CommonParameters>]
Parameter Set: SasPolicy
New-AzureStorageContainerSASToken [-Name] <String> [-Context <AzureStorageContext> ] [-ExpiryTime <DateTime> ] [-FullUri] [-Policy <String> ] [-StartTime <DateTime> ] [ <CommonParameters>]
Detailed Description
These topics are deprecated and will be removed in the future. For the updated topics, see Azure Storage Cmdlets. This topic describes the cmdlet in the 0.8.1 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.
Generate a shared access signature token for an Azure storage container.
Parameters
-Context<AzureStorageContext>
Azure storage context.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ExpiryTime<DateTime>
The time at which the shared access signature becomes invalid.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FullUri
Return the full container uri with SAS token.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Azure storage container name.
Aliases |
N,Container |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Permission<String>
Permissions for a storage container.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Policy<String>
Azure Stored Access Policy.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StartTime<DateTime>
The time at which the shared access signature becomes valid.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This example generates a container SAS token with full container permission.
C:\PS>New-AzureStorageContainerSASToken -Name test -Permission rwdl
Example 2
This example generates multiple container SAS tokens by using the pipeline.
C:\PS>Get-AzureStorageContainer -Container test* | New-AzureStorageContainerSASToken -Permission rwdl
Example 3
This example generates a container SAS token with shared access policy.
C:\PS>New-AzureStorageContainerSASToken -Name test -Policy policyName
Related topics
New-AzureStorageBlobSASToken