FileShares interface
Interface representing a FileShares.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, string, FileShare, FileSharesCreateOrUpdateOptionalParams)
Creates or updates the file share.
function beginCreateOrUpdate(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, fileShare: FileShare, options?: FileSharesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<FileShare>, FileShare>>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- fileShare
- FileShare
The file share.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<FileShare>, FileShare>>
beginCreateOrUpdateAndWait(string, string, string, string, string, FileShare, FileSharesCreateOrUpdateOptionalParams)
Creates or updates the file share.
function beginCreateOrUpdateAndWait(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, fileShare: FileShare, options?: FileSharesCreateOrUpdateOptionalParams): Promise<FileShare>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- fileShare
- FileShare
The file share.
The options parameters.
Returns
Promise<FileShare>
beginDelete(string, string, string, string, string, FileSharesDeleteOptionalParams)
Deletes the file share.
function beginDelete(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: FileSharesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share Name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- FileSharesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, FileSharesDeleteOptionalParams)
Deletes the file share.
function beginDeleteAndWait(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share Name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- FileSharesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, FileSharesGetOptionalParams)
Returns the properties of the specified file share name.
function get(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- FileSharesGetOptionalParams
The options parameters.
Returns
Promise<FileShare>
listByDevice(string, string, string, FileSharesListByDeviceOptionalParams)
Retrieves all the file shares in a device.
function listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: FileSharesListByDeviceOptionalParams): PagedAsyncIterableIterator<FileShare, FileShare[], PageSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listByFileServer(string, string, string, string, FileSharesListByFileServerOptionalParams)
Retrieves all the file shares in a file server.
function listByFileServer(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileSharesListByFileServerOptionalParams): PagedAsyncIterableIterator<FileShare, FileShare[], PageSettings>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetricDefinition(string, string, string, string, string, FileSharesListMetricDefinitionOptionalParams)
Retrieves metric definitions of all metrics aggregated at the file share.
function listMetricDefinition(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: FileSharesListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetrics(string, string, string, string, string, FileSharesListMetricsOptionalParams)
Gets the file share metrics
function listMetrics(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: FileSharesListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>Parameters
- deviceName
-
string
The device name.
- fileServerName
-
string
The file server name.
- shareName
-
string
The file share name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for