# azure.mgmt.servicefabric.models module

exception `azure.mgmt.servicefabric.models.``ErrorModelException`(deserialize, response, *args)

  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.``ApplicationDeltaHealthPolicy`(*, default_service_type_delta_health_policy=None, service_type_delta_health_policies=None, **kwargs)

  Bases: `msrest.serialization.Model`

  Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster. .

  Parameters:

  - default_service_type_delta_health_policy (ServiceTypeDeltaHealthPolicy) – The delta health policy used by default to evaluate the health of a service type when upgrading the cluster.
  - service_type_delta_health_policies (dict[str, ServiceTypeDeltaHealthPolicy]) – The map with service type delta health policy per service type name. The map is empty by default.

class `azure.mgmt.servicefabric.models.``ApplicationHealthPolicy`(*, default_service_type_health_policy=None, service_type_health_policies=None, **kwargs)

  Bases: `msrest.serialization.Model`

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

  Parameters:

  - default_service_type_health_policy (ServiceTypeHealthPolicy) – The health policy used by default to evaluate the health of a service type.
  - service_type_health_policies (dict[str, ServiceTypeHealthPolicy]) – The map with service type health policy per service type name. The map is empty by default.

class `azure.mgmt.servicefabric.models.``ApplicationMetricDescription`(*, name: str = None, maximum_capacity: int = None, reservation_capacity: int = None, total_application_capacity: int = None, **kwargs)

  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.``ApplicationResource`(*, location: str = None, tags=None, 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)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  The application resource.

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

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.
  - provisioning_state (str) – The current deployment or provisioning state, which only appears in the response

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.
  - type_version (str) – The version of the application type as defined in the application manifest.
  - parameters (dict[str, str]) – List of application parameters with overridden values from their default values specified in the application manifest.
  - upgrade_policy (ApplicationUpgradePolicy) – Describes the policy for a monitored application upgrade.
  - 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) – Remove the current application capacity settings.
  - metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
  - type_name (str) – The application type name as defined in the application manifest.

class `azure.mgmt.servicefabric.models.``ApplicationResourceList`(*, value=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The list of application resources.

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

  Parameters: | value (list[ApplicationResource]) –
  Variables: | next_link (str) – URL to get the next set of application list results if there are any.

class `azure.mgmt.servicefabric.models.``ApplicationResourceUpdate`(*, location: str = None, tags=None, 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)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  The application resource for patch operations.

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

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.
  - type_version (str) – The version of the application type as defined in the application manifest.
  - parameters (dict[str, str]) – List of application parameters with overridden values from their default values specified in the application manifest.
  - upgrade_policy (ApplicationUpgradePolicy) – Describes the policy for a monitored application upgrade.
  - 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) – Remove the current application capacity settings.
  - metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.

