Package com.azure.resourcemanager.deploymentmanager.models

Interface Rollouts

public interface Rollouts
Resource collection API of Rollouts.

  • Method Details

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Rollout> getByResourceGroupWithResponse(String resourceGroupName, String rolloutName, Integer retryAttempt, com.azure.core.util.Context context)
      Gets detailed information of a rollout.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      retryAttempt - Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.
      context - The context to associate with this operation.
      Returns:
      detailed information of a rollout 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.

    • getByResourceGroup

      Rollout getByResourceGroup(String resourceGroupName, String rolloutName)
      Gets detailed information of a rollout.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      Returns:
      detailed information of a rollout.
      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.

    • deleteByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String rolloutName, com.azure.core.util.Context context)
      Deletes a rollout resource.

      Only rollouts in terminal state can be deleted.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      context - The context to associate with this operation.
      Returns:
      the 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String rolloutName)
      Deletes a rollout resource.

      Only rollouts in terminal state can be deleted.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      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.

    • cancelWithResponse

      com.azure.core.http.rest.Response<Rollout> cancelWithResponse(String resourceGroupName, String rolloutName, com.azure.core.util.Context context)
      Stops a running rollout.

      Only running rollouts can be canceled.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      context - The context to associate with this operation.
      Returns:
      defines the rollout 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.

    • cancel

      Rollout cancel(String resourceGroupName, String rolloutName)
      Stops a running rollout.

      Only running rollouts can be canceled.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      Returns:
      defines the rollout.
      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.

    • restartWithResponse

      com.azure.core.http.rest.Response<Rollout> restartWithResponse(String resourceGroupName, String rolloutName, Boolean skipSucceeded, com.azure.core.util.Context context)
      Restarts a failed rollout and optionally skips all succeeded steps.

      Only failed rollouts can be restarted.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      skipSucceeded - If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified.
      context - The context to associate with this operation.
      Returns:
      defines the rollout 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.

    • restart

      Rollout restart(String resourceGroupName, String rolloutName)
      Restarts a failed rollout and optionally skips all succeeded steps.

      Only failed rollouts can be restarted.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      rolloutName - The rollout name.
      Returns:
      defines the rollout.
      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.

    • listWithResponse

      com.azure.core.http.rest.Response<List<Rollout>> listWithResponse(String resourceGroupName, com.azure.core.util.Context context)
      Lists the rollouts in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      the list of rollouts 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.

    • list

      List<Rollout> list(String resourceGroupName)
      Lists the rollouts in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the list of rollouts.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a rollout resource.

      Only rollouts in terminal state can be deleted.

      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a rollout resource.

      Only rollouts in terminal state can be deleted.

      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the 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.

    • define

      RolloutRequest.DefinitionStages.Blank define(String name)
      Begins definition for a new RolloutRequest resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new RolloutRequest definition.