Interface BackupShortTermRetentionPoliciesClient


  • public interface BackupShortTermRetentionPoliciesClient
    An instance of this class provides access to all the operations defined in BackupShortTermRetentionPoliciesClient.
    • Method Detail

      • getWithResponseAsync

        Mono<com.azure.core.http.rest.Response<BackupShortTermRetentionPolicyInner>> getWithResponseAsync​(String resourceGroupName,
                                                                                                          String serverName,
                                                                                                          String databaseName,
                                                                                                          ShortTermRetentionPolicyName policyName)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAsync

        Mono<BackupShortTermRetentionPolicyInner> getAsync​(String resourceGroupName,
                                                           String serverName,
                                                           String databaseName,
                                                           ShortTermRetentionPolicyName policyName)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        BackupShortTermRetentionPolicyInner get​(String resourceGroupName,
                                                String serverName,
                                                String databaseName,
                                                ShortTermRetentionPolicyName policyName)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<BackupShortTermRetentionPolicyInner> getWithResponse​(String resourceGroupName,
                                                                                               String serverName,
                                                                                               String databaseName,
                                                                                               ShortTermRetentionPolicyName policyName,
                                                                                               com.azure.core.util.Context context)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        context - The context to associate with this operation.
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync​(String resourceGroupName,
                                                                                                  String serverName,
                                                                                                  String databaseName,
                                                                                                  ShortTermRetentionPolicyName policyName,
                                                                                                  Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginCreateOrUpdateAsync​(String resourceGroupName,
                                                                                                                                                                                                     String serverName,
                                                                                                                                                                                                     String databaseName,
                                                                                                                                                                                                     ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                                     Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                                String serverName,
                                                                                                                                                                                                String databaseName,
                                                                                                                                                                                                ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                                Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                                String serverName,
                                                                                                                                                                                                String databaseName,
                                                                                                                                                                                                ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                                Integer retentionDays,
                                                                                                                                                                                                com.azure.core.util.Context context)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        context - The context to associate with this operation.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdateAsync

        Mono<BackupShortTermRetentionPolicyInner> createOrUpdateAsync​(String resourceGroupName,
                                                                      String serverName,
                                                                      String databaseName,
                                                                      ShortTermRetentionPolicyName policyName,
                                                                      Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdateAsync

        Mono<BackupShortTermRetentionPolicyInner> createOrUpdateAsync​(String resourceGroupName,
                                                                      String serverName,
                                                                      String databaseName,
                                                                      ShortTermRetentionPolicyName policyName)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        BackupShortTermRetentionPolicyInner createOrUpdate​(String resourceGroupName,
                                                           String serverName,
                                                           String databaseName,
                                                           ShortTermRetentionPolicyName policyName,
                                                           Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        BackupShortTermRetentionPolicyInner createOrUpdate​(String resourceGroupName,
                                                           String serverName,
                                                           String databaseName,
                                                           ShortTermRetentionPolicyName policyName,
                                                           Integer retentionDays,
                                                           com.azure.core.util.Context context)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        context - The context to associate with this operation.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        BackupShortTermRetentionPolicyInner createOrUpdate​(String resourceGroupName,
                                                           String serverName,
                                                           String databaseName,
                                                           ShortTermRetentionPolicyName policyName)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> updateWithResponseAsync​(String resourceGroupName,
                                                                                          String serverName,
                                                                                          String databaseName,
                                                                                          ShortTermRetentionPolicyName policyName,
                                                                                          Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginUpdateAsync​(String resourceGroupName,
                                                                                                                                                                                             String serverName,
                                                                                                                                                                                             String databaseName,
                                                                                                                                                                                             ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                             Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                                                        String serverName,
                                                                                                                                                                                        String databaseName,
                                                                                                                                                                                        ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                        Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BackupShortTermRetentionPolicyInner>,​BackupShortTermRetentionPolicyInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                                                        String serverName,
                                                                                                                                                                                        String databaseName,
                                                                                                                                                                                        ShortTermRetentionPolicyName policyName,
                                                                                                                                                                                        Integer retentionDays,
                                                                                                                                                                                        com.azure.core.util.Context context)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        context - The context to associate with this operation.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAsync

        Mono<BackupShortTermRetentionPolicyInner> updateAsync​(String resourceGroupName,
                                                              String serverName,
                                                              String databaseName,
                                                              ShortTermRetentionPolicyName policyName,
                                                              Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAsync

        Mono<BackupShortTermRetentionPolicyInner> updateAsync​(String resourceGroupName,
                                                              String serverName,
                                                              String databaseName,
                                                              ShortTermRetentionPolicyName policyName)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • update

        BackupShortTermRetentionPolicyInner update​(String resourceGroupName,
                                                   String serverName,
                                                   String databaseName,
                                                   ShortTermRetentionPolicyName policyName,
                                                   Integer retentionDays)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • update

        BackupShortTermRetentionPolicyInner update​(String resourceGroupName,
                                                   String serverName,
                                                   String databaseName,
                                                   ShortTermRetentionPolicyName policyName,
                                                   Integer retentionDays,
                                                   com.azure.core.util.Context context)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        retentionDays - The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
        context - The context to associate with this operation.
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • update

        BackupShortTermRetentionPolicyInner update​(String resourceGroupName,
                                                   String serverName,
                                                   String databaseName,
                                                   ShortTermRetentionPolicyName policyName)
        Updates a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        policyName - The policy name. Should always be "default".
        Returns:
        a short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByDatabaseAsync

        com.azure.core.http.rest.PagedFlux<BackupShortTermRetentionPolicyInner> listByDatabaseAsync​(String resourceGroupName,
                                                                                                    String serverName,
                                                                                                    String databaseName)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByDatabase

        com.azure.core.http.rest.PagedIterable<BackupShortTermRetentionPolicyInner> listByDatabase​(String resourceGroupName,
                                                                                                   String serverName,
                                                                                                   String databaseName)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByDatabase

        com.azure.core.http.rest.PagedIterable<BackupShortTermRetentionPolicyInner> listByDatabase​(String resourceGroupName,
                                                                                                   String serverName,
                                                                                                   String databaseName,
                                                                                                   com.azure.core.util.Context context)
        Gets a database's short term retention policy.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        serverName - The name of the server.
        databaseName - The name of the database.
        context - The context to associate with this operation.
        Returns:
        a database's short term retention policy.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.