FileSharesOperations Class
FileSharesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectFileSharesOperations
Constructor
FileSharesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| create |
Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. |
| delete |
Deletes specified share under its account. |
| get |
Gets properties of a specified share. |
| lease |
The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite. |
| list |
Lists all shares. |
| restore |
Restore a file share within a valid retention days if share soft delete is enabled. |
| update |
Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist. |
create
Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.
create(resource_group_name: str, account_name: str, share_name: str, file_share: azure.mgmt.storage.v2021_04_01.models._models_py3.FileShare, expand: Optional[str] = None, **kwargs: Any) -> azure.mgmt.storage.v2021_04_01.models._models_py3.FileShareParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- expand
- str
Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
FileShare, or the result of cls(response)
Return type
Exceptions
delete
Deletes specified share under its account.
delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: Optional[str] = None, include: Optional[str] = None, **kwargs: Any) -> NoneParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- include
- str
Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Gets properties of a specified share.
get(resource_group_name: str, account_name: str, share_name: str, expand: Optional[str] = None, x_ms_snapshot: Optional[str] = None, **kwargs: Any) -> azure.mgmt.storage.v2021_04_01.models._models_py3.FileShareParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- expand
- str
Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
FileShare, or the result of cls(response)
Return type
Exceptions
lease
The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: Optional[str] = None, parameters: Optional[azure.mgmt.storage.v2021_04_01.models._models_py3.LeaseShareRequest] = None, **kwargs: Any) -> azure.mgmt.storage.v2021_04_01.models._models_py3.LeaseShareResponseParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LeaseShareResponse, or the result of cls(response)
Return type
Exceptions
list
Lists all shares.
list(resource_group_name: str, account_name: str, maxpagesize: Optional[str] = None, filter: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.storage.v2021_04_01.models._models_py3.FileShareItems]Parameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- maxpagesize
- str
Optional. Specified maximum number of shares that can be included in the list.
- filter
- str
Optional. When specified, only share names starting with the filter will be listed.
- expand
- str
Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ','.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either FileShareItems or the result of cls(response)
Return type
Exceptions
restore
Restore a file share within a valid retention days if share soft delete is enabled.
restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: azure.mgmt.storage.v2021_04_01.models._models_py3.DeletedShare, **kwargs: Any) -> NoneParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- deleted_share
- DeletedShare
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
update
Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
update(resource_group_name: str, account_name: str, share_name: str, file_share: azure.mgmt.storage.v2021_04_01.models._models_py3.FileShare, **kwargs: Any) -> azure.mgmt.storage.v2021_04_01.models._models_py3.FileShareParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
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.
- share_name
- str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
FileShare, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.storage.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\storage\\v2021_04_01\\models\\__init__.py'>Feedback
Submit and view feedback for