class `azure.mgmt.servicefabric.models.``ApplicationTypeResource`(*, location: str = None, tags=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  The application type name resource.

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

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.
  - provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.

class `azure.mgmt.servicefabric.models.``ApplicationTypeResourceList`(*, value=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The list of application type names.

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

  Parameters: | value (list[ApplicationTypeResource]) –
  Variables: | next_link (str) – URL to get the next set of application type list results if there are any.

class `azure.mgmt.servicefabric.models.``ApplicationTypeVersionResource`(*, app_package_url: str, location: str = None, tags=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  An application type version resource for the specified 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 identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.
  - provisioning_state (str) – The current deployment or provisioning state, which only appears in the response
  - default_parameter_list (dict[str, str]) – List of application type parameters that can be overridden when creating or updating the application.

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.
  - app_package_url (str) – Required. The URL to the application package

class `azure.mgmt.servicefabric.models.``ApplicationTypeVersionResourceList`(*, value=None, **kwargs)

  Bases: `msrest.serialization.Model`

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

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

  Parameters: | value (list[ApplicationTypeVersionResource]) –
  Variables: | next_link (str) – URL to get the next set of application type version list results if there are any.

class `azure.mgmt.servicefabric.models.``ApplicationUpgradePolicy`(*, upgrade_replica_set_check_timeout: str = None, force_restart: bool = None, rolling_upgrade_monitoring_policy=None, application_health_policy=None, **kwargs)

  Bases: `msrest.serialization.Model`

  Describes the policy for a monitored application upgrade.

  Parameters:

  - upgrade_replica_set_check_timeout (str) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
  - force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
  - rolling_upgrade_monitoring_policy (ArmRollingUpgradeMonitoringPolicy) – The policy used for monitoring the application upgrade
  - application_health_policy (ArmApplicationHealthPolicy) – Defines a health policy used to evaluate the health of an application or one of its children entities.

class `azure.mgmt.servicefabric.models.``ArmApplicationHealthPolicy`(*, 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)

  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 (ArmServiceTypeHealthPolicy) – The health policy used by default to evaluate the health of a service type.
  - service_type_health_policy_map (dict[str, ArmServiceTypeHealthPolicy]) – The map with service type health policy per service type name. The map is empty by default.

class `azure.mgmt.servicefabric.models.``ArmRollingUpgradeMonitoringPolicy`(*, failure_action=None, 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)

  Bases: `msrest.serialization.Model`

  The policy used for monitoring the application upgrade.

  Parameters:

  - failure_action (str or ArmUpgradeFailureAction) – The activation Mode of the service package. Possible values include: ‘Rollback’, ‘Manual’
  - health_check_wait_duration (str) – The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
  - health_check_stable_duration (str) – The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
  - health_check_retry_timeout (str) – The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
  - upgrade_timeout (str) – The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
  - upgrade_domain_timeout (str) – The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

class `azure.mgmt.servicefabric.models.``ArmServiceTypeHealthPolicy`(*, max_percent_unhealthy_services: int = 0, max_percent_unhealthy_partitions_per_service: int = 0, max_percent_unhealthy_replicas_per_partition: int = 0, **kwargs)

  Bases: `msrest.serialization.Model`

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

  Parameters:

  - max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error. . Default value: 0 .
  - max_percent_unhealthy_partitions_per_service (int) – The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. . Default value: 0 .
  - max_percent_unhealthy_replicas_per_partition (int) – The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. . Default value: 0 .

class `azure.mgmt.servicefabric.models.``AvailableOperationDisplay`(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)

  Bases: `msrest.serialization.Model`

  Operation supported by the 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)

  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)

  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)

  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)

  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.``Cluster`(*, location: str, management_endpoint: str, node_types, tags=None, add_on_features=None, azure_active_directory=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version: str = None, diagnostics_storage_account_config=None, event_store_service_enabled: bool = None, fabric_settings=None, reliability_level=None, reverse_proxy_certificate=None, reverse_proxy_certificate_common_names=None, upgrade_description=None, upgrade_mode=None, vm_image: str = None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_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 identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.
  - available_cluster_versions (list[ClusterVersionDetails]) – The Service Fabric runtime versions available for this cluster.
  - cluster_endpoint (str) – The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.
  - cluster_id (str) – A service generated unique identifier for the cluster resource.
  - cluster_state (str or enum) – The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the upgradeMode is set to ‘Automatic’. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. . Possible values include: ‘WaitingForNodes’, ‘Deploying’, ‘BaselineUpgrade’, ‘UpdatingUserConfiguration’, ‘UpdatingUserCertificate’, ‘UpdatingInfrastructure’, ‘EnforcingClusterVersion’, ‘UpgradeServiceUnreachable’, ‘AutoScale’, ‘Ready’
  - provisioning_state (str or ProvisioningState) – The provisioning state of the cluster resource. Possible values include: ‘Updating’, ‘Succeeded’, ‘Failed’, ‘Canceled’

  Parameters:

  - location (str) – Required. Azure resource location.
  - tags (dict[str, str]) – Azure resource tags.
  - add_on_features (list[str]) – The list of add-on features to enable in the cluster.
  - azure_active_directory (AzureActiveDirectory) – The AAD authentication settings of the cluster.
  - 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.
  - certificate_common_names (ServerCertificateCommonNames) – Describes a list of server certificates referenced by common name that are used to secure the cluster.
  - client_certificate_common_names (list[ClientCertificateCommonName]) – The list of client certificates referenced by common name that are allowed to manage the cluster.
  - client_certificate_thumbprints (list[ClientCertificateThumbprint]) – The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
  - 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.
  - diagnostics_storage_account_config (DiagnosticsStorageAccountConfig) – The storage account information for storing Service Fabric diagnostic logs.
  - event_store_service_enabled (bool) – Indicates if the event store service is enabled.
  - fabric_settings (list[SettingsSectionDescription]) – The list of custom fabric settings to configure the cluster.
  - management_endpoint (str) – Required. The http management endpoint of the cluster.
  - node_types (list[NodeTypeDescription]) – Required. The list of node types in the cluster.
  - 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). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. . Possible values include: ‘None’, ‘Bronze’, ‘Silver’, ‘Gold’, ‘Platinum’
  - reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
  - reverse_proxy_certificate_common_names (ServerCertificateCommonNames) – Describes a list of server certificates referenced by common name that are used to secure the cluster.
  - upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
  - upgrade_mode (str or enum) – The upgrade mode of the cluster when new Service Fabric runtime version is available. - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the clusterCodeVersion property in the cluster resource. . Possible values include: ‘Automatic’, ‘Manual’
  - vm_image (str) – The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.

class `azure.mgmt.servicefabric.models.``ClusterCodeVersionsListResult`(*, value=None, next_link: str = None, **kwargs)

  Bases: `msrest.serialization.Model`

  The list results of the Service Fabric runtime versions.

  Parameters:

  - value (list[ClusterCodeVersionsResult]) –
  - next_link (str) – The URL to use for getting the next set of results.

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)

  Bases: `msrest.serialization.Model`

  The result of the Service Fabric 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.``ClusterHealthPolicy`(*, max_percent_unhealthy_nodes: int = 0, max_percent_unhealthy_applications: int = 0, application_health_policies=None, **kwargs)

  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. 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_health_policies (dict[str, ApplicationHealthPolicy]) – Defines the application health policy map used to evaluate the health of an application or one of its children entities.

