azure.servicefabric.models module

class azure.servicefabric.models.AadMetadata(authority=None, client=None, cluster=None, login=None, redirect=None, tenant=None)[source]

Bases: msrest.serialization.Model

Azure Active Directory metadata used for secured connection to cluster.

Parameters:
  • authority (str) – The AAD authority url.
  • client (str) – The AAD client application Id.
  • cluster (str) – The AAD cluster application Id.
  • login (str) – The AAD login url.
  • redirect (str) – The client application redirect address.
  • tenant (str) – The AAD tenant Id.
class azure.servicefabric.models.AadMetadataObject(type=None, metadata=None)[source]

Bases: msrest.serialization.Model

Azure Active Directory metadata object used for secured connection to cluster.

Parameters:
  • type (str) – The client authentication method.
  • metadata (AadMetadata) –
class azure.servicefabric.models.ApplicationHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, name=None, service_health_states=None, deployed_application_health_states=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • name (str) –
  • service_health_states (list of ServiceHealthState) – Service health states as found in the health store.
  • deployed_application_health_states (list of DeployedApplicationHealthState) – Deployed application health states as found in the health store.
class azure.servicefabric.models.ServiceHealthState(aggregated_health_state=None, service_name=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of a service, which contains the service identifier and its aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_name (str) – Full name of the service.
class azure.servicefabric.models.DeployedApplicationHealthState(aggregated_health_state=None, node_name=None, application_name=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – Name of the node on which the service package is deployed.
  • application_name (str) – Full name of the application.
class azure.servicefabric.models.ApplicationHealthEvaluation(aggregated_health_state=None, description=None, application_name=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • application_name (str) – Full name of the application.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
class azure.servicefabric.models.HealthEvaluationWrapper(health_evaluation=None)[source]

Bases: msrest.serialization.Model

Wrapper object for health evaluation.

Parameters:health_evaluation (HealthEvaluation) –
class azure.servicefabric.models.HealthEvaluation(aggregated_health_state=None, description=None)[source]

Bases: msrest.serialization.Model

Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.ApplicationHealthPolicies(application_health_policy_map=None)[source]

Bases: msrest.serialization.Model

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

Parameters:application_health_policy_map (list of ApplicationHealthPolicyMapItem) – The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster.
class azure.servicefabric.models.ApplicationHealthPolicyMapItem(key, value)[source]

Bases: msrest.serialization.Model

Defines an item in ApplicationHealthPolicyMap. .

Parameters:
  • key (str) – The key of the application health policy map item. This is the name of the application.
  • value (ApplicationHealthPolicy) – The value of the application health policy map item. This is the ApplicationHealthPolicy for this application.
class azure.servicefabric.models.ApplicationHealthPolicy(consider_warning_as_error=False, max_percent_unhealthy_deployed_applications=0, default_service_type_health_policy=None, service_type_health_policy_map=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. Default value: False .
  • max_percent_unhealthy_deployed_applications (int) – The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed 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 .
  • default_service_type_health_policy (ServiceTypeHealthPolicy) – The health policy used by default to evaluate the health of a service type.
  • service_type_health_policy_map (list of ServiceTypeHealthPolicyMapItem) – The map with service type health policy per service type name. The map is empty be default.
class azure.servicefabric.models.ServiceTypeHealthPolicy(max_percent_unhealthy_partitions_per_service=0, max_percent_unhealthy_replicas_per_partition=0, max_percent_unhealthy_services=0)[source]

Bases: msrest.serialization.Model

Represents the health policy used to evaluate the health of services belonging to a service type. .

Parameters:
  • max_percent_unhealthy_partitions_per_service (int) – The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. . Default value: 0 .
  • max_percent_unhealthy_replicas_per_partition (int) – The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. . Default value: 0 .
  • max_percent_unhealthy_services (int) – The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. . Default value: 0 .
class azure.servicefabric.models.ServiceTypeHealthPolicyMapItem(key, value)[source]

Bases: msrest.serialization.Model

Defines an item in ServiceTypeHealthPolicyMap. .

Parameters:
  • key (str) – The key of the service type health policy map item. This is the name of the service type.
  • value (ServiceTypeHealthPolicy) – The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
class azure.servicefabric.models.ApplicationHealthState(aggregated_health_state=None, name=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of an application, which contains the application identifier and the aggregated health state. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • name (str) – Full name of the application.
class azure.servicefabric.models.ApplicationHealthStateChunk(health_state=None, application_name=None, application_type_name=None, service_health_state_chunks=None, deployed_application_health_state_chunks=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a application. 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. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • application_name (str) – The name of the application.
  • application_type_name (str) – The application type name for the application.
  • service_health_state_chunks (ServiceHealthStateChunkList) – The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description.
  • deployed_application_health_state_chunks (DeployedApplicationHealthStateChunkList) – The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
class azure.servicefabric.models.ServiceHealthStateChunkList(items=None)[source]

Bases: msrest.serialization.Model

The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. .

Parameters:items (list of ServiceHealthStateChunk) – The list of service health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.ServiceHealthStateChunk(health_state=None, service_name=None, partition_health_state_chunks=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_name (str) – The name of the service.
  • partition_health_state_chunks (PartitionHealthStateChunkList) – The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description.
class azure.servicefabric.models.PartitionHealthStateChunkList(items=None)[source]

Bases: msrest.serialization.Model

The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy. .

Parameters:items (list of PartitionHealthStateChunk) – The list of partition health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.PartitionHealthStateChunk(health_state=None, partition_id=None, replica_health_state_chunks=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a partition, which contains the partition id, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_id (str) – The ID of the partition.
  • replica_health_state_chunks (ReplicaHealthStateChunkList) – The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description.
class azure.servicefabric.models.ReplicaHealthStateChunkList(items=None)[source]

Bases: msrest.serialization.Model

The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. .

Parameters:items (list of ReplicaHealthStateChunk) – The list of replica health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.ReplicaHealthStateChunk(health_state=None, replica_or_instance_id=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • replica_or_instance_id (str) – The ID of the stateful service replica or the stateless service instance.
class azure.servicefabric.models.DeployedApplicationHealthStateChunkList(items=None)[source]

Bases: msrest.serialization.Model

The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. .

Parameters:items (list of DeployedApplicationHealthStateChunk) – The list of deployed application health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.DeployedApplicationHealthStateChunk(health_state=None, node_name=None, deployed_service_package_health_state_chunks=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – The name of node where the application is deployed.
  • deployed_service_package_health_state_chunks (DeployedServicePackageHealthStateChunkList) – The list of deployed service oackage health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description.
class azure.servicefabric.models.DeployedServicePackageHealthStateChunkList(items=None)[source]

Bases: msrest.serialization.Model

The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. .

Parameters:items (list of DeployedServicePackageHealthStateChunk) – The list of deployed service package health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.DeployedServicePackageHealthStateChunk(health_state=None, service_manifest_name=None, service_package_activation_id=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_manifest_name (str) – The name of the service manifest.
  • service_package_activation_id (str) –
class azure.servicefabric.models.ApplicationHealthStateChunkList(total_count=None, items=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk_list.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. .

Parameters:
  • total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
  • items (list of ApplicationHealthStateChunk) – The list of application health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.ApplicationHealthStateFilter(application_name_filter=None, application_type_name_filter=None, health_state_filter=0, service_filters=None, deployed_application_filters=None)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties. .

Parameters:
  • application_name_filter (str) – The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists. If the application doesn’t exist, no application is returned in the cluster health chunk based on this filter. If the application exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
  • application_type_name_filter (str) – The name of the application type that matches the filter. If specified, the filter is applied only to applications of the selected application type, if any exists. If no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter. Each application of the specified application type is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the applications. It allows selecting applications if they match the desired health states. The possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state. 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 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). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
  • service_filters (list of ServiceHealthStateFilter) – Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter. If the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple service filters. For example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name.
  • deployed_application_filters (list of DeployedApplicationHealthStateFilter) – Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter. If the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple deployed application filters. For example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node.
class azure.servicefabric.models.ServiceHealthStateFilter(service_name_filter=None, health_state_filter=0, partition_filters=None)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties. .

Parameters:
  • service_name_filter (str) – The name of the service that matches the filter. The filter is applied only to the specified service, if it exists. If the service doesn’t exist, no service is returned in the cluster health chunk based on this filter. If the service exists, it is included as the application’s child if the health state matches the other filter properties. If not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the services. It allows selecting services if they match the desired health states. The possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned. 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 services with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
  • partition_filters (list of PartitionHealthStateFilter) – Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter. If the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters. The service filter may specify multiple partition filters. For example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition id.
class azure.servicefabric.models.PartitionHealthStateFilter(partition_id_filter=None, health_state_filter=0, replica_filters=None)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties. .

Parameters:
  • partition_id_filter (str) – ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists. If the partition doesn’t exist, no partition is returned in the cluster health chunk based on this filter. If the partition exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states. The possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the partition id is specified. If the filter has default value and partition id is specified, the matching partition is returned. 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 partitions with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
  • replica_filters (list of ReplicaHealthStateFilter) – Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter. If the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters. The partition filter may specify multiple replica filters. For example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id.
class azure.servicefabric.models.ReplicaHealthStateFilter(replica_or_instance_id_filter=None, health_state_filter=0)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties. .

Parameters:
  • replica_or_instance_id_filter (str) – Id of the stateful service replica or stateles service instance that matches the filter. The filter is applied only to the specified replica, if it exists. If the replica doesn’t exist, no replica is returned in the cluster health chunk based on this filter. If the replica exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states. The possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state. If not specified, default value is None, unless the replica id is specified. If the filter has default value and replica id is specified, the matching replica is returned. 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 replicas with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
class azure.servicefabric.models.DeployedApplicationHealthStateFilter(node_name_filter=None, health_state_filter=0, deployed_service_package_filters=None)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties. .

Parameters:
  • node_name_filter (str) – The name of the node where the application is deployed in order to match the filter. If specified, the filter is applied only to the application deployed on the specified node. If the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter. Otherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned. 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 deployed applications with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
  • deployed_service_package_filters (list of DeployedServicePackageHealthStateFilter) – Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter. If the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters. The deployed application filter may specify multiple deployed service package filters. For example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node.
class azure.servicefabric.models.DeployedServicePackageHealthStateFilter(service_manifest_name_filter=None, service_package_activation_id_filter=None, health_state_filter=0)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties. .

Parameters:
  • service_manifest_name_filter (str) – The name of the service manifest which identifies the deployed service packages that matches the filter. If specified, the filter is applied only to the specified deployed service packages, if any. If no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter. If any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • service_package_activation_id_filter (str) – The activation ID of a deployed service package that matches the filter. If not specified, the filter applies to all deployed service packages that match the other parameters. If specified, the filter matches only the deployed service package with the specified activation ID.
  • health_state_filter (int) – The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state. If not specified, default value is None, unless the deployed service package id is specified. If the filter has default value and deployed service package id is specified, the matching deployed service package is returned. 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 deployed service packages with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
class azure.servicefabric.models.ApplicationInfo(id=None, name=None, type_name=None, type_version=None, status=None, parameters=None, health_state=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric application.

Parameters:
  • id (str) –
  • name (str) – The Uniform Resource Identifier(URI) of the application.
  • type_name (str) – The Name of the application type as specified in the Application Manifest.
  • type_version (str) – The version of the application type as specified in the Application Manifest.
  • status (str) – Possible values include: ‘Invalid’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
  • parameters (list of ApplicationParameter) –
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
class azure.servicefabric.models.ApplicationParameter(key, value)[source]

Bases: msrest.serialization.Model

Describes an application parameter override to be applied when creating or upgrading an application.

Parameters:
  • key (str) – The name of the parameter.
  • value (str) – The value of the parameter.
class azure.servicefabric.models.ApplicationNameInfo(id=None, name=None)[source]

Bases: msrest.serialization.Model

Information about the application name.

Parameters:
class azure.servicefabric.models.ApplicationsHealthEvaluation(aggregated_health_state=None, description=None, max_percent_unhealthy_applications=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • max_percent_unhealthy_applications (int) – Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy.
  • total_count (long) – Total number of applications from the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.ApplicationTypeApplicationsHealthEvaluation(aggregated_health_state=None, description=None, application_type_name=None, max_percent_unhealthy_applications=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • application_type_name (str) – Name of the application type.
  • max_percent_unhealthy_applications (int) – Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap.
  • total_count (long) – Total number of applications of the application type found in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health.
class azure.servicefabric.models.ApplicationTypeHealthPolicyMapItem(key, value)[source]

Bases: msrest.serialization.Model

Defines an item in ApplicationTypeHealthPolicyMap. .

Parameters:
  • key (str) – The key of the application type health policy map item. This is the name of the application type.
  • value (int) – The value of the application type health policy map item. The max percent unhealthy applications allowed for the application type. Must be between zero and 100.
class azure.servicefabric.models.ApplicationTypeInfo(name=None, version=None, status=None, default_parameter_list=None)[source]

Bases: msrest.serialization.Model

Information about an application type.

Parameters:
  • name (str) – The name of the application type.
  • version (str) – The version of the application type.
  • status (str) – Possible values include: ‘Invalid’, ‘Provisioning’, ‘Available’, ‘Unprovisioning’, ‘Failed’
  • default_parameter_list (list of ApplicationParameter) –
class azure.servicefabric.models.PagedApplicationTypeInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.ApplicationTypeManifest(manifest=None)[source]

Bases: msrest.serialization.Model

Contains the manifest describing an application type registered in a Service Fabric cluster.

Parameters:manifest (str) – The XML manifest as a string.
class azure.servicefabric.models.ApplicationUpgradeDescription(name, target_application_type_version, parameters, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds=None, force_restart=None, monitoring_policy=None, application_health_policy=None)[source]

Bases: msrest.serialization.Model

Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

Parameters:
  • name (str) –
  • target_application_type_version (str) –
  • parameters (list of ApplicationParameter) –
  • upgrade_kind (str) – Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
  • rolling_upgrade_mode (str) – Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
  • upgrade_replica_set_check_timeout_in_seconds (long) –
  • force_restart (bool) –
  • monitoring_policy (MonitoringPolicyDescription) –
  • application_health_policy (ApplicationHealthPolicy) –
class azure.servicefabric.models.MonitoringPolicyDescription(failure_action=None, health_check_wait_duration_in_milliseconds=None, health_check_stable_duration_in_milliseconds=None, health_check_retry_timeout_in_milliseconds=None, upgrade_timeout_in_milliseconds=None, upgrade_domain_timeout_in_milliseconds=None)[source]

Bases: msrest.serialization.Model

Describes the parameters for monitoring an upgrade in Monitored mode.

Parameters:
  • failure_action (str) – Possible values include: ‘Invalid’, ‘Rollback’, ‘Manual’
  • health_check_wait_duration_in_milliseconds (str) –
  • health_check_stable_duration_in_milliseconds (str) –
  • health_check_retry_timeout_in_milliseconds (str) –
  • upgrade_timeout_in_milliseconds (str) –
  • upgrade_domain_timeout_in_milliseconds (str) –
class azure.servicefabric.models.ApplicationUpgradeProgressInfo(name=None, type_name=None, target_application_type_version=None, upgrade_domains=None, upgrade_state=None, next_upgrade_domain=None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds=None, upgrade_domain_duration_in_milliseconds=None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc=None, failure_timestamp_utc=None, failure_reason=None, upgrade_domain_progress_at_failure=None, upgrade_status_details=None)[source]

Bases: msrest.serialization.Model

Describes the parameters for an application upgrade.

Parameters:
  • name (str) –
  • type_name (str) –
  • target_application_type_version (str) –
  • upgrade_domains (list of UpgradeDomainInfo) –
  • upgrade_state (str) – Possible values include: ‘Invalid’, ‘RollingBackInProgress’, ‘RollingBackCompleted’, ‘RollingForwardPending’, ‘RollingForwardInProgress’, ‘RollingForwardCompleted’, ‘Failed’
  • next_upgrade_domain (str) –
  • rolling_upgrade_mode (str) – Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
  • upgrade_description (ApplicationUpgradeDescription) –
  • upgrade_duration_in_milliseconds (str) – The estimated total amount of time spent processing the overall upgrade.
  • upgrade_domain_duration_in_milliseconds (str) – The estimated total amount of time spent processing the current upgrade domain.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) –
  • current_upgrade_domain_progress (CurrentUpgradeDomainProgressInfo) –
  • start_timestamp_utc (str) – The estimated UTC datetime when the upgrade started.
  • failure_timestamp_utc (str) – The estimated UTC datetime when the upgrade failed and FailureAction was executed.
  • failure_reason (str) – Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘UpgradeTimeout’
  • upgrade_domain_progress_at_failure (FailureUpgradeDomainProgressInfo) –
  • upgrade_status_details (str) – Additional detailed information about the status of the pending upgrade.
class azure.servicefabric.models.UpgradeDomainInfo(name=None, state=None)[source]

Bases: msrest.serialization.Model

Information about an upgrade domain.

Parameters:
  • name (str) –
  • state (str) – Possible values include: ‘Invalid’, ‘Pending’, ‘InProgress’, ‘Completed’
class azure.servicefabric.models.CurrentUpgradeDomainProgressInfo(domain_name=None, node_upgrade_progress_list=None)[source]

Bases: msrest.serialization.Model

Information about the current in-progress upgrade domain.

Parameters:
class azure.servicefabric.models.NodeUpgradeProgressInfo(node_name=None, upgrade_phase=None, pending_safety_checks=None)[source]

Bases: msrest.serialization.Model

Information about the upgrading node and its status.

Parameters:
  • node_name (str) –
  • upgrade_phase (str) – Possible values include: ‘Invalid’, ‘PreUpgradeSafetyCheck’, ‘Upgrading’, ‘PostUpgradeSafetyCheck’
  • pending_safety_checks (list of SafetyCheckWrapper) –
class azure.servicefabric.models.SafetyCheckWrapper(safety_check=None)[source]

Bases: msrest.serialization.Model

A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the avaiability of the service and the reliability of the state.

Parameters:safety_check (SafetyCheck) –
class azure.servicefabric.models.SafetyCheck[source]

Bases: msrest.serialization.Model

Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the avaiability of the service and the reliability of the state.

Parameters:Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.FailureUpgradeDomainProgressInfo(domain_name=None, node_upgrade_progress_list=None)[source]

Bases: msrest.serialization.Model

Information about the upgrade domain progress at the time of upgrade failure.

Parameters:
class azure.servicefabric.models.ClusterHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, node_health_states=None, application_health_states=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations. .

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • node_health_states (list of NodeHealthState) – Cluster node health states as found in the health store.
  • application_health_states (list of ApplicationHealthState) – Cluster application health states as found in the health store.
class azure.servicefabric.models.NodeHealthState(aggregated_health_state=None, name=None, id=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of a node, which contains the node identifier and its aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • name (str) – The name of the node.
  • id (NodeId) –
class azure.servicefabric.models.NodeId(id=None)[source]

Bases: msrest.serialization.Model

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

Parameters:id (str) – Value of the node Id. This is a 128 bit integer.
class azure.servicefabric.models.ClusterHealthChunk(health_state=None, node_health_state_chunks=None, application_health_state_chunks=None)[source]

Bases: msrest.serialization.Model

Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter. .

Parameters:
  • health_state (str) – The HealthState representing the aggregated health state of the cluster 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 cluster health policy and the application health policies. . Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_health_state_chunks (NodeHealthStateChunkList) – The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.
  • application_health_state_chunks (ApplicationHealthStateChunkList) – The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
class azure.servicefabric.models.NodeHealthStateChunkList(total_count=None, items=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk_list.EntityHealthStateChunkList

The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query. .

Parameters:
  • total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
  • items (list of NodeHealthStateChunk) – The list of node health state chunks that respect the input filters in the chunk query.
class azure.servicefabric.models.NodeHealthStateChunk(health_state=None, node_name=None)[source]

Bases: azure.servicefabric.models.entity_health_state_chunk.EntityHealthStateChunk

Represents the health state chunk of a node, which contains the node name and its aggregated health state. .

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – The name of the node.
class azure.servicefabric.models.ClusterHealthChunkQueryDescription(node_filters=None, application_filters=None, cluster_health_policy=None, application_health_policies=None)[source]

Bases: msrest.serialization.Model

The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.

Parameters:
  • node_filters (list of NodeHealthStateFilter) – Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster’s aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.
  • application_filters (list of ApplicationHealthStateFilter) – Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster’s aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.
  • cluster_health_policy (ClusterHealthPolicy) –
  • application_health_policies (ApplicationHealthPolicies) –
class azure.servicefabric.models.NodeHealthStateFilter(node_name_filter=None, health_state_filter=0)[source]

Bases: msrest.serialization.Model

Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description. .

Parameters:
  • node_name_filter (str) – Name of the node that matches the filter. The filter is applied only to the specified node, if it exists. If the node doesn’t exist, no node is returned in the cluster health chunk based on this filter. If the node exists, it is included in the cluster health chunk if the health state matches the other filter properties. If not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
  • health_state_filter (int) – The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states. The possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned. 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 nodes with HealthState value of OK (2) and Warning (4). - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - 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 .
class azure.servicefabric.models.ClusterHealthPolicy(consider_warning_as_error=False, max_percent_unhealthy_nodes=0, max_percent_unhealthy_applications=0, application_type_health_policy_map=None)[source]

Bases: msrest.serialization.Model

Defines a health policy used to evaluate the health of the cluster or of a cluster node. .

Parameters:
  • consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. Default value: False .
  • max_percent_unhealthy_nodes (int) – The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. . Default value: 0 .
  • max_percent_unhealthy_applications (int) – The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. . Default value: 0 .
  • application_type_health_policy_map (list of ApplicationTypeHealthPolicyMapItem) –
class azure.servicefabric.models.ClusterHealthPolicies(application_health_policy_map=None, cluster_health_policy=None)[source]

Bases: msrest.serialization.Model

Health policies to evaluate cluster health.

Parameters:
class azure.servicefabric.models.ClusterManifest(manifest=None)[source]

Bases: msrest.serialization.Model

Information about the cluster manifest.

Parameters:manifest (str) – The contents of the cluster manifest file.
class azure.servicefabric.models.DeactivationIntentDescription(deactivation_intent=None)[source]

Bases: msrest.serialization.Model

Describes the intent or reason for deactivating the node.

Parameters:deactivation_intent (str) – Describes the intent or reason for deactivating the node. The possible values are following. - Pause - Indicates that the node should be paused. The value is 1. - Restart - Indicates that the intent is for the node to be restarted after a short period of time. The value is 2. - RemoveData - Indicates the intent is for the node to remove data. The value is 3. . Possible values include: ‘Pause’, ‘Restart’, ‘RemoveData’
class azure.servicefabric.models.DeltaNodesCheckHealthEvaluation(aggregated_health_state=None, description=None, baseline_error_count=None, baseline_total_count=None, max_percent_delta_unhealthy_nodes=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • baseline_error_count (long) – Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
  • baseline_total_count (long) – Total number of nodes in the health store at the beginning of the cluster upgrade.
  • max_percent_delta_unhealthy_nodes (int) – Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
  • total_count (long) – Total number of nodes in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.DeployedApplicationHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, name=None, node_name=None, deployed_service_package_health_states=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Information about the health of an application deployed on a Service Fabric node.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • name (str) – Name of the application deployed on the node whose health information is described by this object.
  • node_name (str) – Name of the node where this application is deployed.
  • deployed_service_package_health_states (list of DeployedServicePackageHealthState) – Deployed service package health states for the current deployed application as found in the health store.
class azure.servicefabric.models.DeployedServicePackageHealthState(aggregated_health_state=None, node_name=None, application_name=None, service_manifest_name=None, service_package_activation_id=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – Name of the node on which the service package is deployed.
  • application_name (str) – Full name of the application.
  • service_manifest_name (str) – Name of the manifest describing the service package.
  • service_package_activation_id (str) –
class azure.servicefabric.models.DeployedApplicationHealthEvaluation(aggregated_health_state=None, description=None, node_name=None, application_name=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • node_name (str) – Name of the node where the application is deployed to.
  • application_name (str) – Full name of the application.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the deployed application. The types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation.
class azure.servicefabric.models.DeployedApplicationInfo(id=None, name=None, type_name=None, status=None, work_directory=None, log_directory=None, temp_directory=None)[source]

Bases: msrest.serialization.Model

Information about application deployed on the node.

Parameters:
  • id (str) –
  • name (str) – The name of the application.
  • type_name (str) – The name of the application type.
  • status (str) – Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’
  • work_directory (str) – The work directory of the application on the node. The work directory can be used to store application data.
  • log_directory (str) – The log directory of the application on the node. The log directory can be used to store application logs.
  • temp_directory (str) – The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.
class azure.servicefabric.models.DeployedApplicationsHealthEvaluation(aggregated_health_state=None, description=None, max_percent_unhealthy_deployed_applications=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • max_percent_unhealthy_deployed_applications (int) – Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy.
  • total_count (long) – Total number of deployed applications of the application in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.DeployedServicePackageHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, application_name=None, service_manifest_name=None, node_name=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Information about the health of a service package for a specific application deployed on a Service Fabric node.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • application_name (str) – Name of the application.
  • service_manifest_name (str) – Name of the service manifest.
  • node_name (str) – Name of the node where this service package is deployed.
class azure.servicefabric.models.DeployedServicePackageHealthEvaluation(aggregated_health_state=None, description=None, node_name=None, application_name=None, service_manifest_name=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • node_name (str) – Name of the node.
  • application_name (str) – Full name of the application.
  • service_manifest_name (str) – Name of the service manifest.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation.
class azure.servicefabric.models.DeployedServicePackagesHealthEvaluation(aggregated_health_state=None, description=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • total_count (long) – Total number of deployed service packages of the deployed application in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.DeployedServiceReplicaInfo(service_name=None, service_type_name=None, service_manifest_name=None, code_package_name=None, partition_id=None, replica_status=None, address=None, service_package_activation_id=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric service replica deployed on a node.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • service_type_name (str) – Name of the service type as specified in the service manifest.
  • service_manifest_name (str) – The name of the service manifest in which this service type is defined.
  • code_package_name (str) – The name of the code package that hosts this replica.
  • partition_id (str) –
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • address (str) – The last address returned by the replica in Open or ChangeRole.
  • service_package_activation_id (str) –
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.DeployedStatefulServiceReplicaInfo(service_name=None, service_type_name=None, service_manifest_name=None, code_package_name=None, partition_id=None, replica_status=None, address=None, service_package_activation_id=None, replica_id=None, replica_role=None)[source]

Bases: azure.servicefabric.models.deployed_service_replica_info.DeployedServiceReplicaInfo

Information about a stateful service replica deployed on a node.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • service_type_name (str) – Name of the service type as specified in the service manifest.
  • service_manifest_name (str) – The name of the service manifest in which this service type is defined.
  • code_package_name (str) – The name of the code package that hosts this replica.
  • partition_id (str) –
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • address (str) – The last address returned by the replica in Open or ChangeRole.
  • service_package_activation_id (str) –
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_id (str) – Id of the stateful service replica.
  • replica_role (str) – Possible values include: ‘Unknown’, ‘None’, ‘Primary’, ‘IdleSecondary’, ‘ActiveSecondary’
class azure.servicefabric.models.DeployedStatelessServiceInstanceInfo(service_name=None, service_type_name=None, service_manifest_name=None, code_package_name=None, partition_id=None, replica_status=None, address=None, service_package_activation_id=None, instance_id=None)[source]

Bases: azure.servicefabric.models.deployed_service_replica_info.DeployedServiceReplicaInfo

Information about a stateless service instance deployed on a node.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • service_type_name (str) – Name of the service type as specified in the service manifest.
  • service_manifest_name (str) – The name of the service manifest in which this service type is defined.
  • code_package_name (str) – The name of the code package that hosts this replica.
  • partition_id (str) –
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • address (str) – The last address returned by the replica in Open or ChangeRole.
  • service_package_activation_id (str) –
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_id (str) – Id of the stateless service instance.
class azure.servicefabric.models.EntityHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None)[source]

Bases: msrest.serialization.Model

Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation. .

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
class azure.servicefabric.models.HealthEvent(source_id, property, health_state, time_to_live_in_milli_seconds=None, description=None, sequence_number=None, remove_when_expired=None, is_expired=None, source_utc_timestamp=None, last_modified_utc_timestamp=None, last_ok_transition_at=None, last_warning_transition_at=None, last_error_transition_at=None)[source]

Bases: azure.servicefabric.models.health_information.HealthInformation

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager. .

Parameters:
  • source_id (str) – The source name which identifies the client/watchdog/system component which generated the health information.
  • property (str) – The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId “LocalWatchdog” can monitor the state of the available disk on a node, so it can report “AvailableDisk” property on that node. The same reporter can monitor the node connectivity, so it can report a property “Connectivity” on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • time_to_live_in_milli_seconds (timedelta) – The duration for which this health report is valid. This field is using ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value.
  • description (str) – The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker “[Truncated]”, and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
  • sequence_number (str) – The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
  • remove_when_expired (bool) – Value that indicates whether the report is removed from health store when it expires. If set to true, the report is remopved from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, is the reporter has issues (eg. deadlock) and can’t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
  • is_expired (bool) – Returns true if the health event is expired, otherwise false.
  • source_utc_timestamp (datetime) – The date and time when the health report was sent by the source.
  • last_modified_utc_timestamp (datetime) – The date and time when the health report was last modified by the health store.
  • last_ok_transition_at (datetime) – If the current health state is ‘Ok’, this property returns the time at which the health report was first reported with ‘Ok’. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first ‘Ok’ health report was received. If the current health state is ‘Error’ or ‘Warning’, returns the date and time at which the health state was last in ‘Ok’, before transitioning to a different state. If the health state was never ‘Ok’, the value will be zero date-time.
  • last_warning_transition_at (datetime) – If the current health state is ‘Warning’, this property returns the time at which the health report was first reported with ‘Warning’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Warning’ health report was received. If the current health state is ‘Ok’ or ‘Error’, returns the date and time at which the health state was last in ‘Warning’, before transitioning to a different state. If the health state was never ‘Warning’, the value will be zero date-time.
  • last_error_transition_at (datetime) – If the current health state is ‘Error’, this property returns the time at which the health report was first reported with ‘Error’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Error’ health report was received. If the current health state is ‘Ok’ or ‘Warning’, returns the date and time at which the health state was last in ‘Error’, before transitioning to a different state. If the health state was never ‘Error’, the value will be zero date-time.
class azure.servicefabric.models.EntityHealthState(aggregated_health_state=None)[source]

Bases: msrest.serialization.Model

A base type for the health state of various entities in the cluster. It contains the aggregated health state.

Parameters:aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
class azure.servicefabric.models.EntityHealthStateChunk(health_state=None)[source]

Bases: msrest.serialization.Model

A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.

Parameters:health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
class azure.servicefabric.models.EntityHealthStateChunkList(total_count=None)[source]

Bases: msrest.serialization.Model

A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.

Parameters:total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
class azure.servicefabric.models.Epoch(configuration_version=None, data_loss_version=None)[source]

Bases: msrest.serialization.Model

An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica. .

Parameters:
  • configuration_version (str) – The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes.
  • data_loss_version (str) – The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica.
class azure.servicefabric.models.EventHealthEvaluation(aggregated_health_state=None, description=None, consider_warning_as_error=None, unhealthy_event=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity.
  • unhealthy_event (HealthEvent) –
class azure.servicefabric.models.FabricCodeVersionInfo(code_version=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric code version.

Parameters:code_version (str) – The product version of Service Fabric.
class azure.servicefabric.models.FabricConfigVersionInfo(config_version=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric config version.

Parameters:config_version (str) – The config version of Service Fabric.
class azure.servicefabric.models.FabricError(error)[source]

Bases: msrest.serialization.Model

The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful. .

Parameters:error (FabricErrorError) –
exception azure.servicefabric.models.FabricErrorException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘FabricError’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.servicefabric.models.FabricErrorError(code, message=None)[source]

Bases: msrest.serialization.Model

Error object containing error code and error message.

Parameters:
  • code (str) – Possible values include: ‘FABRIC_E_INVALID_PARTITION_KEY’, ‘FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR’, ‘FABRIC_E_INVALID_ADDRESS’, ‘FABRIC_E_APPLICATION_NOT_UPGRADING’, ‘FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR’, ‘FABRIC_E_FABRIC_NOT_UPGRADING’, ‘FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR’, ‘FABRIC_E_INVALID_CONFIGURATION’, ‘FABRIC_E_INVALID_NAME_URI’, ‘FABRIC_E_PATH_TOO_LONG’, ‘FABRIC_E_KEY_TOO_LARGE’, ‘FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED’, ‘FABRIC_E_INVALID_ATOMIC_GROUP’, ‘FABRIC_E_VALUE_EMPTY’, ‘FABRIC_E_NODE_NOT_FOUND’, ‘FABRIC_E_APPLICATION_TYPE_NOT_FOUND’, ‘FABRIC_E_APPLICATION_NOT_FOUND’, ‘FABRIC_E_SERVICE_TYPE_NOT_FOUND’, ‘FABRIC_E_SERVICE_DOES_NOT_EXIST’, ‘FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND’, ‘FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND’, ‘FABRIC_E_PARTITION_NOT_FOUND’, ‘FABRIC_E_REPLICA_DOES_NOT_EXIST’, ‘FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST’, ‘FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND’, ‘FABRIC_E_DIRECTORY_NOT_FOUND’, ‘FABRIC_E_FABRIC_VERSION_NOT_FOUND’, ‘FABRIC_E_FILE_NOT_FOUND’, ‘FABRIC_E_NAME_DOES_NOT_EXIST’, ‘FABRIC_E_PROPERTY_DOES_NOT_EXIST’, ‘FABRIC_E_ENUMERATION_COMPLETED’, ‘FABRIC_E_SERVICE_MANIFEST_NOT_FOUND’, ‘FABRIC_E_KEY_NOT_FOUND’, ‘FABRIC_E_HEALTH_ENTITY_NOT_FOUND’, ‘FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION’, ‘FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS’, ‘FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS’, ‘FABRIC_E_SERVICE_ALREADY_EXISTS’, ‘FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_TYPE_IN_USE’, ‘FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION’, ‘FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS’, ‘FABRIC_E_FABRIC_VERSION_IN_USE’, ‘FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS’, ‘FABRIC_E_NAME_ALREADY_EXISTS’, ‘FABRIC_E_NAME_NOT_EMPTY’, ‘FABRIC_E_PROPERTY_CHECK_FAILED’, ‘FABRIC_E_SERVICE_METADATA_MISMATCH’, ‘FABRIC_E_SERVICE_TYPE_MISMATCH’, ‘FABRIC_E_HEALTH_STALE_REPORT’, ‘FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED’, ‘FABRIC_E_NODE_HAS_NOT_STOPPED_YET’, ‘FABRIC_E_INSTANCE_ID_MISMATCH’, ‘FABRIC_E_VALUE_TOO_LARGE’, ‘FABRIC_E_NO_WRITE_QUORUM’, ‘FABRIC_E_NOT_PRIMARY’, ‘FABRIC_E_NOT_READY’, ‘FABRIC_E_RECONFIGURATION_PENDING’, ‘FABRIC_E_SERVICE_OFFLINE’, ‘E_ABORT’, ‘FABRIC_E_COMMUNICATION_ERROR’, ‘FABRIC_E_OPERATION_NOT_COMPLETE’, ‘FABRIC_E_TIMEOUT’, ‘FABRIC_E_NODE_IS_UP’
  • message (str) – Error message.
class azure.servicefabric.models.HealthInformation(source_id, property, health_state, time_to_live_in_milli_seconds=None, description=None, sequence_number=None, remove_when_expired=None)[source]

Bases: msrest.serialization.Model

Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries. .

Parameters:
  • source_id (str) – The source name which identifies the client/watchdog/system component which generated the health information.
  • property (str) – The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId “LocalWatchdog” can monitor the state of the available disk on a node, so it can report “AvailableDisk” property on that node. The same reporter can monitor the node connectivity, so it can report a property “Connectivity” on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • time_to_live_in_milli_seconds (timedelta) – The duration for which this health report is valid. This field is using ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value.
  • description (str) – The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker “[Truncated]”, and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
  • sequence_number (str) – The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
  • remove_when_expired (bool) – Value that indicates whether the report is removed from health store when it expires. If set to true, the report is remopved from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, is the reporter has issues (eg. deadlock) and can’t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
class azure.servicefabric.models.Int64RangePartitionInformation(id=None, low_key=None, high_key=None)[source]

Bases: azure.servicefabric.models.partition_information.PartitionInformation

Describes the partition information for the integer range that is based on partition schemes.

Parameters:
  • id (str) –
  • ServicePartitionKind (str) – Polymorphic Discriminator
  • low_key (str) – Specifies the minimum key value handled by this partition.
  • high_key (str) – Specifies the maximum key value handled by this partition.
class azure.servicefabric.models.NamedPartitionInformation(id=None, name=None)[source]

Bases: azure.servicefabric.models.partition_information.PartitionInformation

Describes the partition information for the name as a string that is based on partition schemes.

Parameters:
  • id (str) –
  • ServicePartitionKind (str) – Polymorphic Discriminator
  • name (str) – Name of the partition.
class azure.servicefabric.models.NodeDeactivationInfo(node_deactivation_intent=None, node_deactivation_status=None, node_deactivation_task=None, pending_safety_checks=None)[source]

Bases: msrest.serialization.Model

Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.

Parameters:
  • node_deactivation_intent (str) – Possible values include: ‘Invalid’, ‘Pause’, ‘Restart’, ‘RemoveData’, ‘RemoveNode’
  • node_deactivation_status (str) – Possible values include: ‘None’, ‘SafetyCheckInProgress’, ‘SafetyCheckComplete’, ‘Completed’
  • node_deactivation_task (list of NodeDeactivationTask) –
  • pending_safety_checks (list of SafetyCheckWrapper) –
class azure.servicefabric.models.NodeDeactivationTask(node_deactivation_task_id=None, node_deactivation_intent=None)[source]

Bases: msrest.serialization.Model

The task representing the deactivation operation on the node.

Parameters:
  • node_deactivation_task_id (NodeDeactivationTaskId) –
  • node_deactivation_intent (str) – Possible values include: ‘Invalid’, ‘Pause’, ‘Restart’, ‘RemoveData’, ‘RemoveNode’
class azure.servicefabric.models.NodeDeactivationTaskId(id=None, node_deactivation_task_type=None)[source]

Bases: msrest.serialization.Model

Identity of the task related to deactivation operation on the node.

Parameters:
  • id (str) – Value of the task id.
  • node_deactivation_task_type (str) – Possible values include: ‘Invalid’, ‘Infrastructure’, ‘Repair’, ‘Client’
class azure.servicefabric.models.NodeHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, name=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Information about the health of a Service Fabric node.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • name (str) – Name of the node whose health information is described by this object.
class azure.servicefabric.models.NodeHealthEvaluation(aggregated_health_state=None, description=None, node_name=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • node_name (str) – Name of the node.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation.
class azure.servicefabric.models.NodeInfo(name=None, ip_address_or_fqdn=None, type=None, code_version=None, config_version=None, node_status=None, node_up_time_in_seconds=None, health_state=None, is_seed_node=None, upgrade_domain=None, fault_domain=None, id=None, instance_id=None, node_deactivation_info=None, is_stopped=None, node_down_time_in_seconds=None)[source]

Bases: msrest.serialization.Model

Information about a node in Service Fabric cluster.

Parameters:
  • name (str) – The name of the node.
  • ip_address_or_fqdn (str) – The IP address or fully qualified domain name of the node.
  • type (str) – The type of the node.
  • code_version (str) – The version of Service Fabric binaries that the node is running.
  • config_version (str) – The version of Service Fabric cluster manifest that the node is using.
  • node_status (str) – Possible values include: ‘Invalid’, ‘Up’, ‘Down’, ‘Enabling’, ‘Disabling’, ‘Disabled’, ‘Unknown’, ‘Removed’
  • node_up_time_in_seconds (str) – Time in seconds since the node has been in NodeStatus Up. Value ero indicates that the node is not Up.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • is_seed_node (bool) – Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.
  • upgrade_domain (str) – The upgrade domain of the node.
  • fault_domain (str) – The fault domain of the node.
  • id (NodeId) –
  • instance_id (str) – The id representing the node instance. While the Id of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.
  • node_deactivation_info (NodeDeactivationInfo) –
  • is_stopped (bool) – Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
  • node_down_time_in_seconds (str) – Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
class azure.servicefabric.models.NodeLoadInfo(node_name=None, node_load_metric_information=None)[source]

Bases: msrest.serialization.Model

Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.

Parameters:
  • node_name (str) – Name of the node for which the load information is provided by this object.
  • node_load_metric_information (list of NodeLoadMetricInformation) – List that contains metrics and their load information on this node.
class azure.servicefabric.models.NodeLoadMetricInformation(name=None, node_capacity=None, node_load=None, node_remaining_capacity=None, is_capacity_violation=None, node_buffered_capacity=None, node_remaining_buffered_capacity=None)[source]

Bases: msrest.serialization.Model

Represents data structure that contains load information for a certain metric on a node.

Parameters:
  • name (str) – Name of the metric for which this load information is provided.
  • node_capacity (str) – Total capacity on the node for this metric.
  • node_load (str) – Current load on the node for this metric.
  • node_remaining_capacity (str) – The remaining capacity on the node for this metric.
  • is_capacity_violation (bool) – Indicates if there is a capacity violation for this metric on the node.
  • node_buffered_capacity (str) – The value that indicates the reserved capacity for this metric on the node.
  • node_remaining_buffered_capacity (str) – The remaining reserved capacity for this metric on the node.
class azure.servicefabric.models.NodesHealthEvaluation(aggregated_health_state=None, description=None, max_percent_unhealthy_nodes=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • max_percent_unhealthy_nodes (int) – Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
  • total_count (long) – Total number of nodes found in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.PagedApplicationInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.PagedNodeInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
  • continuation_token (str) –
  • items (list of NodeInfo) –
class azure.servicefabric.models.PagedServicePartitionInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.ServicePartitionInfo(health_state=None, partition_status=None, partition_information=None)[source]

Bases: msrest.serialization.Model

Information about a partition of a Service Fabric service.

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_status (str) – Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
  • partition_information (PartitionInformation) –
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PartitionInformation(id=None)[source]

Bases: msrest.serialization.Model

Information about the partition identity, partitioning scheme and keys supported by it.

Parameters:
  • id (str) –
  • ServicePartitionKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PagedReplicaInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.ReplicaInfo(replica_status=None, health_state=None, node_name=None, address=None, last_in_build_duration_in_seconds=None)[source]

Bases: msrest.serialization.Model

Information about the identity, status, health, node name, uptime, and other details about the replica.

Parameters:
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – The name of the node.
  • address (str) – The address the replica is listening on.
  • last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PagedServiceInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.ServiceInfo(id=None, name=None, type_name=None, manifest_version=None, health_state=None, service_status=None, is_service_group=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric service.

Parameters:
  • id (str) –
  • name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • type_name (str) – The name of the service type as specified in the service manifest.
  • manifest_version (str) – The version of the service manifest.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_status (str) – Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
  • is_service_group (bool) – Whether the service is in a service group.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PartitionHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, partition_id=None, replica_health_states=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Information about the health of a Service Fabric partition.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • partition_id (str) – ID of the partition whose health information is described by this object.
  • replica_health_states (list of ReplicaHealthState) – The list of replica health states associated with the partition.
class azure.servicefabric.models.ReplicaHealthState(aggregated_health_state=None, partition_id=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents a base class for stateful service replica or stateless service instance health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_id (str) – The ID of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PartitionHealthEvaluation(aggregated_health_state=None, description=None, partition_id=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation.
class azure.servicefabric.models.PartitionHealthState(aggregated_health_state=None, partition_id=None)[source]

Bases: azure.servicefabric.models.entity_health_state.EntityHealthState

Represents the health state of a partition, which contains the partition identifier and its aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_id (str) – The ID of the partition.
class azure.servicefabric.models.PartitionSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.safety_check.SafetyCheck

Represents a safety check for the service partition being performed by service fabric before continuing with operations.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.EnsureAvailabilitySafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that waits for ensures the avaiability of the partition. It waits until there are replicas avaiabile such that bring down this replica will not cause avaiability loss for the partition.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.EnsurePartitionQurumSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that ensures that a quorum of replicas are not lost for a partition.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.SeedNodeSafetyCheck[source]

Bases: azure.servicefabric.models.safety_check.SafetyCheck

Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.

Parameters:Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PartitionsHealthEvaluation(aggregated_health_state=None, description=None, max_percent_unhealthy_partitions_per_service=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • max_percent_unhealthy_partitions_per_service (int) – Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy.
  • total_count (long) – Total number of partitions of the service from the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.ReplicaHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, partition_id=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations. .

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • partition_id (str) – Id of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.ReplicaHealthEvaluation(aggregated_health_state=None, description=None, partition_id=None, replica_or_instance_id=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition to which the replica belongs.
  • replica_or_instance_id (str) – Id of the stateful service replica or the stateless service instance.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation.
class azure.servicefabric.models.ReplicasHealthEvaluation(aggregated_health_state=None, description=None, max_percent_unhealthy_replicas_per_partition=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • max_percent_unhealthy_replicas_per_partition (int) – Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy.
  • total_count (long) – Total number of replicas in the partition from the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.RestartNodeDescription(node_instance_id='0', create_fabric_dump='False')[source]

Bases: msrest.serialization.Model

Describes the parameters to restart a Service Fabric node.

Parameters:
  • node_instance_id (str) – The instance id of the target node. If instance id is specified the node is restarted only if it matches with the current instance of the node. A default value of “0” would match any instance id. The instance id can be obtained using get node query. Default value: “0” .
  • create_fabric_dump (str) – Specify True to create a dump of the fabric node process. This is case sensitive. Possible values include: ‘False’, ‘True’. Default value: “False” .
class azure.servicefabric.models.ServiceFromTemplateDescription(application_name, service_name, service_type_name, initialization_data=None, service_package_activation_mode=None, service_dns_name=None)[source]

Bases: msrest.serialization.Model

Defines description for creating a Service Fabric service from a template defined in the application manifest. .

Parameters:
  • application_name (str) – Full name of the application.
  • service_name (str) – Full name of the service.
  • service_type_name (str) – The name of the Service Fabric service type.
  • initialization_data (list of int) – The initialization data for the newly created service instance.
  • service_package_activation_mode (str) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  • service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
class azure.servicefabric.models.ServiceHealthEvaluation(aggregated_health_state=None, description=None, service_name=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • service_name (str) – Full name of the service.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation.
class azure.servicefabric.models.ServiceHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, name=None, partition_health_states=None)[source]

Bases: azure.servicefabric.models.entity_health.EntityHealth

Information about the health of a Service Fabric service.

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • name (str) – The name of the service whose health information is described by this object.
  • partition_health_states (list of PartitionHealthState) – The list of partition health states associated with the service.
class azure.servicefabric.models.ServiceNameInfo(id=None, name=None)[source]

Bases: msrest.serialization.Model

Information about the service name.

Parameters:
  • id (str) –
  • name (str) – The name of the service.
class azure.servicefabric.models.ServicePlacementInvalidDomainPolicyDescription(domain_name=None)[source]

Bases: azure.servicefabric.models.service_placement_policy_description.ServicePlacementPolicyDescription

Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.

Parameters:
  • Type (str) – Polymorphic Discriminator
  • domain_name (str) – The name of the domain that should not be used for placement.
class azure.servicefabric.models.ServicePlacementNonPartiallyPlaceServicePolicyDescription[source]

Bases: azure.servicefabric.models.service_placement_policy_description.ServicePlacementPolicyDescription

Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created. .

Parameters:Type (str) – Polymorphic Discriminator
class azure.servicefabric.models.ServicePlacementPolicyDescription[source]

Bases: msrest.serialization.Model

Describes the policy to be used for placement of a Service Fabric service.

Parameters:Type (str) – Polymorphic Discriminator
class azure.servicefabric.models.ServicePlacementPreferPrimaryDomainPolicyDescription(domain_name=None)[source]

Bases: azure.servicefabric.models.service_placement_policy_description.ServicePlacementPolicyDescription

Describes the policy to be used for placement of a Service Fabric service where the service’s Primary replicas should optimally be placed in a particular domain. This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service�s primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints. .

Parameters:
  • Type (str) – Polymorphic Discriminator
  • domain_name (str) – The name of the domain that should used for placement as per this policy.
class azure.servicefabric.models.ServicePlacementRequiredDomainPolicyDescription(domain_name=None)[source]

Bases: azure.servicefabric.models.service_placement_policy_description.ServicePlacementPolicyDescription

Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.

Parameters:
  • Type (str) – Polymorphic Discriminator
  • domain_name (str) – The name of the domain that should used for placement as per this policy.
class azure.servicefabric.models.ServicePlacementRequireDomainDistributionPolicyDescription(domain_name=None)[source]

Bases: azure.servicefabric.models.service_placement_policy_description.ServicePlacementPolicyDescription

Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain. While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set. .

Parameters:
  • Type (str) – Polymorphic Discriminator
  • domain_name (str) – The name of the domain that should used for placement as per this policy.
class azure.servicefabric.models.ServicesHealthEvaluation(aggregated_health_state=None, description=None, service_type_name=None, max_percent_unhealthy_services=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • service_type_name (str) – Name of the service type of the services.
  • max_percent_unhealthy_services (int) – Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy.
  • total_count (long) – Total number of services of the current service type in the application from the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.ServiceTypeDescription(is_stateful=None, service_type_name=None, placement_constraints=None, service_placement_policies=None, extensions=None)[source]

Bases: msrest.serialization.Model

Describes a service type defined in the service manifest of a provisioned application type. The properties the the ones defined in the service manifest.

Parameters:
  • is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
  • service_type_name (str) – Name of the service type.
  • placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
  • service_placement_policies (list of ServicePlacementPolicyDescription) –
  • extensions (list of ServiceTypeExtensionDescription) –
  • Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.ServiceTypeExtensionDescription(key=None, value=None)[source]

Bases: msrest.serialization.Model

Describes extension of a service type defined in the service manifest.

Parameters:
  • key (str) – The name of the extension.
  • value (str) – The extension value.
class azure.servicefabric.models.ServiceTypeInfo(service_type_description=None, service_manifest_name=None, service_manifest_version=None, is_service_group=None)[source]

Bases: msrest.serialization.Model

Information about a service type that is defined in a service manifest of a provisioned application type.

Parameters:
  • service_type_description (ServiceTypeDescription) –
  • service_manifest_name (str) – The name of the service manifest in which this service type is defined.
  • service_manifest_version (str) – The version of the service manifest in which this service type is defined.
  • is_service_group (bool) – Indicates whether the service is a service group. If it is, the property value is true otherwise false.
class azure.servicefabric.models.ServiceTypeManifest(manifest=None)[source]

Bases: msrest.serialization.Model

Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.

Parameters:manifest (str) – The XML manifest as a string.
class azure.servicefabric.models.SingletonPartitionInformation(id=None)[source]

Bases: azure.servicefabric.models.partition_information.PartitionInformation

Information about a partition that is singleton. The services with singletone partitioning scheme are effectively non-partitioned. They only have one partition.

Parameters:
  • id (str) –
  • ServicePartitionKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.StartNodeDescription(node_instance_id='0')[source]

Bases: msrest.serialization.Model

Describes the parameter for starting a stopped Service Fabric node.

Parameters:node_instance_id (str) – The instance id of the node that is stopped. If instance id is specified the node is started only if it matches with the current instance of the stopped node. A default value of “0” would match any instance id. The instance id can be obtained using get node query. Default value: “0” .
class azure.servicefabric.models.StatefulServiceInfo(id=None, name=None, type_name=None, manifest_version=None, health_state=None, service_status=None, is_service_group=None, has_persisted_state=None)[source]

Bases: azure.servicefabric.models.service_info.ServiceInfo

Information about a stateful Service Fabric service.

Parameters:
  • id (str) –
  • name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • type_name (str) – The name of the service type as specified in the service manifest.
  • manifest_version (str) – The version of the service manifest.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_status (str) – Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
  • is_service_group (bool) – Whether the service is in a service group.
  • ServiceKind (str) – Polymorphic Discriminator
  • has_persisted_state (bool) – Whether the service has persisted state.
class azure.servicefabric.models.StatefulServicePartitionInfo(health_state=None, partition_status=None, partition_information=None, target_replica_set_size=None, min_replica_set_size=None, last_quorum_loss_duration=None, current_configuration_epoch=None)[source]

Bases: azure.servicefabric.models.service_partition_info.ServicePartitionInfo

Information about a partition of a stateful Service Fabric service..

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_status (str) – Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
  • partition_information (PartitionInformation) –
  • ServiceKind (str) – Polymorphic Discriminator
  • target_replica_set_size (long) – The target replica set size as a number.
  • min_replica_set_size (long) – The minimum replica set size as a number.
  • last_quorum_loss_duration (timedelta) – The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration.
  • current_configuration_epoch (Epoch) –
class azure.servicefabric.models.StatefulServiceReplicaHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, partition_id=None, replica_id=None)[source]

Bases: azure.servicefabric.models.replica_health.ReplicaHealth

Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations. .

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • partition_id (str) – Id of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_id (str) – Id of the stateful service replica.
class azure.servicefabric.models.StatefulServiceReplicaHealthState(aggregated_health_state=None, partition_id=None, replica_id=None)[source]

Bases: azure.servicefabric.models.replica_health_state.ReplicaHealthState

Represents the health state of the stateful service replica, which contains the replica id and the aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_id (str) – The ID of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_id (str) – The ID of the stateful service replica.
class azure.servicefabric.models.StatefulServiceTypeDescription(is_stateful=None, service_type_name=None, placement_constraints=None, service_placement_policies=None, extensions=None, has_persisted_state=None)[source]

Bases: azure.servicefabric.models.service_type_description.ServiceTypeDescription

Describes a stateful service type defined in the service manifest of a provisioned application type.

Parameters:
  • is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
  • service_type_name (str) – Name of the service type.
  • placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
  • service_placement_policies (list of ServicePlacementPolicyDescription) –
  • extensions (list of ServiceTypeExtensionDescription) –
  • Kind (str) – Polymorphic Discriminator
  • has_persisted_state (bool) – A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
class azure.servicefabric.models.StatelessServiceInfo(id=None, name=None, type_name=None, manifest_version=None, health_state=None, service_status=None, is_service_group=None)[source]

Bases: azure.servicefabric.models.service_info.ServiceInfo

Information about a stateless Service Fabric service.

Parameters:
  • id (str) –
  • name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • type_name (str) – The name of the service type as specified in the service manifest.
  • manifest_version (str) – The version of the service manifest.
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • service_status (str) – Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
  • is_service_group (bool) – Whether the service is in a service group.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.StatelessServiceInstanceHealth(aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, partition_id=None, instance_id=None)[source]

Bases: azure.servicefabric.models.replica_health.ReplicaHealth

Represents the health of the statelss service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations. .

Parameters:
  • aggregated_health_state (str) – The HealthState representing the 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’
  • health_events (list of HealthEvent) – The list of health events reported on the entity.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
  • partition_id (str) – Id of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_id (str) – Id of the stateless service instance.
class azure.servicefabric.models.StatelessServiceInstanceHealthState(aggregated_health_state=None, partition_id=None, replica_id=None)[source]

Bases: azure.servicefabric.models.replica_health_state.ReplicaHealthState

Represents the health state of the stateless service instance, which contains the instance id and the aggregated health state.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_id (str) – The ID of the partition to which this replica belongs.
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_id (str) – Id of the stateless service instance on the wire this field is called ReplicaId.
class azure.servicefabric.models.StatelessServicePartitionInfo(health_state=None, partition_status=None, partition_information=None, instance_count=None)[source]

Bases: azure.servicefabric.models.service_partition_info.ServicePartitionInfo

Information about a partition of a stateless Service Fabric service.

Parameters:
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • partition_status (str) – Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
  • partition_information (PartitionInformation) –
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_count (long) – Number of instances of this partition.
class azure.servicefabric.models.StatelessServiceTypeDescription(is_stateful=None, service_type_name=None, placement_constraints=None, service_placement_policies=None, extensions=None, use_implicit_host=None)[source]

Bases: azure.servicefabric.models.service_type_description.ServiceTypeDescription

Describes a stateless service type defined in the service manifest of a provisioned application type.

Parameters:
  • is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
  • service_type_name (str) – Name of the service type.
  • placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
  • service_placement_policies (list of ServicePlacementPolicyDescription) –
  • extensions (list of ServiceTypeExtensionDescription) –
  • Kind (str) – Polymorphic Discriminator
  • use_implicit_host (bool) – A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise.
class azure.servicefabric.models.StopNodeDescription(node_instance_id='0')[source]

Bases: msrest.serialization.Model

Describes the parameter for stopping a Service Fabric node.

Parameters:node_instance_id (str) – The instance id of the target node. If instance id is specified the node is stopped only if it matches with the current instance of the node. A default value of “0” would match any instance id. The instance id can be obtained using get node query. Default value: “0” .
class azure.servicefabric.models.SystemApplicationHealthEvaluation(aggregated_health_state=None, description=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
class azure.servicefabric.models.UpgradeDomainDeltaNodesCheckHealthEvaluation(aggregated_health_state=None, description=None, upgrade_domain_name=None, baseline_error_count=None, baseline_total_count=None, max_percent_delta_unhealthy_nodes=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error. .

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • upgrade_domain_name (str) – Name of the upgrade domain where nodes health is currently evaluated.
  • baseline_error_count (long) – Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
  • baseline_total_count (long) – Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade.
  • max_percent_delta_unhealthy_nodes (int) – Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
  • total_count (long) – Total number of upgrade domain nodes in the health store.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.UpgradeDomainNodesHealthEvaluation(aggregated_health_state=None, description=None, upgrade_domain_name=None, max_percent_unhealthy_nodes=None, total_count=None, unhealthy_evaluations=None)[source]

Bases: azure.servicefabric.models.health_evaluation.HealthEvaluation

Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.

Parameters:
  • aggregated_health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
  • Kind (str) – Polymorphic Discriminator
  • upgrade_domain_name (str) – Name of the upgrade domain where nodes health is currently evaluated.
  • max_percent_unhealthy_nodes (int) – Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
  • total_count (long) – Total number of nodes in the current upgrade domain.
  • unhealthy_evaluations (list of HealthEvaluationWrapper) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
class azure.servicefabric.models.WaitForInbuildReplicaSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that waits for the replica build operation to finish. This indiciates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typoically expensive involving data movements.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.WaitForPrimaryPlacementSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.WaitForPrimarySwapSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the avaiability of the primary replica for the partition.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.WaitForReconfigurationSafetyCheck(partition_id=None)[source]

Bases: azure.servicefabric.models.partition_safety_check.PartitionSafetyCheck

Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • partition_id (str) – Id of the partition which is undergoing the safety check.
class azure.servicefabric.models.LoadMetricReport(last_reported_utc=None, name=None, value=None)[source]

Bases: msrest.serialization.Model

Represents the load metric report which contains the time metric was reported, its name and value.

Parameters:
  • last_reported_utc (datetime) – Gets the UTC time when the load was reported.
  • name (str) – The name of the load metric.
  • value (str) – The value of the load metric.
class azure.servicefabric.models.PartitionLoadInformation(partition_id=None, primary_load_metric_reports=None, secondary_load_metric_reports=None)[source]

Bases: msrest.serialization.Model

Represents load information for a partition, which contains the primary and secondary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport’s LastReportedUtc is set to 0. .

Parameters:
  • partition_id (str) – Id of the partition.
  • primary_load_metric_reports (list of LoadMetricReport) – Array of load reports from the primary replica for this partition.
  • secondary_load_metric_reports (list of LoadMetricReport) – Array of aggregated load reports from all secondary replicas for this partition. Array only contains the latest reported load for each metric.
class azure.servicefabric.models.StatefulServiceReplicaInfo(replica_status=None, health_state=None, node_name=None, address=None, last_in_build_duration_in_seconds=None, replica_role=None, replica_id=None)[source]

Bases: azure.servicefabric.models.replica_info.ReplicaInfo

Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.

Parameters:
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – The name of the node.
  • address (str) – The address the replica is listening on.
  • last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_role (str) – Possible values include: ‘Unknown’, ‘None’, ‘Primary’, ‘IdleSecondary’, ‘ActiveSecondary’
  • replica_id (str) –
class azure.servicefabric.models.StatelessServiceInstanceInfo(replica_status=None, health_state=None, node_name=None, address=None, last_in_build_duration_in_seconds=None, instance_id=None)[source]

Bases: azure.servicefabric.models.replica_info.ReplicaInfo

Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.

Parameters:
  • replica_status (str) – Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
  • health_state (str) – Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
  • node_name (str) – The name of the node.
  • address (str) – The address the replica is listening on.
  • last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_id (str) – Id of the stateless service instance.
class azure.servicefabric.models.ClusterUpgradeDescriptionObject(config_version=None, code_version=None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds=None, force_restart=None, enable_delta_health_evaluation=None, monitoring_policy=None, cluster_health_policy=None, cluster_upgrade_health_policy=None, application_health_policy_map=None)[source]

Bases: msrest.serialization.Model

Represents a ServiceFabric cluster upgrade.

Parameters:
  • config_version (str) –
  • code_version (str) –
  • upgrade_kind (str) – Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
  • rolling_upgrade_mode (str) – Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
  • upgrade_replica_set_check_timeout_in_seconds (long) –
  • force_restart (bool) –
  • enable_delta_health_evaluation (bool) –
  • monitoring_policy (MonitoringPolicyDescription) –
  • cluster_health_policy (ClusterHealthPolicy) –
  • cluster_upgrade_health_policy (ClusterUpgradeHealthPolicyObject) –
  • application_health_policy_map (list of ApplicationHealthPolicyMapItem) –
class azure.servicefabric.models.ClusterUpgradeHealthPolicyObject(max_percent_delta_unhealthy_nodes=None, max_percent_upgrade_domain_delta_unhealthy_nodes=None)[source]

Bases: msrest.serialization.Model

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

Parameters:
  • max_percent_delta_unhealthy_nodes (int) – The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.
  • max_percent_upgrade_domain_delta_unhealthy_nodes (int) – The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.
class azure.servicefabric.models.ClusterUpgradeProgressObject(code_version=None, config_version=None, upgrade_domains=None, upgrade_state=None, next_upgrade_domain=None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds=None, upgrade_domain_duration_in_milliseconds=None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc=None, failure_timestamp_utc=None, failure_reason=None, upgrade_domain_progress_at_failure=None)[source]

Bases: msrest.serialization.Model

Information about a cluster upgrade.

Parameters:
  • code_version (str) –
  • config_version (str) –
  • upgrade_domains (list of UpgradeDomainInfo) –
  • upgrade_state (str) – Possible values include: ‘Invalid’, ‘RollingBackInProgress’, ‘RollingBackCompleted’, ‘RollingForwardPending’, ‘RollingForwardInProgress’, ‘RollingForwardCompleted’, ‘Failed’
  • next_upgrade_domain (str) –
  • rolling_upgrade_mode (str) – Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
  • upgrade_description (ClusterUpgradeDescriptionObject) –
  • upgrade_duration_in_milliseconds (str) –
  • upgrade_domain_duration_in_milliseconds (str) –
  • unhealthy_evaluations (list of HealthEvaluationWrapper) –
  • current_upgrade_domain_progress (CurrentUpgradeDomainProgressInfo) –
  • start_timestamp_utc (str) –
  • failure_timestamp_utc (str) –
  • failure_reason (str) – Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘UpgradeTimeout’
  • upgrade_domain_progress_at_failure (FailedUpgradeDomainProgressObject) –
class azure.servicefabric.models.FailedUpgradeDomainProgressObject(domain_name=None, node_upgrade_progress_list=None)[source]

Bases: msrest.serialization.Model

The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.

Parameters:
class azure.servicefabric.models.ApplicationTypeImageStorePath(application_type_build_path)[source]

Bases: msrest.serialization.Model

Path description for the application package in the image store specified during the prior copy operation.

Parameters:application_type_build_path (str) – The relative image store path to the application package.
class azure.servicefabric.models.ApplicationTypeImageStoreVersion(application_type_version)[source]

Bases: msrest.serialization.Model

A version description for the application type.

Parameters:application_type_version (str) – The application type version.
class azure.servicefabric.models.CodePackageEntryPointStatistics(last_exit_code=None, last_activation_time=None, last_exit_time=None, last_successful_activation_time=None, last_successful_exit_time=None, activation_count=None, activation_failure_count=None, continuous_activation_failure_count=None, exit_count=None, exit_failure_count=None, continuous_exit_failure_count=None)[source]

Bases: msrest.serialization.Model

Statistics about setup or main entry point of a code package deployed on a Service Fabric node.

Parameters:
  • last_exit_code (str) – The last exit code of the entry point.
  • last_activation_time (datetime) – The last time (in UTC) when Service Fabric attempted to run the entry point.
  • last_exit_time (datetime) – The last time (in UTC) when the entry point finished running.
  • last_successful_activation_time (datetime) – The last time (in UTC) when the entry point ran successfully.
  • last_successful_exit_time (datetime) – The last time (in UTC) when the entry point finished running gracefully.
  • activation_count (str) – Number of times the entry point has run.
  • activation_failure_count (str) – Number of times the entry point failed to run.
  • continuous_activation_failure_count (str) – Number of times the entry point continuously failed to run.
  • exit_count (str) – Number of times the entry point finished running.
  • exit_failure_count (str) – Number of times the entry point failed to exit gracefully.
  • continuous_exit_failure_count (str) – Number of times the entry point continuously failed to exit gracefully.
class azure.servicefabric.models.DeployedCodePackageInfo(name=None, version=None, service_manifest_name=None, service_package_activation_id=None, host_type=None, host_isolation_mode=None, status=None, run_frequency_interval=None, setup_entry_point=None, main_entry_point=None)[source]

Bases: msrest.serialization.Model

Information about code package deployed on a Service Fabric node.

Parameters:
  • name (str) – The name of the code package.
  • version (str) – The version of the code package specified in service manifest.
  • service_manifest_name (str) – The name of service manifest that specified this code package.
  • service_package_activation_id (str) –
  • host_type (str) – Possible values include: ‘Invalid’, ‘ExeHost’, ‘ContainerHost’
  • host_isolation_mode (str) – Possible values include: ‘None’, ‘Process’, ‘HyperV’
  • status (str) – Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’
  • run_frequency_interval (str) – The interval at which code package is run. This is used for periodic code package.
  • setup_entry_point (CodePackageEntryPoint) –
  • main_entry_point (CodePackageEntryPoint) –
class azure.servicefabric.models.CodePackageEntryPoint(entry_point_location=None, process_id=None, run_as_user_name=None, code_package_entry_point_statistics=None, status=None, next_activation_time=None, instance_id=None)[source]

Bases: msrest.serialization.Model

Information about setup or main entry point of a code package deployed on a Service Fabric node.

Parameters:
  • entry_point_location (str) – The location of entry point executable on the node.
  • process_id (str) – The process id of the entry point.
  • run_as_user_name (str) – The user name under which entry point executable is run on the node.
  • code_package_entry_point_statistics (CodePackageEntryPointStatistics) –
  • status (str) – Possible values include: ‘Invalid’, ‘Pending’, ‘Starting’, ‘Started’, ‘Stopping’, ‘Stopped’
  • next_activation_time (datetime) – The time (in UTC) when the entry point executable will be run next.
  • instance_id (str) –
class azure.servicefabric.models.ChaosContextMapItem(key, value)[source]

Bases: msrest.serialization.Model

Describes an item in the ChaosContextMap in ChaosParameters. .

Parameters:
  • key (str) – The key for a ChaosContextMapItem.
  • value (str) – The value for a ChaosContextMapItem.
class azure.servicefabric.models.ChaosContext(map=None)[source]

Bases: msrest.serialization.Model

Describes a map, which is collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs. This map is set by the starter of the Choas run to optionally store the context about the specific run. .

Parameters:map (object) –
class azure.servicefabric.models.ChaosParameters(time_to_run_in_seconds='4294967295', max_cluster_stabilization_timeout_in_seconds=60, max_concurrent_faults=1, enable_move_replica_faults=True, wait_time_between_faults_in_seconds=20, wait_time_between_iterations_in_seconds=30, cluster_health_policy=None, context=None)[source]

Bases: msrest.serialization.Model

Defines all the parameters to configure a Chaos run. .

Parameters:
  • time_to_run_in_seconds (str) – Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). Depending on other time settings, the actual running time of Chaos can be larger than the TimeToRunInSeconds. To be conservative, we should expect Chaos to automatically stop after (MaxClusterStabilizationTimeoutInSeconds + MaxConcurrentFaults * WaitTimeBetweenFaultsInSeconds + WaitTimeBetweenIterationsInSeconds) seconds. . Default value: “4294967295” .
  • max_cluster_stabilization_timeout_in_seconds (long) – The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. . Default value: 60 .
  • max_concurrent_faults (long) – MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults – inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. . Default value: 1 .
  • enable_move_replica_faults (bool) – Enables or disables the move primary and move secondary faults. . Default value: True .
  • wait_time_between_faults_in_seconds (long) – Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. . Default value: 20 .
  • wait_time_between_iterations_in_seconds (long) – Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. . Default value: 30 .
  • cluster_health_policy (ClusterHealthPolicy) – Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error, Chaos will wait for ChaosParameters.WaitTimeBetweenIterationsInSeconds before the next check.
  • context (ChaosContext) –
class azure.servicefabric.models.ChaosEvent(time_stamp_utc)[source]

Bases: msrest.serialization.Model

Represents an event generated during a Chaos run.

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.ChaosEventWrapper(chaos_event=None)[source]

Bases: msrest.serialization.Model

Wrapper object for Chaos event.

Parameters:chaos_event (ChaosEvent) –
class azure.servicefabric.models.ChaosReport(chaos_parameters=None, status=None, continuation_token=None, history=None)[source]

Bases: msrest.serialization.Model

Contains detailed Chaos report. .

Parameters:
  • chaos_parameters (ChaosParameters) –
  • status (str) – Current status of the Chaos run. - Invalid - Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero. - Running - Indicates that Chaos is not stopped. - Stopped - Indicates that Chaos is not scheduling futher faults. Possible values include: ‘Invalid’, ‘Running’, ‘Stopped’
  • continuation_token (str) –
  • history (list of ChaosEventWrapper) – List of ChaosEvent’s that meet the user-supplied criteria.
class azure.servicefabric.models.ExecutingFaultsChaosEvent(time_stamp_utc, faults=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
  • faults (list of str) –
class azure.servicefabric.models.StartedChaosEvent(time_stamp_utc, chaos_parameters=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Describes a Chaos event that gets generated when Chaos is started.

Parameters:
class azure.servicefabric.models.StoppedChaosEvent(time_stamp_utc, reason=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
  • reason (str) –
class azure.servicefabric.models.TestErrorChaosEvent(time_stamp_utc, reason=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting a faultable entity, Chaos found that the entity was alreay faulted – which would be an unexpected event. .

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
  • reason (str) –
class azure.servicefabric.models.ValidationFailedChaosEvent(time_stamp_utc, reason=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Chaos event corresponding to a failure during validation.

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
  • reason (str) –
class azure.servicefabric.models.WaitingChaosEvent(time_stamp_utc, reason=None)[source]

Bases: azure.servicefabric.models.chaos_event.ChaosEvent

Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.

Parameters:
  • time_stamp_utc (datetime) –
  • Kind (str) – Polymorphic Discriminator
  • reason (str) –
class azure.servicefabric.models.ApplicationCapacityDescription(minimum_nodes=None, maximum_nodes=0, application_metrics=None)[source]

Bases: msrest.serialization.Model

Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the services on the nodes - 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 .

Parameters:
  • minimum_nodes (long) – The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
  • maximum_nodes (long) – The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. Default value: 0 .
  • application_metrics (list of ApplicationMetricDescription) –
class azure.servicefabric.models.ApplicationMetricDescription(name=None, maximum_capacity=None, reservation_capacity=None, total_application_capacity=None)[source]

Bases: msrest.serialization.Model

Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application. .

Parameters:
  • name (str) – The name of the metric.
  • maximum_capacity (long) – The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.
  • reservation_capacity (long) – The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.
  • total_application_capacity (long) – The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.
class azure.servicefabric.models.ApplicationDescription(name, type_name, type_version, parameter_list=None, application_capacity=None)[source]

Bases: msrest.serialization.Model

Describes a Service Fabric application.

Parameters:
class azure.servicefabric.models.ComposeApplicationStatusInfo(name=None, status=None, status_details=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric compose application.

Parameters:
  • name (str) –
  • status (str) – Possible values include: ‘Invalid’, ‘Provisioning’, ‘Creating’, ‘Created’, ‘Unprovisioning’, ‘Deleting’, ‘Failed’
  • status_details (str) – The status details of compose application including failure message.
class azure.servicefabric.models.PagedComposeApplicationStatusInfoList(continuation_token=None, items=None)[source]

Bases: msrest.serialization.Model

The list of compose applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Parameters:
class azure.servicefabric.models.CreateComposeApplicationDescription(application_name, compose_file_content, repository_credential=None)[source]

Bases: msrest.serialization.Model

Defines description for creating a Service Fabric compose application. .

Parameters:
  • application_name (str) –
  • compose_file_content (str) – The content of the compose file that describes application to create.
  • repository_credential (RepositoryCredential) –
class azure.servicefabric.models.RepositoryCredential(repository_user_name=None, repository_password=None, password_encrypted=None)[source]

Bases: msrest.serialization.Model

Credential information to connect to container repository.

Parameters:
  • repository_user_name (str) – The user name to connect to container repository.
  • repository_password (str) – The password for supplied username to connect to container repository.
  • password_encrypted (bool) – Indicates that supplied container repository password is encrypted.
class azure.servicefabric.models.DeployedServicePackageInfo(name=None, version=None, status=None, service_package_activation_id=None)[source]

Bases: msrest.serialization.Model

Information about service package deployed on a Service Fabric node.

Parameters:
  • name (str) – The name of the service package.
  • version (str) – The version of the service package specified in service manifest.
  • status (str) – Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’
  • service_package_activation_id (str) –
class azure.servicefabric.models.ServiceCorrelationDescription(scheme, service_name)[source]

Bases: msrest.serialization.Model

Creates a particular correlation between services.

Parameters:
  • scheme (str) – The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Possible values include: ‘Invalid’, ‘Affinity’, ‘AlignedAffinity’, ‘NonAlignedAffinity’
  • service_name (str) – The name of the service that the correlation relationship is established with.
class azure.servicefabric.models.ServiceLoadMetricDescription(name, weight=None, primary_default_load=None, secondary_default_load=None, default_load=None)[source]

Bases: msrest.serialization.Model

Specifies a metric to load balance a service during runtime.

Parameters:
  • name (str) – The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
  • weight (str) – The service load metric relative weight, compared to other metrics configured for this service, as a number. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • primary_default_load (int) – Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
  • secondary_default_load (int) – Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
  • default_load (int) – Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
class azure.servicefabric.models.PartitionSchemeDescription[source]

Bases: msrest.serialization.Model

Describes how the service is partitioned.

Parameters:PartitionScheme (str) – Polymorphic Discriminator
class azure.servicefabric.models.NamedPartitionSchemeDescription(count, names)[source]

Bases: azure.servicefabric.models.partition_scheme_description.PartitionSchemeDescription

Describes the named partition scheme of the service.

Parameters:
  • PartitionScheme (str) – Polymorphic Discriminator
  • count (int) – The number of partitions.
  • names (list of str) – Array of size specified by the ‘Count’ parameter, for the names of the partitions.
class azure.servicefabric.models.SingletonPartitionSchemeDescription[source]

Bases: azure.servicefabric.models.partition_scheme_description.PartitionSchemeDescription

Describes the partition scheme of a singleton-partitioned, or non-partitioned service.

Parameters:PartitionScheme (str) – Polymorphic Discriminator
class azure.servicefabric.models.UniformInt64RangePartitionSchemeDescription(count, low_key, high_key)[source]

Bases: azure.servicefabric.models.partition_scheme_description.PartitionSchemeDescription

Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.

Parameters:
  • PartitionScheme (str) – Polymorphic Discriminator
  • count (int) – The number of partitions.
  • low_key (str) – String indicating the lower bound of the partition key range that should be split between the partition ‘Count’
  • high_key (str) – String indicating the upper bound of the partition key range that should be split between the partition ‘Count’
class azure.servicefabric.models.ServiceDescription(service_name, service_type_name, partition_description, application_name=None, initialization_data=None, placement_constraints=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified=None, service_package_activation_mode=None, service_dns_name=None)[source]

Bases: msrest.serialization.Model

A ServiceDescription contains all of the information necessary to create a service.

Parameters:
  • application_name (str) – The application name.
  • service_name (str) – The service name.
  • service_type_name (str) – The service type name.
  • initialization_data (list of int) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
  • partition_description (PartitionSchemeDescription) – The partition description as an object.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • service_load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
  • service_package_activation_mode (str) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  • service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.StatefulServiceDescription(service_name, service_type_name, partition_description, target_replica_set_size, min_replica_set_size, has_persisted_state, application_name=None, initialization_data=None, placement_constraints=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified=None, service_package_activation_mode=None, service_dns_name=None, flags=None, replica_restart_wait_duration_seconds=None, quorum_loss_wait_duration_seconds=None, stand_by_replica_keep_duration_seconds=None)[source]

Bases: azure.servicefabric.models.service_description.ServiceDescription

Describes a stateful service.

Parameters:
  • application_name (str) – The application name.
  • service_name (str) – The service name.
  • service_type_name (str) – The service type name.
  • initialization_data (list of int) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
  • partition_description (PartitionSchemeDescription) – The partition description as an object.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • service_load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
  • service_package_activation_mode (str) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  • service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
  • ServiceKind (str) – Polymorphic Discriminator
  • target_replica_set_size (int) – The target replica set size as a number.
  • min_replica_set_size (int) – The minimum replica set size as a number.
  • has_persisted_state (bool) – A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
  • flags (int) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set. - None - Does not indicate any other properties are set. The value is zero. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4.
  • replica_restart_wait_duration_seconds (long) – The duration, in seconds, between when a replica goes down and when a new replica is created.
  • quorum_loss_wait_duration_seconds (long) – The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
  • stand_by_replica_keep_duration_seconds (long) – The definition on how long StandBy replicas should be maintained before being removed.
class azure.servicefabric.models.StatelessServiceDescription(service_name, service_type_name, partition_description, instance_count, application_name=None, initialization_data=None, placement_constraints=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified=None, service_package_activation_mode=None, service_dns_name=None)[source]

Bases: azure.servicefabric.models.service_description.ServiceDescription

Describes a stateless service.

Parameters:
  • application_name (str) – The application name.
  • service_name (str) – The service name.
  • service_type_name (str) – The service type name.
  • initialization_data (list of int) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
  • partition_description (PartitionSchemeDescription) – The partition description as an object.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • service_load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
  • service_package_activation_mode (str) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  • service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_count (int) – The instance count.
class azure.servicefabric.models.ReplicatorQueueStatus(queue_utilization_percentage=None, queue_memory_size=None, first_sequence_number=None, completed_sequence_number=None, committed_sequence_number=None, last_sequence_number=None)[source]

Bases: msrest.serialization.Model

Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings. .

Parameters:
  • queue_utilization_percentage (int) – Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full.
  • queue_memory_size (str) – Represents the virtual memory consumed by the queue in bytes.
  • first_sequence_number (str) – On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is the smallest sequence number of the operation that is present in the queue.
  • completed_sequence_number (str) – On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state.
  • committed_sequence_number (str) – On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary.
  • last_sequence_number (str) – Represents the latest sequence number of the operation that is available in the queue.
class azure.servicefabric.models.ReplicatorStatus[source]

Bases: msrest.serialization.Model

Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. .

Parameters:Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.PrimaryReplicatorStatus(replication_queue_status=None, remote_replicators=None)[source]

Bases: azure.servicefabric.models.replicator_status.ReplicatorStatus

PrimaryReplicatorStatus.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the primary replicator.
  • remote_replicators (list of RemoteReplicatorStatus) – The status of all the active and idle secondary replicators that the primary is aware of.
class azure.servicefabric.models.RemoteReplicatorStatus(replica_id=None, last_acknowledgement_processed_time_utc=None, last_received_replication_sequence_number=None, last_applied_replication_sequence_number=None, is_in_build=None, last_received_copy_sequence_number=None, last_applied_copy_sequence_number=None, remote_replicator_acknowledgement_status=None)[source]

Bases: msrest.serialization.Model

Represents the state of the secondary replicator from the primary replicator’s point of view. .

Parameters:
  • replica_id (str) – Represents the replica id of the remote secondary replicator.
  • last_acknowledgement_processed_time_utc (datetime) – The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary. UTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed.
  • last_received_replication_sequence_number (str) – The highest replication operation sequence number that the secondary has received from the primary.
  • last_applied_replication_sequence_number (str) – The highest replication operation sequence number that the secondary has applied to its state.
  • is_in_build (bool) – A value that indicates whether the secondary replica is in the process of being built.
  • last_received_copy_sequence_number (str) – The highest copy operation sequence number that the secondary has received from the primary. A value of -1 implies that the secondary has received all copy operations.
  • last_applied_copy_sequence_number (str) – The highest copy operation sequence number that the secondary has applied to its state. A value of -1 implies that the secondary has applied all copy operations and the copy process is complete.
  • remote_replicator_acknowledgement_status (RemoteReplicatorAcknowledgementStatus) – Represents the acknowledgement status for the remote secondary replicator.
class azure.servicefabric.models.RemoteReplicatorAcknowledgementStatus(replication_stream_acknowledgement_detail=None, copy_stream_acknowledgement_detail=None)[source]

Bases: msrest.serialization.Model

Provides details about the remote replicators from the primary replicator’s point of view.

Parameters:
class azure.servicefabric.models.RemoteReplicatorAcknowledgementDetail(average_receive_duration=None, average_apply_duration=None, not_received_count=None, received_and_not_applied_count=None)[source]

Bases: msrest.serialization.Model

Provides various statistics of the acknowledgements that are being received from the remote replicator.

Parameters:
  • average_receive_duration (str) – Represents the average duration it takes for the remote replicator to receive an operation.
  • average_apply_duration (str) – Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk.
  • not_received_count (str) – Represents the number of operations not yet received by a remote replicator.
  • received_and_not_applied_count (str) – Represents the number of operations received and not yet applied by a remote replicator.
class azure.servicefabric.models.SecondaryReplicatorStatus(replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build=None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None)[source]

Bases: azure.servicefabric.models.replicator_status.ReplicatorStatus

SecondaryReplicatorStatus.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
  • last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
  • is_in_build (bool) – Value that indicates whether the replica is currently being built.
  • copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
  • last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
  • last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
class azure.servicefabric.models.SecondaryActiveReplicatorStatus(replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build=None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None)[source]

Bases: azure.servicefabric.models.secondary_replicator_status.SecondaryReplicatorStatus

Status of the secondary replicator when it is in active mode and is part of the replica set.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
  • last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
  • is_in_build (bool) – Value that indicates whether the replica is currently being built.
  • copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
  • last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
  • last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
class azure.servicefabric.models.SecondaryIdleReplicatorStatus(replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build=None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None)[source]

Bases: azure.servicefabric.models.secondary_replicator_status.SecondaryReplicatorStatus

Status of the secondary replicator when it is in idle mode and is being built by the primary.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
  • last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
  • is_in_build (bool) – Value that indicates whether the replica is currently being built.
  • copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
  • last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
  • last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
class azure.servicefabric.models.DeployedServiceReplicaDetailInfo(service_name=None, partition_id=None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None)[source]

Bases: msrest.serialization.Model

Information about a Service Fabric service replica deployed on a node.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • partition_id (str) –
  • current_service_operation (str) – Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
  • current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
  • reported_load (list of LoadMetricReportInfo) –
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.LoadMetricReportInfo(name=None, value=None, last_reported_utc=None)[source]

Bases: msrest.serialization.Model

Information about load reported by replica.

Parameters:
  • name (str) – The name of the metric.
  • value (int) – The value of the load for the metric..
  • last_reported_utc (datetime) – The UTC time when the load is reported.
class azure.servicefabric.models.DeployedStatefulServiceReplicaDetailInfo(service_name=None, partition_id=None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None, replica_id=None, current_replicator_operation=None, read_status=None, write_status=None, replicator_status=None, replica_status=None)[source]

Bases: azure.servicefabric.models.deployed_service_replica_detail_info.DeployedServiceReplicaDetailInfo

Information about a stateful replica running in a code package.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • partition_id (str) –
  • current_service_operation (str) – Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
  • current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
  • reported_load (list of LoadMetricReportInfo) –
  • ServiceKind (str) – Polymorphic Discriminator
  • replica_id (str) – Id of the stateful service replica.
  • current_replicator_operation (str) – Possible values include: ‘Invalid’, ‘None’, ‘Open’, ‘ChangeRole’, ‘UpdateEpoch’, ‘Close’, ‘Abort’, ‘OnDataLoss’, ‘WaitForCatchup’, ‘Build’
  • read_status (str) – Possible values include: ‘Invalid’, ‘Granted’, ‘ReconfigurationPending’, ‘NotPrimary’, ‘NoWriteQuorum’
  • write_status (str) – Possible values include: ‘Invalid’, ‘Granted’, ‘ReconfigurationPending’, ‘NotPrimary’, ‘NoWriteQuorum’
  • replicator_status (ReplicatorStatus) –
  • replica_status (KeyValueStoreReplicaStatus) –
class azure.servicefabric.models.KeyValueStoreReplicaStatus(database_row_count_estimate=None, database_logical_size_estimate=None, copy_notification_current_key_filter=None, copy_notification_current_progress=None, status_details=None)[source]

Bases: azure.servicefabric.models.replica_status_base.ReplicaStatusBase

Key value store related information for the replica.

Parameters:
  • Kind (str) – Polymorphic Discriminator
  • database_row_count_estimate (str) – Value indicating the estimated number of rows in the underlying database.
  • database_logical_size_estimate (str) – Value indicating the estimated size of the underlying database.
  • copy_notification_current_key_filter (str) – Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback.
  • copy_notification_current_progress (str) – Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback.
  • status_details (str) – Value indicating the current status details of the replica.
class azure.servicefabric.models.DeployedStatelessServiceInstanceDetailInfo(service_name=None, partition_id=None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None, instance_id=None)[source]

Bases: azure.servicefabric.models.deployed_service_replica_detail_info.DeployedServiceReplicaDetailInfo

Information about a stateless instance running in a code package.

Parameters:
  • service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
  • partition_id (str) –
  • current_service_operation (str) – Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
  • current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
  • reported_load (list of LoadMetricReportInfo) –
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_id (str) – Id of the stateless service instance.
class azure.servicefabric.models.ReplicaStatusBase[source]

Bases: msrest.serialization.Model

Information about the replica.

Parameters:Kind (str) – Polymorphic Discriminator
class azure.servicefabric.models.ServiceUpdateDescription(flags=None, placement_constraints=None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None)[source]

Bases: msrest.serialization.Model

A ServiceUpdateDescription contains all of the information necessary to update a service.

Parameters:
  • flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • ServiceKind (str) – Polymorphic Discriminator
class azure.servicefabric.models.StatefulServiceUpdateDescription(flags=None, placement_constraints=None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, target_replica_set_size=None, min_replica_set_size=None, replica_restart_wait_duration_seconds=None, quorum_loss_wait_duration_seconds=None, stand_by_replica_keep_duration_seconds=None)[source]

Bases: azure.servicefabric.models.service_update_description.ServiceUpdateDescription

Describes an update for a stateful service.

Parameters:
  • flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • ServiceKind (str) – Polymorphic Discriminator
  • target_replica_set_size (int) – The target replica set size as a number.
  • min_replica_set_size (int) – The minimum replica set size as a number.
  • replica_restart_wait_duration_seconds (str) – The duration, in seconds, between when a replica goes down and when a new replica is created.
  • quorum_loss_wait_duration_seconds (str) – The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
  • stand_by_replica_keep_duration_seconds (str) – The definition on how long StandBy replicas should be maintained before being removed.
class azure.servicefabric.models.StatelessServiceUpdateDescription(flags=None, placement_constraints=None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, instance_count=None)[source]

Bases: azure.servicefabric.models.service_update_description.ServiceUpdateDescription

Describes an update for a stateless service.

Parameters:
  • flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
  • correlation_scheme (list of ServiceCorrelationDescription) – The correlation scheme.
  • load_metrics (list of ServiceLoadMetricDescription) – The service load metrics.
  • service_placement_policies (list of ServicePlacementPolicyDescription) – The service placement policies.
  • default_move_cost (str) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • ServiceKind (str) – Polymorphic Discriminator
  • instance_count (int) – The instance count.
class azure.servicefabric.models.FileVersion(version_number=None, epoch_data_loss_number=None)[source]

Bases: msrest.serialization.Model

Information about the version of image store file.

Parameters:
  • version_number (str) – The current iamge store version number for the file is used in image store for checking whether it need to be updated.
  • epoch_data_loss_number (str) – The epoch data loss number of image store file is used to indicate the status of data loss.
class azure.servicefabric.models.FileInfo(file_size=None, file_version=None, modified_date=None, store_relative_path=None)[source]

Bases: msrest.serialization.Model

Information about a image store file.

Parameters:
  • file_size (str) – The size of file in bytes.
  • file_version (FileVersion) –
  • modified_date (datetime) – The date and time when the image store file was last modified.
  • store_relative_path (str) – The file path relative to the image store root path.
class azure.servicefabric.models.FolderInfo(store_relative_path=None, file_count=None)[source]

Bases: msrest.serialization.Model

Information about a image store folder. It inclues how many files this folder contains and its image store relative path.

Parameters:
  • store_relative_path (str) –
  • file_count (str) – The number of files from within the image store folder.
class azure.servicefabric.models.ImageStoreContent(store_files=None, store_folders=None)[source]

Bases: msrest.serialization.Model

Information about the image store content.

Parameters:
  • store_files (list of FileInfo) – The list of image store file info objects represents files found under the given image store relative path.
  • store_folders (list of FolderInfo) – The list of image store folder info objectes represents subfolders found under the given image store relative path.
class azure.servicefabric.models.ImageStoreCopyDescription(remote_source, remote_destination, skip_files=None, check_mark_file=None)[source]

Bases: msrest.serialization.Model

Information about how to copy image store content from one image store relative path to another image store relative path.

Parameters:
  • remote_source (str) – The relative path of source image store content to be copied from.
  • remote_destination (str) – The relative path of destination image store content to be copied to.
  • skip_files (list of str) – The list of the file names to be skipped for copying.
  • check_mark_file (bool) – Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped.
class azure.servicefabric.models.RestartDeployedCodePackageDescription(service_manifest_name=None, service_package_activation_id=None, code_package_name=None, code_package_instance_id=None)[source]

Bases: msrest.serialization.Model

Defines description for restarting a deloyed code package on Service Fabric node. .

Parameters:
  • service_manifest_name (str) – The name of service manifest that specified this code package.
  • service_package_activation_id (str) –
  • code_package_name (str) – The name of the code package.
  • code_package_instance_id (str) –
class azure.servicefabric.models.DeployedServiceTypeInfo(service_type_name=None, service_manifest_name=None, code_package_name=None, status=None, service_package_activation_id=None)[source]

Bases: msrest.serialization.Model

Information about service type deployed on a node, information such as the status of the service type registration on a node.

Parameters:
  • service_type_name (str) – The name of the service type defined in the service manifest.
  • service_manifest_name (str) – The name of the service manifest in which this service type is defined.
  • code_package_name (str) – The name of the code package that registered the service type.
  • status (str) – Possible values include: ‘Invalid’, ‘Disabled’, ‘Enabled’, ‘Registered’
  • service_package_activation_id (str) –
class azure.servicefabric.models.ResolvedServiceEndpoint(kind=None, address=None)[source]

Bases: msrest.serialization.Model

Endpoint of a resolved service partition.

Parameters:
  • kind (str) – Possible values include: ‘Invalid’, ‘Stateless’, ‘StatefulPrimary’, ‘StatefulSecondary’
  • address (str) – The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener.
class azure.servicefabric.models.ResolvedServicePartition(name, partition_information, endpoints, version)[source]

Bases: msrest.serialization.Model

Information about a service partition and its associated endpoints.

Parameters:
  • name (str) –
  • partition_information (PartitionInformation) – A representation of the resolved partition.
  • endpoints (list of ResolvedServiceEndpoint) –
  • version (str) – The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter.
class azure.servicefabric.models.InvokeDataLossResult(error_code=None, selected_partition=None)[source]

Bases: msrest.serialization.Model

Represents information about an operation in a terminal state (Completed or Faulted).

Parameters:
  • error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
  • selected_partition (SelectedPartition) –
class azure.servicefabric.models.SelectedPartition(service_name=None, partition_id=None)[source]

Bases: msrest.serialization.Model

This class returns information about the partition that the user-induced operation acted upon.

Parameters:
  • service_name (str) – The name of the service the partition belongs to.
  • partition_id (str) –
class azure.servicefabric.models.InvokeQuorumLossResult(error_code=None, selected_partition=None)[source]

Bases: msrest.serialization.Model

Represents information about an operation in a terminal state (Completed or Faulted).

Parameters:
  • error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
  • selected_partition (SelectedPartition) –
class azure.servicefabric.models.NodeResult(node_name=None, node_instance_id=None)[source]

Bases: msrest.serialization.Model

Contains information about a node that was targeted by a user-induced operation.

Parameters:
  • node_name (str) – The node name
  • node_instance_id (str) – The node instance id.
class azure.servicefabric.models.NodeTransitionProgress(state=None, node_transition_result=None)[source]

Bases: msrest.serialization.Model

Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted. .

Parameters:
  • state (str) – Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
  • node_transition_result (NodeTransitionResult) –
class azure.servicefabric.models.NodeTransitionResult(error_code=None, node_result=None)[source]

Bases: msrest.serialization.Model

Represents information about an operation in a terminal state (Completed or Faulted).

Parameters:
  • error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
  • node_result (NodeResult) –
class azure.servicefabric.models.OperationStatus(operation_id=None, state=None, type=None)[source]

Bases: msrest.serialization.Model

Contains the OperationId, OperationState, and OperationType for user-induced operations.

Parameters:
  • operation_id (str) –
  • state (str) – Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
  • type (str) – Possible values include: ‘invalid’, ‘partitionDataLoss’, ‘partitionQuorumLoss’, ‘partitionRestart’, ‘nodeTransition’
class azure.servicefabric.models.PartitionDataLossProgress(state=None, invoke_data_loss_result=None)[source]

Bases: msrest.serialization.Model

Information about a partition data loss user-induced operation.

Parameters:
  • state (str) – Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
  • invoke_data_loss_result (InvokeDataLossResult) –
class azure.servicefabric.models.PartitionQuorumLossProgress(state=None, invoke_quorum_loss_result=None)[source]

Bases: msrest.serialization.Model

Information about a partition quorum loss user-induced operation.

Parameters:
  • state (str) – Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
  • invoke_quorum_loss_result (InvokeQuorumLossResult) –
class azure.servicefabric.models.PartitionRestartProgress(state=None, restart_partition_result=None)[source]

Bases: msrest.serialization.Model

Information about a partition restart user-induced operation.

Parameters:
  • state (str) – Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
  • restart_partition_result (RestartPartitionResult) –
class azure.servicefabric.models.RestartPartitionResult(error_code=None, selected_partition=None)[source]

Bases: msrest.serialization.Model

Represents information about an operation in a terminal state (Completed or Faulted).

Parameters:
  • error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
  • selected_partition (SelectedPartition) –
class azure.servicefabric.models.DeployServicePackageToNodeDescription(service_manifest_name, application_type_name, application_type_version, node_name, package_sharing_policy=None)[source]

Bases: msrest.serialization.Model

Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node. .

Parameters:
  • service_manifest_name (str) – The name of service manifest whose packages need to be downloaded.
  • application_type_name (str) –
  • application_type_version (str) –
  • node_name (str) –
  • package_sharing_policy (list of PackageSharingPolicyInfo) –
class azure.servicefabric.models.PackageSharingPolicyInfo(shared_package_name=None, package_sharing_scope=None)[source]

Bases: msrest.serialization.Model

Represents a policy for the package sharing.

Parameters:
  • shared_package_name (str) – The name of code, configuration or data package that should be shared.
  • package_sharing_scope (str) – Possible values include: ‘None’, ‘All’, ‘Code’, ‘Config’, ‘Data’
class azure.servicefabric.models.ResumeApplicationUpgradeDescription(upgrade_domain_name)[source]

Bases: msrest.serialization.Model

Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade.

Parameters:upgrade_domain_name (str) – The name of the upgrade domain in which to resume the upgrade.
class azure.servicefabric.models.ApplicationUpgradeUpdateDescription(name, upgrade_kind='Rolling', application_health_policy=None, update_description=None)[source]

Bases: msrest.serialization.Model

Describes the parameters for updating an ongoing application upgrade.

Parameters:
class azure.servicefabric.models.RollingUpgradeUpdateDescription(rolling_upgrade_mode='UnmonitoredAuto', force_restart=None, replica_set_check_timeout_in_milliseconds=None, failure_action=None, health_check_wait_duration_in_milliseconds=None, health_check_stable_duration_in_milliseconds=None, health_check_retry_timeout_in_milliseconds=None, upgrade_timeout_in_milliseconds=None, upgrade_domain_timeout_in_milliseconds=None)[source]

Bases: msrest.serialization.Model

Describes the parameters for updating a rolling upgrade of application or cluster.

Parameters:
  • rolling_upgrade_mode (str) – Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
  • force_restart (bool) –
  • replica_set_check_timeout_in_milliseconds (long) –
  • failure_action (str) – Possible values include: ‘Invalid’, ‘Rollback’, ‘Manual’
  • health_check_wait_duration_in_milliseconds (str) –
  • health_check_stable_duration_in_milliseconds (str) –
  • health_check_retry_timeout_in_milliseconds (str) –
  • upgrade_timeout_in_milliseconds (str) –
  • upgrade_domain_timeout_in_milliseconds (str) –