Package com.azure.resourcemanager.deploymentmanager.models

Interface RolloutRequest

public interface RolloutRequest
An immutable client-side representation of RolloutRequest.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RolloutRequest.Definition
    The entirety of the RolloutRequest definition.
    static interface 
    RolloutRequest.DefinitionStages
    The RolloutRequest definition stages.
    static interface 
    RolloutRequest.Update
    The template for RolloutRequest update.
    static interface 
    RolloutRequest.UpdateStages
    The RolloutRequest update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    artifactSourceId()
    Gets the artifactSourceId property: The reference to the artifact source resource Id where the payload is located.
    String
    buildVersion()
    Gets the buildVersion property: The version of the build being deployed.
    Rollout
    cancel()
    Stops a running rollout.
    com.azure.core.http.rest.Response<Rollout>
    cancelWithResponse(com.azure.core.util.Context context)
    Stops a running rollout.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    Identity
    identity()
    Gets the identity property: Identity for the resource.
    RolloutRequestInner
    innerModel()
    Gets the inner com.azure.resourcemanager.deploymentmanager.fluent.models.RolloutRequestInner object.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    String
    name()
    Gets the name property: The name of the resource.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    Rollout
    restart()
    Restarts a failed rollout and optionally skips all succeeded steps.
    com.azure.core.http.rest.Response<Rollout>
    restartWithResponse(Boolean skipSucceeded, com.azure.core.util.Context context)
    Restarts a failed rollout and optionally skips all succeeded steps.
    List<StepGroup>
    stepGroups()
    Gets the stepGroups property: The list of step groups that define the orchestration.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    targetServiceTopologyId()
    Gets the targetServiceTopologyId property: The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
    String
    type()
    Gets the type property: The type of the resource.
    RolloutRequest.Update
    update()
    Begins update for the RolloutRequest resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • identity

      Identity identity()
      Gets the identity property: Identity for the resource.
      Returns:
      the identity value.

    • buildVersion

      String buildVersion()
      Gets the buildVersion property: The version of the build being deployed.
      Returns:
      the buildVersion value.

    • artifactSourceId

      String artifactSourceId()
      Gets the artifactSourceId property: The reference to the artifact source resource Id where the payload is located.
      Returns:
      the artifactSourceId value.

    • targetServiceTopologyId

      String targetServiceTopologyId()
      Gets the targetServiceTopologyId property: The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
      Returns:
      the targetServiceTopologyId value.

    • stepGroups

      List<StepGroup> stepGroups()
      Gets the stepGroups property: The list of step groups that define the orchestration.
      Returns:
      the stepGroups value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      RolloutRequestInner innerModel()
      Gets the inner com.azure.resourcemanager.deploymentmanager.fluent.models.RolloutRequestInner object.
      Returns:
      the inner object.

    • update

      RolloutRequest.Update update()
      Begins update for the RolloutRequest resource.
      Returns:
      the stage of resource update.

    • cancelWithResponse

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

      Only running rollouts can be canceled.

      Parameters:
      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()
      Stops a running rollout.

      Only running rollouts can be canceled.

      Returns:
      defines the rollout.
      Throws:
      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(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:
      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()
      Restarts a failed rollout and optionally skips all succeeded steps.

      Only failed rollouts can be restarted.

      Returns:
      defines the rollout.
      Throws:
      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.