class `azure.mgmt.servicefabric.models.``ClusterListResult`(*, value=None, next_link: str = None, **kwargs)

  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`(*, add_on_features=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version: str = None, event_store_service_enabled: bool = None, fabric_settings=None, node_types=None, reliability_level=None, reverse_proxy_certificate=None, upgrade_description=None, upgrade_mode=None, tags=None, **kwargs)

  Bases: `msrest.serialization.Model`

  Cluster update request.

  Parameters:

  - add_on_features (list[str]) – The list of add-on features to enable in the cluster.
  - 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.
  - certificate_common_names (ServerCertificateCommonNames) – Describes a list of server certificates referenced by common name that are used to secure the cluster.
  - 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.
  - 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.
  - 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.
  - event_store_service_enabled (bool) – Indicates if the event store service is enabled.
  - fabric_settings (list[SettingsSectionDescription]) – The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
  - node_types (list[NodeTypeDescription]) – The list of node types in the cluster. This will overwrite the existing list.
  - 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). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. . Possible values include: ‘None’, ‘Bronze’, ‘Silver’, ‘Gold’, ‘Platinum’
  - reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
  - upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
  - upgrade_mode (str or enum) – The upgrade mode of the cluster when new Service Fabric runtime version is available. - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the clusterCodeVersion property in the cluster resource. . Possible values include: ‘Automatic’, ‘Manual’
  - tags (dict[str, str]) – Cluster update parameters

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, application_delta_health_policies=None, **kwargs)

  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.
  - application_delta_health_policies (dict[str, ApplicationDeltaHealthPolicy]) – Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster.

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)

  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 prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. 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 cluster delta health policy used when upgrading the cluster.

class `azure.mgmt.servicefabric.models.``ClusterVersionDetails`(*, code_version: str = None, support_expiry_utc: str = None, environment=None, **kwargs)

  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.``DiagnosticsStorageAccountConfig`(*, storage_account_name: str, protected_account_key_name: str, blob_endpoint: str, queue_endpoint: str, table_endpoint: str, **kwargs)

  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.``EndpointRangeDescription`(*, start_port: int, end_port: int, **kwargs)

  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.``ErrorModel`(*, error=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The structure of the error.

  Parameters: | error (ErrorModelError) – The error details.

class `azure.mgmt.servicefabric.models.``ErrorModelError`(*, code: str = None, message: str = None, **kwargs)

  Bases: `msrest.serialization.Model`

  The error details.

  Parameters:

  - code (str) – The error code.
  - message (str) – The error message.

class `azure.mgmt.servicefabric.models.``NamedPartitionSchemeDescription`(*, count: int, names, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_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.``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)

  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) – The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. . 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 ephemeral 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.``OperationResult`(*, name: str = None, display=None, origin: str = None, next_link: str = None, **kwargs)

  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.``PartitionSchemeDescription`(**kwargs)

  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.``ProxyResource`(*, location: str = None, tags=None, **kwargs)

  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.

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.

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

  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 identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.

  Parameters:

  - location (str) – Required. Azure resource location.
  - tags (dict[str, str]) – Azure resource tags.

class `azure.mgmt.servicefabric.models.``ServerCertificateCommonName`(*, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs)

  Bases: `msrest.serialization.Model`

  Describes the server certificate details using common name.

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

  Parameters:

  - certificate_common_name (str) – Required. The common name of the server certificate.
  - certificate_issuer_thumbprint (str) – Required. The issuer thumbprint of the server certificate.

class `azure.mgmt.servicefabric.models.``ServerCertificateCommonNames`(*, common_names=None, x509_store_name=None, **kwargs)

  Bases: `msrest.serialization.Model`

  Describes a list of server certificates referenced by common name that are used to secure the cluster.

  Parameters:

  - common_names (list[ServerCertificateCommonName]) – The list of server certificates referenced by common name that are used to secure the cluster.
  - 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.``ServiceCorrelationDescription`(*, scheme, service_name: str, **kwargs)

  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 ServiceCorrelationScheme) – Required. 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) – Required. The name of the service that the correlation relationship is established with.

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)

  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 ServiceLoadMetricWeight) – 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.mgmt.servicefabric.models.``ServicePlacementPolicyDescription`(**kwargs)

  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.``ServiceResource`(*, location: str = None, tags=None, 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, service_package_activation_mode=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  The service resource.

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

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.
  - provisioning_state (str) – The current deployment or provisioning state, which only appears in the response

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.
  - 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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  - service_type_name (str) – The name of the service type
  - partition_description (PartitionSchemeDescription) – Describes how the service is partitioned.
  - service_package_activation_mode (str or ArmServicePackageActivationMode) – The activation Mode of the service package. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’

class `azure.mgmt.servicefabric.models.``ServiceResourceList`(*, value=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The list of service resources.

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

  Parameters: | value (list[ServiceResource]) –
  Variables: | next_link (str) – URL to get the next set of service list results if there are any.

class `azure.mgmt.servicefabric.models.``ServiceResourceProperties`(*, 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, service_package_activation_mode=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourcePropertiesBase`

  The service resource properties.

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

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  - service_type_name (str) – The name of the service type
  - partition_description (PartitionSchemeDescription) – Describes how the service is partitioned.
  - service_package_activation_mode (str or ArmServicePackageActivationMode) – The activation Mode of the service package. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  - 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.``ServiceResourcePropertiesBase`(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’

class `azure.mgmt.servicefabric.models.``ServiceResourceUpdate`(*, location: str = None, tags=None, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ProxyResource`

  The service resource for patch operations.

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

  Variables:

  - id (str) – Azure resource identifier.
  - name (str) – Azure resource name.
  - type (str) – Azure resource type.
  - etag (str) – Azure resource etag.

  Parameters:

  - location (str) – It will be deprecated in New API, resource location depends on the parent resource.
  - tags (dict[str, str]) – Azure resource tags.
  - 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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’

class `azure.mgmt.servicefabric.models.``ServiceResourceUpdateProperties`(*, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourcePropertiesBase`

  The service resource properties for patch operations.

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

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  - service_kind (str) – Required. Constant filled by server.

class `azure.mgmt.servicefabric.models.``ServiceTypeDeltaHealthPolicy`(*, max_percent_delta_unhealthy_services: int = 0, **kwargs)

  Bases: `msrest.serialization.Model`

  Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. .

  Parameters:

  max_percent_delta_unhealthy_services (int) – The maximum allowed percentage of services health degradation allowed during cluster upgrades. The delta is measured between the state of the services at the beginning of upgrade and the state of the services 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. . Default value: 0 .

class `azure.mgmt.servicefabric.models.``ServiceTypeHealthPolicy`(*, max_percent_unhealthy_services: int = 0, **kwargs)

  Bases: `msrest.serialization.Model`

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

  Parameters: | max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error. . Default value: 0 .

class `azure.mgmt.servicefabric.models.``SettingsParameterDescription`(*, name: str, value: str, **kwargs)

  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)

  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.``SingletonPartitionSchemeDescription`(**kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_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.``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, service_package_activation_mode=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)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourceProperties`

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  - service_type_name (str) – The name of the service type
  - partition_description (PartitionSchemeDescription) – Describes how the service is partitioned.
  - service_package_activation_mode (str or ArmServicePackageActivationMode) – The activation Mode of the service package. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  - 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)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourceUpdateProperties`

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. 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.``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, service_package_activation_mode=None, instance_count: int = None, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourceProperties`

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
  - service_type_name (str) – The name of the service type
  - partition_description (PartitionSchemeDescription) – Describes how the service is partitioned.
  - service_package_activation_mode (str or ArmServicePackageActivationMode) – The activation Mode of the service package. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
  - 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)

  Bases: `azure.mgmt.servicefabric.models._models_py3.ServiceResourceUpdateProperties`

  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]) – A list that describes the correlation of the service with other services.
  - service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  - service_placement_policies (list[ServicePlacementPolicyDescription]) – A list that describes the correlation of the service with other services.
  - default_move_cost (str or MoveCost) – Specifies the move cost for the service. 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.``UniformInt64RangePartitionSchemeDescription`(*, count: int, low_key: str, high_key: str, **kwargs)

  Bases: `azure.mgmt.servicefabric.models._models_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.``OperationResultPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `OperationResult` object

