StorageTasks interface
Interface representing a StorageTasks.
Methods
| begin |
Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed. |
| begin |
Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed. |
| begin |
Delete the storage task resource. |
| begin |
Delete the storage task resource. |
| begin |
Update storage task properties |
| begin |
Update storage task properties |
| get(string, string, Storage |
Get the storage task properties |
| list |
Lists all the storage tasks available under the given resource group. |
| list |
Lists all the storage tasks available under the subscription. |
| preview |
Runs the input conditions against input object metadata properties and designates matched objects in response. |
Method Details
beginCreate(string, string, StorageTask, StorageTasksCreateOptionalParams)
Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
function beginCreate(resourceGroupName: string, storageTaskName: string, parameters: StorageTask, options?: StorageTasksCreateOptionalParams): Promise<SimplePollerLike<OperationState<StorageTask>, StorageTask>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- parameters
- StorageTask
The parameters to create a Storage Task.
- options
- StorageTasksCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageTask>, StorageTask>>
beginCreateAndWait(string, string, StorageTask, StorageTasksCreateOptionalParams)
Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
function beginCreateAndWait(resourceGroupName: string, storageTaskName: string, parameters: StorageTask, options?: StorageTasksCreateOptionalParams): Promise<StorageTask>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- parameters
- StorageTask
The parameters to create a Storage Task.
- options
- StorageTasksCreateOptionalParams
The options parameters.
Returns
Promise<StorageTask>
beginDelete(string, string, StorageTasksDeleteOptionalParams)
Delete the storage task resource.
function beginDelete(resourceGroupName: string, storageTaskName: string, options?: StorageTasksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StorageTasksDeleteHeaders>, StorageTasksDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- options
- StorageTasksDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageTasksDeleteHeaders>, StorageTasksDeleteHeaders>>
beginDeleteAndWait(string, string, StorageTasksDeleteOptionalParams)
Delete the storage task resource.
function beginDeleteAndWait(resourceGroupName: string, storageTaskName: string, options?: StorageTasksDeleteOptionalParams): Promise<StorageTasksDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- options
- StorageTasksDeleteOptionalParams
The options parameters.
Returns
Promise<StorageTasksDeleteHeaders>
beginUpdate(string, string, StorageTaskUpdateParameters, StorageTasksUpdateOptionalParams)
Update storage task properties
function beginUpdate(resourceGroupName: string, storageTaskName: string, parameters: StorageTaskUpdateParameters, options?: StorageTasksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StorageTask>, StorageTask>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- parameters
- StorageTaskUpdateParameters
The parameters to provide to update the storage task resource.
- options
- StorageTasksUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageTask>, StorageTask>>
beginUpdateAndWait(string, string, StorageTaskUpdateParameters, StorageTasksUpdateOptionalParams)
Update storage task properties
function beginUpdateAndWait(resourceGroupName: string, storageTaskName: string, parameters: StorageTaskUpdateParameters, options?: StorageTasksUpdateOptionalParams): Promise<StorageTask>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- parameters
- StorageTaskUpdateParameters
The parameters to provide to update the storage task resource.
- options
- StorageTasksUpdateOptionalParams
The options parameters.
Returns
Promise<StorageTask>
get(string, string, StorageTasksGetOptionalParams)
Get the storage task properties
function get(resourceGroupName: string, storageTaskName: string, options?: StorageTasksGetOptionalParams): Promise<StorageTask>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageTaskName
-
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
- options
- StorageTasksGetOptionalParams
The options parameters.
Returns
Promise<StorageTask>
listByResourceGroup(string, StorageTasksListByResourceGroupOptionalParams)
Lists all the storage tasks available under the given resource group.
function listByResourceGroup(resourceGroupName: string, options?: StorageTasksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageTask, StorageTask[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(StorageTasksListBySubscriptionOptionalParams)
Lists all the storage tasks available under the subscription.
function listBySubscription(options?: StorageTasksListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StorageTask, StorageTask[], PageSettings>Parameters
The options parameters.
Returns
previewActions(string, StorageTaskPreviewAction, StorageTasksPreviewActionsOptionalParams)
Runs the input conditions against input object metadata properties and designates matched objects in response.
function previewActions(location: string, parameters: StorageTaskPreviewAction, options?: StorageTasksPreviewActionsOptionalParams): Promise<StorageTaskPreviewAction>Parameters
- location
-
string
The location to perform preview of the actions.
- parameters
- StorageTaskPreviewAction
The parameters to preview action condition.
The options parameters.
Returns
Promise<StorageTaskPreviewAction>
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