Skip to main content

suspend_service_backups

Creates, updates, deletes, gets or lists a suspend_service_backups resource.

Overview

Namesuspend_service_backups
TypeResource
Idazure.service_fabric_dataplane.suspend_service_backups

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
suspend_service_backupexecservice_id, endpointtimeoutSuspends periodic backup for the specified Service Fabric service. The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme). (default: )
service_idstringThe identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myappapp1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
timeoutinteger (int64)The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Lifecycle Methods

Suspends periodic backup for the specified Service Fabric service. The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.

EXEC azure.service_fabric_dataplane.suspend_service_backups.suspend_service_backup 
@service_id='{{ service_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeout='{{ timeout }}'
;