azure.mgmt.servicefabric.models module

class azure.mgmt.servicefabric.models.ServiceTypeHealthPolicy(*, max_percent_unhealthy_partitions_per_service: int = 0, max_percent_unhealthy_replicas_per_partition: int = 0, max_percent_unhealthy_services: int = 0, **kwargs)[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.mgmt.servicefabric.models.ServiceTypeHealthPolicyMapItem(*, key: str, value, **kwargs)[source]

Bases: msrest.serialization.Model

Defines an item in ServiceTypeHealthPolicyMap. .

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

Parameters:
  • key (str) – Required. The key of the service type health policy map item. This is the name of the service type.
  • value (ServiceTypeHealthPolicy) – Required.
class azure.mgmt.servicefabric.models.ApplicationHealthPolicy(*, consider_warning_as_error: bool = False, max_percent_unhealthy_deployed_applications: int = 0, default_service_type_health_policy=None, service_type_health_policy_map=None, **kwargs)[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) –
  • service_type_health_policy_map (list[ServiceTypeHealthPolicyMapItem]) –
class azure.mgmt.servicefabric.models.ApplicationMetricDescription(*, name: str = None, maximum_capacity: int = None, reservation_capacity: int = None, total_application_capacity: int = None, **kwargs)[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.mgmt.servicefabric.models.ApplicationParameter(*, key: str, value: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:
  • key (str) – Required. The name of the parameter.
  • value (str) – Required. The value of the parameter.
class azure.mgmt.servicefabric.models.ServiceCorrelationDescription(*, scheme, service_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Creates a particular correlation between services.

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

Parameters:
  • scheme (str or enum) – Required. Possible values include: ‘Invalid’, ‘Affinity’, ‘AlignedAffinity’, ‘NonAlignedAffinity’
  • service_name (str) – Required.
class azure.mgmt.servicefabric.models.ServiceLoadMetricDescription(*, name: str, weight=None, primary_default_load: int = None, secondary_default_load: int = None, default_load: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies a metric to load balance a service during runtime.

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

Parameters:
  • name (str) – Required. 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 or enum) – 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.mgmt.servicefabric.models.ServicePlacementPolicyDescription(**kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:type (str) – Required. Constant filled by server.
class azure.mgmt.servicefabric.models.PartitionSchemeDescription(**kwargs)[source]

Bases: msrest.serialization.Model

Describes how the service is partitioned.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: NamedPartitionSchemeDescription, SingletonPartitionSchemeDescription, UniformInt64RangePartitionSchemeDescription

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

Parameters:partition_scheme (str) – Required. Constant filled by server.
class azure.mgmt.servicefabric.models.NamedPartitionSchemeDescription(*, count: int, names, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.partition_scheme_description_py3.PartitionSchemeDescription

Describes the named partition scheme of the service.

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

Parameters:
  • partition_scheme (str) – Required. Constant filled by server.
  • count (int) – Required. The number of partitions.
  • names (list[str]) – Required. Array of size specified by the ‘Count’ parameter, for the names of the partitions.
class azure.mgmt.servicefabric.models.SingletonPartitionSchemeDescription(**kwargs)[source]

Bases: azure.mgmt.servicefabric.models.partition_scheme_description_py3.PartitionSchemeDescription

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

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

Parameters:partition_scheme (str) – Required. Constant filled by server.
class azure.mgmt.servicefabric.models.UniformInt64RangePartitionSchemeDescription(*, count: int, low_key: str, high_key: str, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.partition_scheme_description_py3.PartitionSchemeDescription

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

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

Parameters:
  • partition_scheme (str) – Required. Constant filled by server.
  • count (int) – Required. The number of partitions.
  • low_key (str) – Required. String indicating the lower bound of the partition key range that should be split between the partition ‘Count’
  • high_key (str) – Required. String indicating the upper bound of the partition key range that should be split between the partition ‘Count’
class azure.mgmt.servicefabric.models.ApplicationTypeResource(*, location: str, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

The application type name resource.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
  • provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
Parameters:

location (str) – Required. Resource location.

class azure.mgmt.servicefabric.models.ApplicationTypeResourceList(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The list of application type names.

Parameters:value (list[ApplicationTypeResource]) –
class azure.mgmt.servicefabric.models.VersionResource(*, location: str, app_package_url: str, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

A version resource for the specified application type name.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
  • provisioning_state (str) – The current deployment or provisioning state, which only appears in the response
  • default_parameter_list (list[ApplicationParameter]) –
Parameters:
  • location (str) – Required. Resource location.
  • app_package_url (str) – Required. The URL to the application package
class azure.mgmt.servicefabric.models.VersionResourceList(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The list of version resources for the specified application type name.

Parameters:value (list[VersionResource]) –
class azure.mgmt.servicefabric.models.ApplicationResource(*, location: str, type_version: str = None, parameters=None, upgrade_policy=None, minimum_nodes: int = None, maximum_nodes: int = 0, remove_application_capacity: bool = None, metrics=None, type_name: str = None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

The application resource.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
  • provisioning_state (str) – The current deployment or provisioning state, which only appears in the response
Parameters:
  • location (str) – Required. Resource location.
  • type_version (str) –
  • parameters (list[ApplicationParameter]) –
  • upgrade_policy (ApplicationUpgradePolicy) –
  • 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 .
  • remove_application_capacity (bool) – The version of the application type
  • metrics (list[ApplicationMetricDescription]) –
  • type_name (str) –
class azure.mgmt.servicefabric.models.ApplicationResourceList(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The list of application resources.

Parameters:value (list[ApplicationResource]) –
class azure.mgmt.servicefabric.models.RollingUpgradeMonitoringPolicy(*, health_check_wait_duration: str = None, health_check_stable_duration: str = None, health_check_retry_timeout: str = None, upgrade_timeout: str = None, upgrade_domain_timeout: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The policy used for monitoring the application upgrade.

Parameters:
  • health_check_wait_duration (str) –
  • health_check_stable_duration (str) –
  • health_check_retry_timeout (str) –
  • upgrade_timeout (str) –
  • upgrade_domain_timeout (str) –
class azure.mgmt.servicefabric.models.ApplicationUpgradePolicy(*, upgrade_replica_set_check_timeout: int = None, force_restart: bool = None, rolling_upgrade_monitoring_policy=None, application_health_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the policy for a monitored application upgrade.

Parameters:
class azure.mgmt.servicefabric.models.ApplicationResourceUpdate(*, location: str, type_version: str = None, parameters=None, upgrade_policy=None, minimum_nodes: int = None, maximum_nodes: int = 0, remove_application_capacity: bool = None, metrics=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

The application resource for patch operations.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
Parameters:
  • location (str) – Required. Resource location.
  • type_version (str) –
  • parameters (list[ApplicationParameter]) –
  • upgrade_policy (ApplicationUpgradePolicy) –
  • 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 .
  • remove_application_capacity (bool) – The version of the application type
  • metrics (list[ApplicationMetricDescription]) –
class azure.mgmt.servicefabric.models.ServiceProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str = None, partition_description=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_properties_base_py3.ServicePropertiesBase

The service resource properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatelessServiceProperties, StatefulServiceProperties

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

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_type_name (str) – The name of the service type
  • partition_description (PartitionSchemeDescription) –
  • service_kind (str) – Required. Constant filled by server.
Variables:

provisioning_state (str) – The current deployment or provisioning state, which only appears in the response

class azure.mgmt.servicefabric.models.ServiceResource(*, location: str, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str = None, partition_description=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

The service resource.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
  • provisioning_state (str) – The current deployment or provisioning state, which only appears in the response
Parameters:
  • location (str) – Required. Resource location.
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_type_name (str) – The name of the service type
  • partition_description (PartitionSchemeDescription) –
class azure.mgmt.servicefabric.models.ServiceResourceList(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The list of service resources.

Parameters:value (list[ServiceResource]) –
class azure.mgmt.servicefabric.models.ServicePropertiesBase(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)[source]

Bases: msrest.serialization.Model

The common service resource properties.

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
class azure.mgmt.servicefabric.models.ServiceUpdateProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_properties_base_py3.ServicePropertiesBase

The service resource properties for patch operations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatelessServiceUpdateProperties, StatefulServiceUpdateProperties

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_kind (str) – Required. Constant filled by server.
class azure.mgmt.servicefabric.models.ServiceResourceUpdate(*, location: str, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.proxy_resource_py3.ProxyResource

The service resource for patch operations.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
Parameters:
  • location (str) – Required. Resource location.
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
class azure.mgmt.servicefabric.models.StatelessServiceProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str = None, partition_description=None, instance_count: int = None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_properties_py3.ServiceProperties

The properties of a stateless service resource.

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

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_type_name (str) – The name of the service type
  • partition_description (PartitionSchemeDescription) –
  • service_kind (str) – Required. Constant filled by server.
  • instance_count (int) – The instance count.
Variables:

provisioning_state (str) – The current deployment or provisioning state, which only appears in the response

class azure.mgmt.servicefabric.models.StatelessServiceUpdateProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, instance_count: int = None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_update_properties_py3.ServiceUpdateProperties

The properties of a stateless service resource for patch operations.

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_kind (str) – Required. Constant filled by server.
  • instance_count (int) – The instance count.
class azure.mgmt.servicefabric.models.StatefulServiceProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str = None, partition_description=None, has_persisted_state: bool = None, target_replica_set_size: int = None, min_replica_set_size: int = None, replica_restart_wait_duration=None, quorum_loss_wait_duration=None, stand_by_replica_keep_duration=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_properties_py3.ServiceProperties

The properties of a stateful service resource.

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

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_type_name (str) – The name of the service type
  • partition_description (PartitionSchemeDescription) –
  • service_kind (str) – Required. Constant filled by server.
  • 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.
  • 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 (datetime) – The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s).
  • quorum_loss_wait_duration (datetime) – The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s).
  • stand_by_replica_keep_duration (datetime) – The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s).
Variables:

provisioning_state (str) – The current deployment or provisioning state, which only appears in the response

class azure.mgmt.servicefabric.models.StatefulServiceUpdateProperties(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, target_replica_set_size: int = None, min_replica_set_size: int = None, replica_restart_wait_duration=None, quorum_loss_wait_duration=None, stand_by_replica_keep_duration=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.service_update_properties_py3.ServiceUpdateProperties

The properties of a stateful service resource for patch operations.

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

Parameters:
  • 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[ServiceCorrelationDescription]) –
  • service_load_metrics (list[ServiceLoadMetricDescription]) –
  • service_placement_policies (list[ServicePlacementPolicyDescription]) –
  • default_move_cost (str or enum) – Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  • service_kind (str) – Required. Constant filled by server.
  • 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 (datetime) – The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s).
  • quorum_loss_wait_duration (datetime) – The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s).
  • stand_by_replica_keep_duration (datetime) – The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s).
class azure.mgmt.servicefabric.models.AvailableOperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Operation supported by Service Fabric resource provider.

Parameters:
  • provider (str) – The name of the provider.
  • resource (str) – The resource on which the operation is performed
  • operation (str) – The operation that can be performed.
  • description (str) – Operation description
class azure.mgmt.servicefabric.models.AzureActiveDirectory(*, tenant_id: str = None, cluster_application: str = None, client_application: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The settings to enable AAD authentication on the cluster.

Parameters:
  • tenant_id (str) – Azure active directory tenant id.
  • cluster_application (str) – Azure active directory cluster application id.
  • client_application (str) – Azure active directory client application id.
class azure.mgmt.servicefabric.models.CertificateDescription(*, thumbprint: str, thumbprint_secondary: str = None, x509_store_name=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the certificate details.

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

Parameters:
  • thumbprint (str) – Required. Thumbprint of the primary certificate.
  • thumbprint_secondary (str) – Thumbprint of the secondary certificate.
  • x509_store_name (str or enum) – The local certificate store location. Possible values include: ‘AddressBook’, ‘AuthRoot’, ‘CertificateAuthority’, ‘Disallowed’, ‘My’, ‘Root’, ‘TrustedPeople’, ‘TrustedPublisher’
class azure.mgmt.servicefabric.models.ClientCertificateCommonName(*, is_admin: bool, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the client certificate details using common name.

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

Parameters:
  • is_admin (bool) – Required. Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
  • certificate_common_name (str) – Required. The common name of the client certificate.
  • certificate_issuer_thumbprint (str) – Required. The issuer thumbprint of the client certificate.
class azure.mgmt.servicefabric.models.ClientCertificateThumbprint(*, is_admin: bool, certificate_thumbprint: str, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the client certificate details using thumbprint.

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

Parameters:
  • is_admin (bool) – Required. Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
  • certificate_thumbprint (str) – Required. The thumbprint of the client certificate.
class azure.mgmt.servicefabric.models.ClusterVersionDetails(*, code_version: str = None, support_expiry_utc: str = None, environment=None, **kwargs)[source]

Bases: msrest.serialization.Model

The detail of the Service Fabric runtime version result.

Parameters:
  • code_version (str) – The Service Fabric runtime version of the cluster.
  • support_expiry_utc (str) – The date of expiry of support of the version.
  • environment (str or enum) – Indicates if this version is for Windows or Linux operating system. Possible values include: ‘Windows’, ‘Linux’
class azure.mgmt.servicefabric.models.SettingsParameterDescription(*, name: str, value: str, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a parameter in fabric settings of the cluster.

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

Parameters:
  • name (str) – Required. The parameter name of fabric setting.
  • value (str) – Required. The parameter value of fabric setting.
class azure.mgmt.servicefabric.models.SettingsSectionDescription(*, name: str, parameters, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a section in the fabric settings of the cluster.

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

Parameters:
  • name (str) – Required. The section name of the fabric settings.
  • parameters (list[SettingsParameterDescription]) – Required. The collection of parameters in the section.
class azure.mgmt.servicefabric.models.EndpointRangeDescription(*, start_port: int, end_port: int, **kwargs)[source]

Bases: msrest.serialization.Model

Port range details.

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

Parameters:
  • start_port (int) – Required. Starting port of a range of ports
  • end_port (int) – Required. End port of a range of ports
class azure.mgmt.servicefabric.models.NodeTypeDescription(*, name: str, client_connection_endpoint_port: int, http_gateway_endpoint_port: int, is_primary: bool, vm_instance_count: int, placement_properties=None, capacities=None, durability_level=None, application_ports=None, ephemeral_ports=None, reverse_proxy_endpoint_port: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.

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

Parameters:
  • name (str) – Required. The name of the node type.
  • placement_properties (dict[str, str]) – The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.
  • capacities (dict[str, str]) – The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.
  • client_connection_endpoint_port (int) – Required. The TCP cluster management endpoint port.
  • http_gateway_endpoint_port (int) – Required. The HTTP cluster management endpoint port.
  • durability_level (str or enum) – Possible values include: ‘Bronze’, ‘Silver’, ‘Gold’
  • application_ports (EndpointRangeDescription) – The range of ports from which cluster assigned port to Service Fabric applications.
  • ephemeral_ports (EndpointRangeDescription) – The range of empheral ports that nodes in this node type should be configured with.
  • is_primary (bool) – Required. The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.
  • vm_instance_count (int) – Required. The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.
  • reverse_proxy_endpoint_port (int) – The endpoint used by reverse proxy.
class azure.mgmt.servicefabric.models.DiagnosticsStorageAccountConfig(*, storage_account_name: str, protected_account_key_name: str, blob_endpoint: str, queue_endpoint: str, table_endpoint: str, **kwargs)[source]

Bases: msrest.serialization.Model

The storage account information for storing Service Fabric diagnostic logs.

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

Parameters:
  • storage_account_name (str) – Required. The Azure storage account name.
  • protected_account_key_name (str) – Required. The protected diagnostics storage key name.
  • blob_endpoint (str) – Required. The blob endpoint of the azure storage account.
  • queue_endpoint (str) – Required. The queue endpoint of the azure storage account.
  • table_endpoint (str) – Required. The table endpoint of the azure storage account.
class azure.mgmt.servicefabric.models.ClusterHealthPolicy(*, max_percent_unhealthy_nodes: int = None, max_percent_unhealthy_applications: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • 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.
  • 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.
class azure.mgmt.servicefabric.models.ClusterUpgradeDeltaHealthPolicy(*, max_percent_delta_unhealthy_nodes: int, max_percent_upgrade_domain_delta_unhealthy_nodes: int, max_percent_delta_unhealthy_applications: int, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the delta health policies for the cluster upgrade.

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

Parameters:
  • max_percent_delta_unhealthy_nodes (int) – Required. 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.
  • max_percent_upgrade_domain_delta_unhealthy_nodes (int) – Required. 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.
  • max_percent_delta_unhealthy_applications (int) – Required. The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications 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. System services are not included in this.
class azure.mgmt.servicefabric.models.ClusterUpgradePolicy(*, upgrade_replica_set_check_timeout: str, health_check_wait_duration: str, health_check_stable_duration: str, health_check_retry_timeout: str, upgrade_timeout: str, upgrade_domain_timeout: str, health_policy, force_restart: bool = None, delta_health_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the policy used when upgrading the cluster.

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

Parameters:
  • force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
  • upgrade_replica_set_check_timeout (str) – Required. The maximum amount of time to block processing of an upgrade domain and revent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • health_check_wait_duration (str) – Required. The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • health_check_stable_duration (str) – Required. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • health_check_retry_timeout (str) – Required. The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • upgrade_timeout (str) – Required. The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • upgrade_domain_timeout (str) – Required. The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
  • health_policy (ClusterHealthPolicy) – Required. The cluster health policy used when upgrading the cluster.
  • delta_health_policy (ClusterUpgradeDeltaHealthPolicy) – The delta health policy used when upgrading the cluster.
class azure.mgmt.servicefabric.models.Cluster(*, location: str, management_endpoint: str, node_types, tags=None, available_cluster_versions=None, cluster_state=None, cluster_code_version: str = None, certificate=None, reliability_level=None, upgrade_mode=None, client_certificate_thumbprints=None, client_certificate_common_names=None, fabric_settings=None, reverse_proxy_certificate=None, azure_active_directory=None, vm_image: str = None, diagnostics_storage_account_config=None, upgrade_description=None, add_on_features=None, **kwargs)[source]

Bases: azure.mgmt.servicefabric.models.resource_py3.Resource

The cluster resource .

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
  • cluster_id (str) – A service generated unique identifier for the cluster resource.
  • cluster_endpoint (str) – The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.
  • provisioning_state (str or ProvisioningState) – The provisioning state of the cluster resource. Possible values include: ‘Updating’, ‘Succeeded’, ‘Failed’, ‘Canceled’
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • available_cluster_versions (list[ClusterVersionDetails]) – The Service Fabric runtime versions available for this cluster.
  • cluster_state (str or enum) – Possible values include: ‘WaitingForNodes’, ‘Deploying’, ‘BaselineUpgrade’, ‘UpdatingUserConfiguration’, ‘UpdatingUserCertificate’, ‘UpdatingInfrastructure’, ‘EnforcingClusterVersion’, ‘UpgradeServiceUnreachable’, ‘AutoScale’, ‘Ready’
  • cluster_code_version (str) – The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to ‘Manual’. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use availableClusterVersions.
  • certificate (CertificateDescription) – The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.
  • reliability_level (str or enum) – Possible values include: ‘None’, ‘Bronze’, ‘Silver’, ‘Gold’, ‘Platinum’
  • upgrade_mode (str or enum) – Possible values include: ‘Automatic’, ‘Manual’
  • client_certificate_thumbprints (list[ClientCertificateThumbprint]) – The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
  • client_certificate_common_names (list[ClientCertificateCommonName]) – The list of client certificates referenced by common name that are allowed to manage the cluster.
  • fabric_settings (list[SettingsSectionDescription]) – The list of custom fabric settings to configure the cluster.
  • reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
  • management_endpoint (str) – Required. The http management endpoint of the cluster.
  • node_types (list[NodeTypeDescription]) – Required. The list of node types in the cluster.
  • azure_active_directory (AzureActiveDirectory) – The AAD authentication settings of the cluster.
  • vm_image (str) – The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.
  • diagnostics_storage_account_config (DiagnosticsStorageAccountConfig) – The storage account information for storing Service Fabric diagnostic logs.
  • upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
  • add_on_features (list[str]) – The list of add-on features to enable in the cluster.
class azure.mgmt.servicefabric.models.ClusterCodeVersionsResult(*, id: str = None, name: str = None, type: str = None, code_version: str = None, support_expiry_utc: str = None, environment=None, **kwargs)[source]

Bases: msrest.serialization.Model

The result of the ServiceFabric runtime versions.

Parameters:
  • id (str) – The identification of the result
  • name (str) – The name of the result
  • type (str) – The result resource type
  • code_version (str) – The Service Fabric runtime version of the cluster.
  • support_expiry_utc (str) – The date of expiry of support of the version.
  • environment (str or enum) – Indicates if this version is for Windows or Linux operating system. Possible values include: ‘Windows’, ‘Linux’
class azure.mgmt.servicefabric.models.ClusterCodeVersionsListResult(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The list results of the ServiceFabric runtime versions.

Parameters:
class azure.mgmt.servicefabric.models.ClusterListResult(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Cluster list results.

Parameters:
  • value (list[Cluster]) –
  • next_link (str) – The URL to use for getting the next set of results.
class azure.mgmt.servicefabric.models.ClusterUpdateParameters(*, reliability_level=None, upgrade_mode=None, cluster_code_version: str = None, certificate=None, client_certificate_thumbprints=None, client_certificate_common_names=None, fabric_settings=None, reverse_proxy_certificate=None, node_types=None, upgrade_description=None, add_on_features=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Cluster update request.

Parameters:
  • reliability_level (str or enum) – The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity). Possible values include: ‘Bronze’, ‘Silver’, ‘Gold’
  • upgrade_mode (str or enum) – The upgrade mode of the cluster. This indicates if the cluster should be automatically upgraded when new Service Fabric runtime version is available. Possible values include: ‘Automatic’, ‘Manual’
  • cluster_code_version (str) – The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to ‘Manual’. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use availableClusterVersions.
  • certificate (CertificateDescription) – The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.
  • client_certificate_thumbprints (list[ClientCertificateThumbprint]) – The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.
  • client_certificate_common_names (list[ClientCertificateCommonName]) – The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.
  • fabric_settings (list[SettingsSectionDescription]) – The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
  • reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
  • node_types (list[NodeTypeDescription]) – The list of node types in the cluster. This will overwrite the existing list.
  • upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
  • add_on_features (list[str]) – The list of add-on features to enable in the cluster.
  • tags (dict[str, str]) – Cluster update parameters
class azure.mgmt.servicefabric.models.ErrorModel(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The error details.

Parameters:
  • code (str) – The error code.
  • message (str) – The error message.
exception azure.mgmt.servicefabric.models.ErrorModelException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorModel’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.mgmt.servicefabric.models.OperationResult(*, name: str = None, display=None, origin: str = None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Available operation list result.

Parameters:
  • name (str) – The name of the operation.
  • display (AvailableOperationDisplay) – The object that represents the operation.
  • origin (str) – Origin result
  • next_link (str) – The URL to use for getting the next set of results.
class azure.mgmt.servicefabric.models.ProxyResource(*, location: str, **kwargs)[source]

Bases: msrest.serialization.Model

The resource model definition for proxy-only resource.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
Parameters:

location (str) – Required. Resource location.

class azure.mgmt.servicefabric.models.Resource(*, location: str, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The resource model definition.

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

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

Variables:
  • id (str) – Azure resource ID.
  • name (str) – Azure resource name.
  • type (str) – Azure resource type.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
class azure.mgmt.servicefabric.models.ServiceTypeDeltaHealthPolicy(*, max_percent_delta_unhealthy_services: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Service health policy .

Parameters:max_percent_delta_unhealthy_services (int) – Maximum percentage of unhealthy services in cluster
class azure.mgmt.servicefabric.models.OperationResultPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of OperationResult object

class azure.mgmt.servicefabric.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'