azure::storage::queue_shared_access_policy Class Reference

Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature for the Queue service. More...

Inheritance diagram for azure::storage::queue_shared_access_policy:

Public Types
enum	permissions {   none = 0, read = 1, add = 0x10, update = 0x20,   process = 0x40 }
	An enumeration describing permissions that may be used for a shared access signature. More...
Public Types inherited from azure::storage::shared_access_policy
enum	protocols { https_only = 0x1, https_or_http = 0x2 }
	Specifies the set of possible signed protocols for a shared access account policy. More...

Public Member Functions
	queue_shared_access_policy ()
	Initializes a new instance of the azure::storage::queue_shared_access_policy class. More...
	queue_shared_access_policy (utility::datetime expiry, uint8_t permission)
	Initializes a new instance of the azure::storage::queue_shared_access_policy class. More...
	queue_shared_access_policy (utility::datetime start, utility::datetime expiry, uint8_t permission)
	Initializes a new instance of the azure::storage::queue_shared_access_policy class. More...
Public Member Functions inherited from azure::storage::shared_access_policy
utility::string_t	protocols_to_string () const
	Get a canonical string representation of the protocols for a shared access policy. More...
utility::string_t	permissions_to_string () const
	Get a canonical string representation of the permissions for a shared access policy. More...
void	set_permissions_from_string (const utility::string_t &value)
	Sets the permissions from the given string. More...
void	set_permissions (uint8_t value)
	Sets the permissions from the specified permissions. More...
uint8_t	permission () const
	Gets the permissions for the shared access policy. More...
void	set_start (utility::datetime value)
	Sets the start time for the shared access policy. More...
utility::datetime	start () const
	Gets the start time for the shared access policy. More...
void	set_expiry (utility::datetime value)
	Sets the expiry time for the shared access policy. More...
utility::datetime	expiry () const
	Gets the expiry time for the shared access policy. More...
bool	is_valid () const
	Indicates whether the azure::storage::shared_access_policy object is valid. More...
void	set_protocol (protocols value)
	Sets the allowed protocols for a shared access signature associated with this shared access policy. More...
protocols	protocol () const
	Gets the allowed protocols for a shared access signature associated with this shared access policy. More...
void	set_address_or_range (ip_address_or_range value)
	Sets the allowed IP address or IP address range for a shared access signature associated with this shared access policy. More...
const ip_address_or_range &	address_or_range () const
	Gets the allowed IP address or IP address range for a shared access signature associated with this shared access policy. More...

Detailed Description

Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature for the Queue service.

Member Enumeration Documentation

permissions

enum azure::storage::queue_shared_access_policy::permissions

An enumeration describing permissions that may be used for a shared access signature.

Enumerator
none	No permissions granted.
read	Permission granted to peek messages and to read metadata and properties, including message count.
add	Permission granted to add messages to a queue.
update	Permission granted to update messages in a queue.
process	Permission granted to get and delete messages from a queue.

Constructor & Destructor Documentation

queue_shared_access_policy() [1/3]

azure::storage::queue_shared_access_policy::queue_shared_access_policy ( )

inline

Initializes a new instance of the azure::storage::queue_shared_access_policy class.

queue_shared_access_policy() [2/3]

azure::storage::queue_shared_access_policy::queue_shared_access_policy ( utility::datetime  expiry, uint8_t  permission  )

inline

Initializes a new instance of the azure::storage::queue_shared_access_policy class.

Parameters

expiry	The expiration date and time of the policy.
permission	A mask containing the permissions of the policy

queue_shared_access_policy() [3/3]

azure::storage::queue_shared_access_policy::queue_shared_access_policy ( utility::datetime  start, utility::datetime  expiry, uint8_t  permission  )

inline

Initializes a new instance of the azure::storage::queue_shared_access_policy class.

Parameters

start	The start date and time of the policy.
expiry	The expiration date and time of the policy.
permission	A mask containing the permissions of the policy