Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
83 changes: 83 additions & 0 deletions azure-servicefabric/azure/servicefabric/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,31 @@
from .chaos_move_primary_fault_scheduled_event_py3 import ChaosMovePrimaryFaultScheduledEvent
from .chaos_restart_replica_fault_scheduled_event_py3 import ChaosRestartReplicaFaultScheduledEvent
from .chaos_restart_node_fault_scheduled_event_py3 import ChaosRestartNodeFaultScheduledEvent
from .service_resource_description_py3 import ServiceResourceDescription
from .diagnostics_sink_properties_py3 import DiagnosticsSinkProperties
from .diagnostics_description_py3 import DiagnosticsDescription
from .application_resource_description_py3 import ApplicationResourceDescription
from .paged_service_resource_description_list_py3 import PagedServiceResourceDescriptionList
from .service_resource_replica_description_py3 import ServiceResourceReplicaDescription
from .paged_service_resource_replica_description_list_py3 import PagedServiceResourceReplicaDescriptionList
from .volume_provider_parameters_azure_file_py3 import VolumeProviderParametersAzureFile
from .volume_resource_description_py3 import VolumeResourceDescription
from .image_registry_credential_py3 import ImageRegistryCredential
from .environment_variable_py3 import EnvironmentVariable
from .setting_py3 import Setting
from .container_label_py3 import ContainerLabel
from .endpoint_properties_py3 import EndpointProperties
from .resource_requests_py3 import ResourceRequests
from .resource_limits_py3 import ResourceLimits
from .resource_requirements_py3 import ResourceRequirements
from .container_volume_py3 import ContainerVolume
from .container_state_py3 import ContainerState
from .container_event_py3 import ContainerEvent
from .container_instance_view_py3 import ContainerInstanceView
from .diagnostics_ref_py3 import DiagnosticsRef
from .container_code_package_properties_py3 import ContainerCodePackageProperties
from .network_ref_py3 import NetworkRef
from .service_replica_properties_py3 import ServiceReplicaProperties
except (SyntaxError, ImportError):
from .aad_metadata import AadMetadata
from .aad_metadata_object import AadMetadataObject
Expand Down Expand Up @@ -837,6 +862,31 @@
from .chaos_move_primary_fault_scheduled_event import ChaosMovePrimaryFaultScheduledEvent
from .chaos_restart_replica_fault_scheduled_event import ChaosRestartReplicaFaultScheduledEvent
from .chaos_restart_node_fault_scheduled_event import ChaosRestartNodeFaultScheduledEvent
from .service_resource_description import ServiceResourceDescription
from .diagnostics_sink_properties import DiagnosticsSinkProperties
from .diagnostics_description import DiagnosticsDescription
from .application_resource_description import ApplicationResourceDescription
from .paged_service_resource_description_list import PagedServiceResourceDescriptionList
from .service_resource_replica_description import ServiceResourceReplicaDescription
from .paged_service_resource_replica_description_list import PagedServiceResourceReplicaDescriptionList
from .volume_provider_parameters_azure_file import VolumeProviderParametersAzureFile
from .volume_resource_description import VolumeResourceDescription
from .image_registry_credential import ImageRegistryCredential
from .environment_variable import EnvironmentVariable
from .setting import Setting
from .container_label import ContainerLabel
from .endpoint_properties import EndpointProperties
from .resource_requests import ResourceRequests
from .resource_limits import ResourceLimits
from .resource_requirements import ResourceRequirements
from .container_volume import ContainerVolume
from .container_state import ContainerState
from .container_event import ContainerEvent
from .container_instance_view import ContainerInstanceView
from .diagnostics_ref import DiagnosticsRef
from .container_code_package_properties import ContainerCodePackageProperties
from .network_ref import NetworkRef
from .service_replica_properties import ServiceReplicaProperties
from .service_fabric_client_ap_is_enums import (
ApplicationDefinitionKind,
HealthState,
Expand Down Expand Up @@ -919,6 +969,10 @@
RepairTaskHealthCheckState,
ScalingTriggerKind,
ScalingMechanismKind,
ServiceResourceStatus,
ApplicationResourceStatus,
DiagnosticsSinkKind,
OperatingSystemTypes,
NodeStatusFilter,
ReplicaHealthReportServiceKind,
DataLossMode,
Expand Down Expand Up @@ -1341,6 +1395,31 @@
'ChaosMovePrimaryFaultScheduledEvent',
'ChaosRestartReplicaFaultScheduledEvent',
'ChaosRestartNodeFaultScheduledEvent',
'ServiceResourceDescription',
'DiagnosticsSinkProperties',
'DiagnosticsDescription',
'ApplicationResourceDescription',
'PagedServiceResourceDescriptionList',
'ServiceResourceReplicaDescription',
'PagedServiceResourceReplicaDescriptionList',
'VolumeProviderParametersAzureFile',
'VolumeResourceDescription',
'ImageRegistryCredential',
'EnvironmentVariable',
'Setting',
'ContainerLabel',
'EndpointProperties',
'ResourceRequests',
'ResourceLimits',
'ResourceRequirements',
'ContainerVolume',
'ContainerState',
'ContainerEvent',
'ContainerInstanceView',
'DiagnosticsRef',
'ContainerCodePackageProperties',
'NetworkRef',
'ServiceReplicaProperties',
'ApplicationDefinitionKind',
'HealthState',
'ApplicationStatus',
Expand Down Expand Up @@ -1422,6 +1501,10 @@
'RepairTaskHealthCheckState',
'ScalingTriggerKind',
'ScalingMechanismKind',
'ServiceResourceStatus',
'ApplicationResourceStatus',
'DiagnosticsSinkKind',
'OperatingSystemTypes',
'NodeStatusFilter',
'ReplicaHealthReportServiceKind',
'DataLossMode',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ class ApplicationBackupConfigurationInfo(BackupConfigurationInfo):
this Service Fabric application or service or partition.
:type policy_name: str
:param policy_inherited_from: Specifies the scope at which the backup
policy is applied. Possible values include: 'Invalid', 'Partition',
'Service', 'Application'
policy is applied.
. Possible values include: 'Invalid', 'Partition', 'Service',
'Application'
:type policy_inherited_from: str or
~azure.servicefabric.models.BackupPolicyScope
:param suspension_info: Describes the backup suspension details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ class ApplicationBackupConfigurationInfo(BackupConfigurationInfo):
this Service Fabric application or service or partition.
:type policy_name: str
:param policy_inherited_from: Specifies the scope at which the backup
policy is applied. Possible values include: 'Invalid', 'Partition',
'Service', 'Application'
policy is applied.
. Possible values include: 'Invalid', 'Partition', 'Service',
'Application'
:type policy_inherited_from: str or
~azure.servicefabric.models.BackupPolicyScope
:param suspension_info: Describes the backup suspension details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ class ApplicationCapacityDescription(Model):
- Limiting the total number of nodes that services of this application can
run on
- Limiting the custom capacity metrics to limit the total consumption of
this metric by the services of this application.
this metric by the services of this application
.

:param minimum_nodes: The minimum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ class ApplicationCapacityDescription(Model):
- Limiting the total number of nodes that services of this application can
run on
- Limiting the custom capacity metrics to limit the total consumption of
this metric by the services of this application.
this metric by the services of this application
.

:param minimum_nodes: The minimum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class ApplicationHealth(EntityHealth):
aggregated health state of the entity computed by Health Manager.
The health evaluation of the entity reflects all events reported on the
entity and its children (if any).
The aggregation is done by applying the desired health policy. Possible
values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The aggregation is done by applying the desired health policy.
. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
:type aggregated_health_state: str or
~azure.servicefabric.models.HealthState
:param health_events: The list of health events reported on the entity.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthPolicies(Model):
"""Defines the application health policy map used to evaluate the health of an
application or one of its children entities.
.

:param application_health_policy_map: The wrapper that contains the map
with application health policies used to evaluate specific applications in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthPolicies(Model):
"""Defines the application health policy map used to evaluate the health of an
application or one of its children entities.
.

:param application_health_policy_map: The wrapper that contains the map
with application health policies used to evaluate specific applications in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthPolicy(Model):
"""Defines a health policy used to evaluate the health of an application or
one of its children entities.
.

:param consider_warning_as_error: Indicates whether warnings are treated
with the same severity as errors. Default value: False .
Expand All @@ -29,7 +30,8 @@ class ApplicationHealthPolicy(Model):
applications over the number of nodes where the application is currently
deployed on in the cluster.
The computation rounds up to tolerate one failure on small numbers of
nodes. Default percentage is zero. Default value: 0 .
nodes. Default percentage is zero.
. Default value: 0 .
:type max_percent_unhealthy_deployed_applications: int
:param default_service_type_health_policy: The health policy used by
default to evaluate the health of a service type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

class ApplicationHealthPolicyMapItem(Model):
"""Defines an item in ApplicationHealthPolicyMap.
.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

class ApplicationHealthPolicyMapItem(Model):
"""Defines an item in ApplicationHealthPolicyMap.
.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthPolicy(Model):
"""Defines a health policy used to evaluate the health of an application or
one of its children entities.
.

:param consider_warning_as_error: Indicates whether warnings are treated
with the same severity as errors. Default value: False .
Expand All @@ -29,7 +30,8 @@ class ApplicationHealthPolicy(Model):
applications over the number of nodes where the application is currently
deployed on in the cluster.
The computation rounds up to tolerate one failure on small numbers of
nodes. Default percentage is zero. Default value: 0 .
nodes. Default percentage is zero.
. Default value: 0 .
:type max_percent_unhealthy_deployed_applications: int
:param default_service_type_health_policy: The health policy used by
default to evaluate the health of a service type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class ApplicationHealth(EntityHealth):
aggregated health state of the entity computed by Health Manager.
The health evaluation of the entity reflects all events reported on the
entity and its children (if any).
The aggregation is done by applying the desired health policy. Possible
values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The aggregation is done by applying the desired health policy.
. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
:type aggregated_health_state: str or
~azure.servicefabric.models.HealthState
:param health_events: The list of health events reported on the entity.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthState(EntityHealthState):
"""Represents the health state of an application, which contains the
application identifier and the aggregated health state.
.

:param aggregated_health_state: The health state of a Service Fabric
entity such as Cluster, Node, Application, Service, Partition, Replica
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class ApplicationHealthStateChunk(EntityHealthStateChunk):
The application health state chunk contains the application name, its
aggregated health state and any children services and deployed applications
that respect the filters in cluster health chunk query description.
.

:param health_state: The health state of a Service Fabric entity such as
Cluster, Node, Application, Service, Partition, Replica etc. Possible
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class ApplicationHealthStateChunkList(EntityHealthStateChunkList):
"""The list of application health state chunks in the cluster that respect the
input filters in the chunk query. Returned by get cluster health state
chunks query.
.

:param total_count: Total number of entity health state objects that match
the specified filters from the cluster health chunk query description.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class ApplicationHealthStateChunkList(EntityHealthStateChunkList):
"""The list of application health state chunks in the cluster that respect the
input filters in the chunk query. Returned by get cluster health state
chunks query.
.

:param total_count: Total number of entity health state objects that match
the specified filters from the cluster health chunk query description.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class ApplicationHealthStateChunk(EntityHealthStateChunk):
The application health state chunk contains the application name, its
aggregated health state and any children services and deployed applications
that respect the filters in cluster health chunk query description.
.

:param health_state: The health state of a Service Fabric entity such as
Cluster, Node, Application, Service, Partition, Replica etc. Possible
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class ApplicationHealthStateFilter(Model):
included in the cluster health chunk.
One filter can match zero, one or multiple applications, depending on its
properties.
.

:param application_name_filter: The name of the application that matches
the filter, as a fabric uri. The filter is applied only to the specified
Expand Down Expand Up @@ -48,7 +49,7 @@ class ApplicationHealthStateFilter(Model):
If not specified, default value is None, unless the application name or
the application type name are specified. If the filter has default value
and application name is specified, the matching application is returned.
The state values are flag based enumeration, so the value could be a
The state values are flag-based enumeration, so the value could be a
combination of these values obtained using bitwise 'OR' operator.
For example, if the provided value is 6, it matches applications with
HealthState value of OK (2) and Warning (4).
Expand All @@ -62,7 +63,8 @@ class ApplicationHealthStateFilter(Model):
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The value is
65535. Default value: 0 .
65535.
. Default value: 0 .
:type health_state_filter: int
:param service_filters: Defines a list of filters that specify which
services to be included in the returned cluster health chunk as children
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class ApplicationHealthStateFilter(Model):
included in the cluster health chunk.
One filter can match zero, one or multiple applications, depending on its
properties.
.

:param application_name_filter: The name of the application that matches
the filter, as a fabric uri. The filter is applied only to the specified
Expand Down Expand Up @@ -48,7 +49,7 @@ class ApplicationHealthStateFilter(Model):
If not specified, default value is None, unless the application name or
the application type name are specified. If the filter has default value
and application name is specified, the matching application is returned.
The state values are flag based enumeration, so the value could be a
The state values are flag-based enumeration, so the value could be a
combination of these values obtained using bitwise 'OR' operator.
For example, if the provided value is 6, it matches applications with
HealthState value of OK (2) and Warning (4).
Expand All @@ -62,7 +63,8 @@ class ApplicationHealthStateFilter(Model):
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The value is
65535. Default value: 0 .
65535.
. Default value: 0 .
:type health_state_filter: int
:param service_filters: Defines a list of filters that specify which
services to be included in the returned cluster health chunk as children
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class ApplicationHealthState(EntityHealthState):
"""Represents the health state of an application, which contains the
application identifier and the aggregated health state.
.

:param aggregated_health_state: The health state of a Service Fabric
entity such as Cluster, Node, Application, Service, Partition, Replica
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ class ApplicationInfo(Model):
:param type_version: The version of the application type as defined in the
application manifest.
:type type_version: str
:param status: The status of the application. Possible values include:
'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
:param status: The status of the application.
. Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating',
'Deleting', 'Failed'
:type status: str or ~azure.servicefabric.models.ApplicationStatus
:param parameters: List of application parameters with overridden values
from their default values specified in the application manifest.
Expand All @@ -43,7 +44,8 @@ class ApplicationInfo(Model):
values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
:type health_state: str or ~azure.servicefabric.models.HealthState
:param application_definition_kind: The mechanism used to define a Service
Fabric application. Possible values include: 'Invalid',
Fabric application.
. Possible values include: 'Invalid',
'ServiceFabricApplicationDescription', 'Compose'
:type application_definition_kind: str or
~azure.servicefabric.models.ApplicationDefinitionKind
Expand Down
Loading