azure::storage::service_properties::logging_properties Class Reference

An object representing the service properties pertaining to logging. More...

Public Member Functions
	logging_properties ()
	Initializes a new instance of the azure::storage::service_properties::logging_properties struct. More...
const utility::string_t &	version () const
	Gets the version of Storage Analytics in use. More...
void	set_version (utility::string_t value)
	Gets the version of Storage Analytics to use. More...
bool	read_enabled () const
	Gets a value indicating whether all read requests should be logged. More...
void	set_read_enabled (bool value)
	Sets a value indicating whether all read requests should be logged. More...
bool	write_enabled () const
	Gets a value indicating whether all write requests should be logged. More...
void	set_write_enabled (bool value)
	Sets a value indicating whether all write requests should be logged. More...
bool	delete_enabled () const
	Gets a value indicating whether all delete requests should be logged. More...
void	set_delete_enabled (bool value)
	Sets a value indicating whether all delete requests should be logged. More...
bool	retention_policy_enabled () const
	Gets a value indicating whether a retention policy is enabled for service logs. More...
void	set_retention_policy_enabled (bool value)
	Sets a value indicating whether a retention policy is enabled for service logs. More...
int	retention_days () const
	Gets the number of days that logging data should be retained. More...
void	set_retention_days (int value)
	Sets the number of days that logging data should be retained. More...

Detailed Description

An object representing the service properties pertaining to logging.

Constructor & Destructor Documentation

logging_properties()

azure::storage::service_properties::logging_properties::logging_properties ( )

inline

Initializes a new instance of the azure::storage::service_properties::logging_properties struct.

Member Function Documentation

delete_enabled()

bool azure::storage::service_properties::logging_properties::delete_enabled ( ) const

inline

Gets a value indicating whether all delete requests should be logged.

Returns

true if all delete requests should be logged; otherwise, false.

read_enabled()

bool azure::storage::service_properties::logging_properties::read_enabled ( ) const

inline

Gets a value indicating whether all read requests should be logged.

Returns

true if all read requests should be logged; otherwise, false.

retention_days()

int azure::storage::service_properties::logging_properties::retention_days ( ) const

inline

Gets the number of days that logging data should be retained.

Returns

The number of days to retain the logging data. If this value is 0, the retention policy is disabled.

retention_policy_enabled()

bool azure::storage::service_properties::logging_properties::retention_policy_enabled ( ) const

inline

Gets a value indicating whether a retention policy is enabled for service logs.

Returns

true if a retention policy is enabled; otherwise, false.

set_delete_enabled()

void azure::storage::service_properties::logging_properties::set_delete_enabled ( bool  value )

inline

Sets a value indicating whether all delete requests should be logged.

Parameters

value

Use true if all delete requests should be logged; otherwise, false.

set_read_enabled()

void azure::storage::service_properties::logging_properties::set_read_enabled ( bool  value )

inline

Sets a value indicating whether all read requests should be logged.

Parameters

value

Use true if all read requests should be logged; otherwise, false.

set_retention_days()

void azure::storage::service_properties::logging_properties::set_retention_days ( int  value )

inline

Sets the number of days that logging data should be retained.

Parameters

value

The number of days to retain the logging data, or 0 to disable the retention policy.

set_retention_policy_enabled()

void azure::storage::service_properties::logging_properties::set_retention_policy_enabled ( bool  value )

inline

Sets a value indicating whether a retention policy is enabled for service logs.

Parameters

value

Use true if a retention policy is enabled; otherwise, false.

set_version()

void azure::storage::service_properties::logging_properties::set_version ( utility::string_t  value )

inline

Gets the version of Storage Analytics to use.

Parameters

value

A string specifying the version of Storage Analytics to use. Set this value to "1.0".

set_write_enabled()

void azure::storage::service_properties::logging_properties::set_write_enabled ( bool  value )

inline

Sets a value indicating whether all write requests should be logged.

Parameters

value

Use true if all write requests should be logged; otherwise, false.

version()

const utility::string_t& azure::storage::service_properties::logging_properties::version ( ) const

inline

Gets the version of Storage Analytics in use.

Returns

A string specifying the version of Storage Analytics to use. Set this value to "1.0".

write_enabled()

bool azure::storage::service_properties::logging_properties::write_enabled ( ) const

inline

Gets a value indicating whether all write requests should be logged.

Returns

true if all write requests should be logged; otherwise, false.