BackupVaults interface
Interface representing a BackupVaults.
Methods
Method Details
beginCreateOrUpdate(string, string, BackupVaultResource, BackupVaultsCreateOrUpdateOptionalParams)
Creates or updates a BackupVault resource belonging to a resource group.
function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: BackupVaultResource, options?: BackupVaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupVaultResource>, BackupVaultResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- BackupVaultResource
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupVaultResource>, BackupVaultResource>>
beginCreateOrUpdateAndWait(string, string, BackupVaultResource, BackupVaultsCreateOrUpdateOptionalParams)
Creates or updates a BackupVault resource belonging to a resource group.
function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: BackupVaultResource, options?: BackupVaultsCreateOrUpdateOptionalParams): Promise<BackupVaultResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- BackupVaultResource
Request body for operation
The options parameters.
Returns
Promise<BackupVaultResource>
beginDelete(string, string, BackupVaultsDeleteOptionalParams)
Deletes a BackupVault resource from the resource group.
function beginDelete(resourceGroupName: string, vaultName: string, options?: BackupVaultsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- options
- BackupVaultsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, BackupVaultsDeleteOptionalParams)
Deletes a BackupVault resource from the resource group.
function beginDeleteAndWait(resourceGroupName: string, vaultName: string, options?: BackupVaultsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- options
- BackupVaultsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, PatchResourceRequestInput, BackupVaultsUpdateOptionalParams)
Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
function beginUpdate(resourceGroupName: string, vaultName: string, parameters: PatchResourceRequestInput, options?: BackupVaultsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupVaultResource>, BackupVaultResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- PatchResourceRequestInput
Request body for operation
- options
- BackupVaultsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupVaultResource>, BackupVaultResource>>
beginUpdateAndWait(string, string, PatchResourceRequestInput, BackupVaultsUpdateOptionalParams)
Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
function beginUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: PatchResourceRequestInput, options?: BackupVaultsUpdateOptionalParams): Promise<BackupVaultResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- PatchResourceRequestInput
Request body for operation
- options
- BackupVaultsUpdateOptionalParams
The options parameters.
Returns
Promise<BackupVaultResource>
checkNameAvailability(string, string, CheckNameAvailabilityRequest, BackupVaultsCheckNameAvailabilityOptionalParams)
API to check for resource name availability
function checkNameAvailability(resourceGroupName: string, location: string, parameters: CheckNameAvailabilityRequest, options?: BackupVaultsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The location in which uniqueness will be verified.
- parameters
- CheckNameAvailabilityRequest
Check name availability request
The options parameters.
Returns
Promise<CheckNameAvailabilityResult>
get(string, string, BackupVaultsGetOptionalParams)
Returns a resource belonging to a resource group.
function get(resourceGroupName: string, vaultName: string, options?: BackupVaultsGetOptionalParams): Promise<BackupVaultResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- options
- BackupVaultsGetOptionalParams
The options parameters.
Returns
Promise<BackupVaultResource>
listInResourceGroup(string, BackupVaultsGetInResourceGroupOptionalParams)
Returns resource collection belonging to a resource group.
function listInResourceGroup(resourceGroupName: string, options?: BackupVaultsGetInResourceGroupOptionalParams): PagedAsyncIterableIterator<BackupVaultResource, BackupVaultResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listInSubscription(BackupVaultsGetInSubscriptionOptionalParams)
Returns resource collection belonging to a subscription.
function listInSubscription(options?: BackupVaultsGetInSubscriptionOptionalParams): PagedAsyncIterableIterator<BackupVaultResource, BackupVaultResource[], PageSettings>Parameters
The options parameters.