ServiceResourceDescription Class

This type describes a service resource.

Variables are only populated by the server, and will be ignored when sending a request.

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

Inheritance

Model

ServiceResourceDescription

Constructor

ServiceResourceDescription(*, name: str, os_type, code_packages, network_refs=None, diagnostics=None, description: Optional[str] = None, replica_count: Optional[int] = None, execution_policy=None, auto_scaling_policies=None, identity_refs=None, dns_name: Optional[str] = None, **kwargs)

Parameters

name

str

Required

Required. Name of the Service resource.

os_type

str or OperatingSystemType

Required

Required. The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

code_packages

list[ContainerCodePackageProperties]

Required

Required. Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

network_refs

list[NetworkRef]

Required

The names of the private networks that this service needs to be part of.

diagnostics

DiagnosticsRef

Required

Reference to sinks in DiagnosticsDescription.

description

str

Required

User readable description of the service.

replica_count

int

Required

The number of replicas of the service to create. Defaults to 1 if not specified.

execution_policy

ExecutionPolicy

Required

The execution policy of the service

auto_scaling_policies

list[AutoScalingPolicy]

Required

Auto scaling policies

identity_refs

list[ServiceIdentity]

Required

The service identity list.

dns_name

str

Required

Dns name of the service.

Variables

status

str or ResourceStatus

Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'

status_details

str

Gives additional information about the current status of the service.

health_state

str or HealthState

Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

unhealthy_evaluation

str

When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.