RolloutsOperations Class

RolloutsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

RolloutsOperations

Constructor

RolloutsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates or updates a rollout. This is an asynchronous operation and can be polled to completion using the location header returned by this operation.
cancel	Stops a running rollout. Only running rollouts can be canceled.
delete	Deletes a rollout resource. Only rollouts in terminal state can be deleted.
get	Gets detailed information of a rollout. Gets detailed information of a rollout.
list	Lists the rollouts in a resource group. Lists the rollouts in a resource group.
restart	Restarts a failed rollout and optionally skips all succeeded steps. Only failed rollouts can be restarted.

begin_create_or_update

Creates or updates a rollout.

This is an asynchronous operation and can be polled to completion using the location header returned by this operation.

begin_create_or_update(resource_group_name: str, rollout_name: str, rollout_request: Optional[_models.RolloutRequest] = None, **kwargs: Any) -> LROPoller[_models.RolloutRequest]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

rollout_name

str

Required

The rollout name.

rollout_request

RolloutRequest

default value: None

Source rollout request object that defines the rollout.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either RolloutRequest or the result of cls(response)

Return type

LROPoller[RolloutRequest]

Exceptions

HttpResponseError

cancel

Stops a running rollout.

Only running rollouts can be canceled.

cancel(resource_group_name: str, rollout_name: str, **kwargs: Any) -> _models.Rollout

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

rollout_name

str

Required

The rollout name.

cls

callable

A custom type or function that will be passed the direct response

Returns

Rollout, or the result of cls(response)

Return type

Rollout

Exceptions

HttpResponseError

delete

Deletes a rollout resource.

Only rollouts in terminal state can be deleted.

delete(resource_group_name: str, rollout_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

rollout_name

str

Required

The rollout name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets detailed information of a rollout.

Gets detailed information of a rollout.

get(resource_group_name: str, rollout_name: str, retry_attempt: Optional[int] = None, **kwargs: Any) -> _models.Rollout

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

rollout_name

str

Required

The rollout name.

retry_attempt

int

default value: None

Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.

cls

callable

A custom type or function that will be passed the direct response

Returns

Rollout, or the result of cls(response)

Return type

Rollout

Exceptions

HttpResponseError

list

Lists the rollouts in a resource group.

Lists the rollouts in a resource group.

list(resource_group_name: str, **kwargs: Any) -> List[_models.Rollout]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of Rollout, or the result of cls(response)

Return type

list[Rollout]

Exceptions

HttpResponseError

restart

Restarts a failed rollout and optionally skips all succeeded steps.

Only failed rollouts can be restarted.

restart(resource_group_name: str, rollout_name: str, skip_succeeded: Optional[bool] = None, **kwargs: Any) -> _models.Rollout

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

rollout_name

str

Required

The rollout name.

skip_succeeded

bool

default value: None

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

Rollout, or the result of cls(response)

Return type

Rollout

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.deploymentmanager.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\deploymentmanager\\models\\__init__.py'>