file_services

Creates, updates, deletes, gets or lists a file_services resource.

Overview

Name	file_services
Type	Resource
Id	azure.storage.file_services

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	array	List of file services returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, account_name, subscription_id		List all file services in storage accounts.
list_service_usages	exec	resource_group_name, account_name, subscription_id	$maxpagesize	Gets the usages of file service in storage account.
get_service_properties	exec	resource_group_name, account_name, subscription_id		Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
set_service_properties	exec	resource_group_name, account_name, subscription_id		Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
get_service_usage	exec	resource_group_name, account_name, subscription_id		Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$maxpagesize	integer

SELECT examples

list

List all file services in storage accounts.

SELECT
value
FROM azure.storage.file_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_service_usages

Gets the usages of file service in storage account.

EXEC azure.storage.file_services.list_service_usages 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$maxpagesize='{{ $maxpagesize }}'
;

get_service_properties

Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

EXEC azure.storage.file_services.get_service_properties 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

set_service_properties

Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

EXEC azure.storage.file_services.set_service_properties 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

get_service_usage

Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

EXEC azure.storage.file_services.get_service_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;