{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector BackupRestore API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "BackupRestore", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Creates A Backup Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/BackupRestore/BackupPolicies/$/Create", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "ValidateConnection", "value": "", "type": "query", "description": "Specifies whether to validate the storage connection and credentials before creating or updating the backup policies." } ] }, "docs": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup." }, { "info": { "name": "Microsoft Azure Deletes The Backup Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/BackupRestore/BackupPolicies/:backupPolicyName/$/Delete", "params": [ { "name": "backupPolicyName", "value": "", "type": "path", "description": "The name of the backup policy." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping." }, { "info": { "name": "Microsoft Azure Gets All The Backup Policies Configured", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/BackupRestore/BackupPolicies", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Get a list of all the backup policies configured." }, { "info": { "name": "Microsoft Azure Gets A Particular Backup Policy By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/BackupRestore/BackupPolicies/:backupPolicyName", "params": [ { "name": "backupPolicyName", "value": "", "type": "path", "description": "The name of the backup policy." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Gets a particular backup policy identified by {backupPolicyName}" }, { "info": { "name": "Microsoft Azure Gets The List Of Backup Entities That Are Associated With This Policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/BackupRestore/BackupPolicies/:backupPolicyName/$/GetBackupEnabledEntities", "params": [ { "name": "backupPolicyName", "value": "", "type": "path", "description": "The name of the backup policy." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy." }, { "info": { "name": "Microsoft Azure Updates The Backup Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/BackupRestore/BackupPolicies/:backupPolicyName/$/Update", "params": [ { "name": "backupPolicyName", "value": "", "type": "path", "description": "The name of the backup policy." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "ValidateConnection", "value": "", "type": "query", "description": "Specifies whether to validate the storage connection and credentials before creating or updating the backup policies." } ] }, "docs": "Updates the backup policy identified by {backupPolicyName}" }, { "info": { "name": "Microsoft Azure Enables Periodic Backup Of Stateful Partitions Under This Service Fabric Application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Applications/:applicationId/$/EnableBackup", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description.
Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup." }, { "info": { "name": "Microsoft Azure Disables Periodic Backup Of Service Fabric Application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Applications/:applicationId/$/DisableBackup", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Disables periodic backup of Service Fabric application which was previously enabled." }, { "info": { "name": "Microsoft Azure Gets The Service Fabric Application Backup Configuration Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Applications/:applicationId/$/GetBackupConfigurationInfo", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application." }, { "info": { "name": "Microsoft Azure Gets The List Of Backups Available For Every Partition In This Application", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Applications/:applicationId/$/GetBackups", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "Latest", "value": "", "type": "query", "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range." }, { "name": "StartDateTimeFilter", "value": "", "type": "query", "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." }, { "name": "EndDateTimeFilter", "value": "", "type": "query", "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." } ] }, "docs": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition." }, { "info": { "name": "Microsoft Azure Suspends Periodic Backup For The Specified Service Fabric Application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Applications/:applicationId/$/SuspendBackup", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup." }, { "info": { "name": "Microsoft Azure Resumes Periodic Backup Of A Service Fabric Application Which Was Previously Suspended", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Applications/:applicationId/$/ResumeBackup", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same." }, { "info": { "name": "Microsoft Azure Enables Periodic Backup Of Stateful Partitions Under This Service Fabric Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Services/:serviceId/$/EnableBackup", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).
Note only C# based Reliable Actor and Reliable Statef" }, { "info": { "name": "Microsoft Azure Disables Periodic Backup Of Service Fabric Service Which Was Previously Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Services/:serviceId/$/DisableBackup", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level." }, { "info": { "name": "Microsoft Azure Gets The Service Fabric Service Backup Configuration Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Services/:serviceId/$/GetBackupConfigurationInfo", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Gets the Service Fabric backup configuration information for the service and the partitions under this service." }, { "info": { "name": "Microsoft Azure Gets The List Of Backups Available For Every Partition In This Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Services/:serviceId/$/GetBackups", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "Latest", "value": "", "type": "query", "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range." }, { "name": "StartDateTimeFilter", "value": "", "type": "query", "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." }, { "name": "EndDateTimeFilter", "value": "", "type": "query", "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." } ] }, "docs": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition." }, { "info": { "name": "Microsoft Azure Suspends Periodic Backup For The Specified Service Fabric Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Services/:serviceId/$/SuspendBackup", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Resumes Periodic Backup Of A Service Fabric Service Which Was Previously Suspended", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Services/:serviceId/$/ResumeBackup", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same." }, { "info": { "name": "Microsoft Azure Enables Periodic Backup Of The Stateful Persisted Partition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/EnableBackup", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.
Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup." }, { "info": { "name": "Microsoft Azure Disables Periodic Backup Of Service Fabric Partition Which Was Previously Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/DisableBackup", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity." }, { "info": { "name": "Microsoft Azure Gets The Partition Backup Configuration Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Partitions/:partitionId/$/GetBackupConfigurationInfo", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Gets the Service Fabric Backup configuration information for the specified partition." }, { "info": { "name": "Microsoft Azure Gets The List Of Backups Available For The Specified Partition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Partitions/:partitionId/$/GetBackups", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "Latest", "value": "", "type": "query", "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range." }, { "name": "StartDateTimeFilter", "value": "", "type": "query", "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." }, { "name": "EndDateTimeFilter", "value": "", "type": "query", "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." } ] }, "docs": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition." }, { "info": { "name": "Microsoft Azure Suspends Periodic Backup For The Specified Partition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/SuspendBackup", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again." }, { "info": { "name": "Microsoft Azure Resumes Periodic Backup Of Partition Which Was Previously Suspended", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/ResumeBackup", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same." }, { "info": { "name": "Microsoft Azure Triggers Backup Of The Partition S State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/Backup", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "BackupTimeout", "value": "", "type": "query", "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation.
In case, the operation times out, specify a greater backup timeout value in the query parameter." }, { "info": { "name": "Microsoft Azure Gets Details For The Latest Backup Triggered For This Partition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Partitions/:partitionId/$/GetBackupProgress", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns information about the state of the latest backup along with details or failure reason in case of completion." }, { "info": { "name": "Microsoft Azure Triggers Restore Of The State Of The Partition Using The Specified Restore Partition Description", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Partitions/:partitionId/$/Restore", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "RestoreTimeout", "value": "", "type": "query", "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation.
In case, the operation t" }, { "info": { "name": "Microsoft Azure Gets Details For The Latest Restore Operation Triggered For This Partition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Partitions/:partitionId/$/GetRestoreProgress", "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "The identity of the partition." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion." }, { "info": { "name": "Microsoft Azure Gets The List Of Backups Available For The Specified Backed Up Entity At The Specified Backup Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/BackupRestore/$/GetBackups", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "timeout", "value": "", "type": "query", "description": "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." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." } ] }, "docs": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage)." } ] } ], "bundled": true }