FileServicesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:file_services> attribute.
Constructor
FileServicesOperations(*args, **kwargs)
Methods
| get_service_properties |
Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. |
| 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. |
| list |
List all file services in storage accounts. |
| list_service_usages |
Gets the usages of file service in storage account. |
| set_service_properties |
Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. |
get_service_properties
Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
get_service_properties(resource_group_name: str, account_name: str, **kwargs: Any) -> FileServiceProperties
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. The name is case insensitive. Required. |
|
account_name
Required
|
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. |
Returns
| Type | Description |
|---|---|
|
FileServiceProperties or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.
get_service_usage(resource_group_name: str, account_name: str, **kwargs: Any) -> FileServiceUsage
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. The name is case insensitive. Required. |
|
account_name
Required
|
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. |
Returns
| Type | Description |
|---|---|
|
FileServiceUsage or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List all file services in storage accounts.
list(resource_group_name: str, account_name: str, **kwargs: Any) -> FileServiceItems
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. The name is case insensitive. Required. |
|
account_name
Required
|
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. |
Returns
| Type | Description |
|---|---|
|
FileServiceItems or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_service_usages
Gets the usages of file service in storage account.
list_service_usages(resource_group_name: str, account_name: str, maxpagesize: int | None = None, **kwargs: Any) -> ItemPaged[FileServiceUsage]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. The name is case insensitive. Required. |
|
account_name
Required
|
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. |
|
maxpagesize
|
Optional, specifies the maximum number of file service usages to be included in the list response. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either FileServiceUsage or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
set_service_properties
Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
set_service_properties(resource_group_name: str, account_name: str, parameters: _models.FileServiceProperties, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileServiceProperties
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. The name is case insensitive. Required. |
|
account_name
Required
|
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. |
|
parameters
Required
|
The properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. Is either a FileServiceProperties type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
FileServiceProperties or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.storage.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv225\\Lib\\site-packages\\azure\\mgmt\\storage\\models\\__init__.py'>