class `azure.mgmt.servicefabric.models.``ProvisioningState`

  Bases: `str`, `enum.Enum`

  An enumeration.

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

class `azure.mgmt.servicefabric.models.``ArmUpgradeFailureAction`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `manual` = 'Manual'

    Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically.

  `rollback` = 'Rollback'

    Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails.

class `azure.mgmt.servicefabric.models.``ServiceCorrelationScheme`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `affinity` = 'Affinity'

    Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1.

  `aligned_affinity` = 'AlignedAffinity'

    Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2.

  `invalid` = 'Invalid'

    An invalid correlation scheme. Cannot be used. The value is zero.

  `non_aligned_affinity` = 'NonAlignedAffinity'

    Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3.

class `azure.mgmt.servicefabric.models.``MoveCost`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `high` = 'High'

    Specifies the move cost of the service as High. The value is 3.

  `low` = 'Low'

    Specifies the move cost of the service as Low. The value is 1.

  `medium` = 'Medium'

    Specifies the move cost of the service as Medium. The value is 2.

  `zero` = 'Zero'

    Zero move cost. This value is zero.

class `azure.mgmt.servicefabric.models.``PartitionScheme`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `invalid` = 'Invalid'

    Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.

  `named` = 'Named'

    Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3

  `singleton` = 'Singleton'

    Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.

  `uniform_int64_range` = 'UniformInt64Range'

    Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.

