FileServices interface

Package:

@azure/arm-storage

Interface representing a FileServices.

Methods

getServiceProperties(string, string, FileServicesGetServicePropertiesOptionalParams)	Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
getServiceUsage(string, string, FileServicesGetServiceUsageOptionalParams)	Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
list(string, string, FileServicesListOptionalParams)	List all file services in storage accounts
listServiceUsages(string, string, FileServicesListServiceUsagesOptionalParams)	Gets the usages of file service in storage account.
setServiceProperties(string, string, FileServiceProperties, FileServicesSetServicePropertiesOptionalParams)	Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

Method Details

getServiceProperties(string, string, FileServicesGetServicePropertiesOptionalParams)

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

function getServiceProperties(resourceGroupName: string, accountName: string, options?: FileServicesGetServicePropertiesOptionalParams): Promise<FileServiceProperties>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

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.

options

FileServicesGetServicePropertiesOptionalParams

The options parameters.

Returns

Promise<FileServiceProperties>

getServiceUsage(string, string, FileServicesGetServiceUsageOptionalParams)

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

function getServiceUsage(resourceGroupName: string, accountName: string, options?: FileServicesGetServiceUsageOptionalParams): Promise<FileServiceUsage>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

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.

options

FileServicesGetServiceUsageOptionalParams

The options parameters.

Returns

Promise<FileServiceUsage>

list(string, string, FileServicesListOptionalParams)

List all file services in storage accounts

function list(resourceGroupName: string, accountName: string, options?: FileServicesListOptionalParams): Promise<FileServiceItems>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

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.

options

FileServicesListOptionalParams

The options parameters.

Returns

Promise<FileServiceItems>

listServiceUsages(string, string, FileServicesListServiceUsagesOptionalParams)

Gets the usages of file service in storage account.

function listServiceUsages(resourceGroupName: string, accountName: string, options?: FileServicesListServiceUsagesOptionalParams): PagedAsyncIterableIterator<FileServiceUsage, FileServiceUsage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

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.

options

FileServicesListServiceUsagesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FileServiceUsage, FileServiceUsage[], PageSettings>

setServiceProperties(string, string, FileServiceProperties, FileServicesSetServicePropertiesOptionalParams)

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

function setServiceProperties(resourceGroupName: string, accountName: string, parameters: FileServiceProperties, options?: FileServicesSetServicePropertiesOptionalParams): Promise<FileServiceProperties>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

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.

parameters

FileServiceProperties

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

options

FileServicesSetServicePropertiesOptionalParams

The options parameters.

Returns

Promise<FileServiceProperties>