< Back

New-AzureStorageShareStoredAccessPolicy

Tue Jan 29, 2019 9:27 pm

NAME New-AzureStorageShareStoredAccessPolicy



SYNOPSIS

Creates a stored access policy on a Storage share.





SYNTAX

New-AzureStorageShareStoredAccessPolicy [-ShareName] <String> [-Policy] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]

[-Context <IStorageContext>] [-ExpiryTime <DateTime>] [-Permission <String>] [-ServerTimeoutPerRequest <Int32>] [-StartTime <DateTime>]

[<CommonParameters>]





DESCRIPTION

The New-AzureStorageShareStoredAccessPolicy cmdlet creates a stored access policy on an Azure Storage share.





PARAMETERS

-ClientTimeoutPerRequest <Int32>

Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this

cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ConcurrentTaskCount <Int32>

Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage

by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core

count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default

value is 10.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Context <IStorageContext>

Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext (./New-AzureStorageContext.md)cmdlet.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-ExpiryTime <DateTime>

Specifies the time at which the stored access policy becomes invalid.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Permission <String>

Specifies permissions in the stored access policy to access the Storage share or files under it.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Policy <String>

Specifies a name for the stored access policy.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ServerTimeoutPerRequest <Int32>

Specifies the length of the time-out period for the server part of a request.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ShareName <String>

Specifies the name of the Storage share.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-StartTime <DateTime>

Specifies the time at which the stored access policy becomes valid.



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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

IStorageContext

Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline



String

Parameter 'ShareName' accepts value of type 'String' from the pipeline





OUTPUTS

System.String







NOTES









Example 1: Create a stored access policy in a share



PS C:\\>New-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl"



This command creates a stored access policy that has full permission in a share.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... cesspolicy

Get-AzureStorageShareStoredAccessPolicy

New-AzureStorageContext

Remove-AzureStorageShareStoredAccessPolicy

Set-AzureStorageShareStoredAccessPolicy