class `azure.mgmt.servicefabric.models.``ServiceKind`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `invalid` = 'Invalid'

    Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.

  `stateful` = 'Stateful'

    Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.

  `stateless` = 'Stateless'

    Does not use Service Fabric to make its state highly available or reliable. The value is 1.

class `azure.mgmt.servicefabric.models.``ServiceLoadMetricWeight`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `high` = 'High'

    Specifies the metric weight of the service load as High. The value is 3.

  `low` = 'Low'

    Specifies the metric weight of the service load as Low. The value is 1.

  `medium` = 'Medium'

    Specifies the metric weight of the service load as Medium. The value is 2.

  `zero` = 'Zero'

    Disables resource balancing for this metric. This value is zero.

class `azure.mgmt.servicefabric.models.``ServicePlacementPolicyType`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `invalid` = 'Invalid'

    Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.

  `invalid_domain` = 'InvalidDomain'

    Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1.

  `non_partially_place_service` = 'NonPartiallyPlaceService'

    Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5.

  `preferred_primary_domain` = 'PreferredPrimaryDomain'

    Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3.

  `required_domain` = 'RequiredDomain'

    Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2.

  `required_domain_distribution` = 'RequiredDomainDistribution'

    Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4.

class `azure.mgmt.servicefabric.models.``ArmServicePackageActivationMode`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `exclusive_process` = 'ExclusiveProcess'

    Indicates the application package activation mode will use exclusive process.

  `shared_process` = 'SharedProcess'

    Indicates the application package activation mode will use shared process.