Interface SnapshotsClient


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

      • list

        com.azure.core.http.rest.PagedIterable<SnapshotInner> list​(String resourceGroupName,
                                                                   String accountName,
                                                                   String poolName,
                                                                   String volumeName)
        List all snapshots associated with the volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        Returns:
        list of Snapshots as paginated response with PagedIterable.
        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.
      • list

        com.azure.core.http.rest.PagedIterable<SnapshotInner> list​(String resourceGroupName,
                                                                   String accountName,
                                                                   String poolName,
                                                                   String volumeName,
                                                                   com.azure.core.util.Context context)
        List all snapshots associated with the volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        context - The context to associate with this operation.
        Returns:
        list of Snapshots as paginated response with PagedIterable.
        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

        SnapshotInner get​(String resourceGroupName,
                          String accountName,
                          String poolName,
                          String volumeName,
                          String snapshotName)
        Get details of the specified snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        Returns:
        details of the specified snapshot.
        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<SnapshotInner> getWithResponse​(String resourceGroupName,
                                                                         String accountName,
                                                                         String poolName,
                                                                         String volumeName,
                                                                         String snapshotName,
                                                                         com.azure.core.util.Context context)
        Get details of the specified snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        context - The context to associate with this operation.
        Returns:
        details of the specified snapshot along with Response.
        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.
      • beginCreate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SnapshotInner>,​SnapshotInner> beginCreate​(String resourceGroupName,
                                                                                                                                            String accountName,
                                                                                                                                            String poolName,
                                                                                                                                            String volumeName,
                                                                                                                                            String snapshotName,
                                                                                                                                            SnapshotInner body)
        Create the specified snapshot within the given volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        Returns:
        the SyncPoller for polling of snapshot of a Volume.
        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.
      • beginCreate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SnapshotInner>,​SnapshotInner> beginCreate​(String resourceGroupName,
                                                                                                                                            String accountName,
                                                                                                                                            String poolName,
                                                                                                                                            String volumeName,
                                                                                                                                            String snapshotName,
                                                                                                                                            SnapshotInner body,
                                                                                                                                            com.azure.core.util.Context context)
        Create the specified snapshot within the given volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of snapshot of a Volume.
        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.
      • create

        SnapshotInner create​(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName,
                             String snapshotName,
                             SnapshotInner body)
        Create the specified snapshot within the given volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        Returns:
        snapshot of a Volume.
        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.
      • create

        SnapshotInner create​(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName,
                             String snapshotName,
                             SnapshotInner body,
                             com.azure.core.util.Context context)
        Create the specified snapshot within the given volume.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        context - The context to associate with this operation.
        Returns:
        snapshot of a Volume.
        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<SnapshotInner>,​SnapshotInner> beginUpdate​(String resourceGroupName,
                                                                                                                                            String accountName,
                                                                                                                                            String poolName,
                                                                                                                                            String volumeName,
                                                                                                                                            String snapshotName,
                                                                                                                                            Object body)
        Patch a snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        Returns:
        the SyncPoller for polling of snapshot of a Volume.
        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<SnapshotInner>,​SnapshotInner> beginUpdate​(String resourceGroupName,
                                                                                                                                            String accountName,
                                                                                                                                            String poolName,
                                                                                                                                            String volumeName,
                                                                                                                                            String snapshotName,
                                                                                                                                            Object body,
                                                                                                                                            com.azure.core.util.Context context)
        Patch a snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of snapshot of a Volume.
        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

        SnapshotInner update​(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName,
                             String snapshotName,
                             Object body)
        Patch a snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        Returns:
        snapshot of a Volume.
        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

        SnapshotInner update​(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName,
                             String snapshotName,
                             Object body,
                             com.azure.core.util.Context context)
        Patch a snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Snapshot object supplied in the body of the operation.
        context - The context to associate with this operation.
        Returns:
        snapshot of a Volume.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String accountName,
                                                                                                                          String poolName,
                                                                                                                          String volumeName,
                                                                                                                          String snapshotName)
        Delete snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String accountName,
                                                                                                                          String poolName,
                                                                                                                          String volumeName,
                                                                                                                          String snapshotName,
                                                                                                                          com.azure.core.util.Context context)
        Delete snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String accountName,
                    String poolName,
                    String volumeName,
                    String snapshotName)
        Delete snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String accountName,
                    String poolName,
                    String volumeName,
                    String snapshotName,
                    com.azure.core.util.Context context)
        Delete snapshot.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        context - The context to associate with this operation.
        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.
      • beginRestoreFiles

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRestoreFiles​(String resourceGroupName,
                                                                                                                                String accountName,
                                                                                                                                String poolName,
                                                                                                                                String volumeName,
                                                                                                                                String snapshotName,
                                                                                                                                SnapshotRestoreFiles body)
        Restore the specified files from the specified snapshot to the active filesystem.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Restore payload supplied in the body of the operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.
      • beginRestoreFiles

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRestoreFiles​(String resourceGroupName,
                                                                                                                                String accountName,
                                                                                                                                String poolName,
                                                                                                                                String volumeName,
                                                                                                                                String snapshotName,
                                                                                                                                SnapshotRestoreFiles body,
                                                                                                                                com.azure.core.util.Context context)
        Restore the specified files from the specified snapshot to the active filesystem.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Restore payload supplied in the body of the operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.
      • restoreFiles

        void restoreFiles​(String resourceGroupName,
                          String accountName,
                          String poolName,
                          String volumeName,
                          String snapshotName,
                          SnapshotRestoreFiles body)
        Restore the specified files from the specified snapshot to the active filesystem.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Restore payload supplied in the body of the operation.
        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.
      • restoreFiles

        void restoreFiles​(String resourceGroupName,
                          String accountName,
                          String poolName,
                          String volumeName,
                          String snapshotName,
                          SnapshotRestoreFiles body,
                          com.azure.core.util.Context context)
        Restore the specified files from the specified snapshot to the active filesystem.
        Parameters:
        resourceGroupName - The name of the resource group.
        accountName - The name of the NetApp account.
        poolName - The name of the capacity pool.
        volumeName - The name of the volume.
        snapshotName - The name of the snapshot.
        body - Restore payload supplied in the body of the operation.
        context - The context to associate with this operation.
        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.