ComposeDeploymentUpgradeDescription Class

Describes the parameters for a compose deployment upgrade.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

ComposeDeploymentUpgradeDescription

Constructor

ComposeDeploymentUpgradeDescription(*, deployment_name: str, compose_file_content: str, registry_credential=None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: Optional[int] = None, force_restart: Optional[bool] = None, monitoring_policy=None, application_health_policy=None, **kwargs)

Parameters

deployment_name

str

Required

Required. The name of the deployment.

compose_file_content

str

Required

Required. The content of the compose file that describes the deployment to create.

registry_credential

RegistryCredential

Required

Credential information to connect to container registry.

upgrade_kind

str or UpgradeKind

Required

Required. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: "Rolling" .

rolling_upgrade_mode

str or UpgradeMode

Required

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred'. Default value: "UnmonitoredAuto" .

upgrade_replica_set_check_timeout_in_seconds

<xref:long>

Required

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

force_restart

bool

Required

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

monitoring_policy

MonitoringPolicyDescription

Required

Describes the parameters for monitoring an upgrade in Monitored mode.

application_health_policy

ApplicationHealthPolicy

Required

Defines a health policy used to evaluate the health of an application or one of its children entities.