azure.mgmt.servicefabric.models module¶

class azure.mgmt.servicefabric.models.AddOnFeatures(value)[source]¶

Bases: str, enum.Enum

Available cluster add-on features.

BACKUP_RESTORE_SERVICE = 'BackupRestoreService'¶

DNS_SERVICE = 'DnsService'¶

REPAIR_MANAGER = 'RepairManager'¶

RESOURCE_MONITOR_SERVICE = 'ResourceMonitorService'¶

class azure.mgmt.servicefabric.models.ApplicationDeltaHealthPolicy(*, default_service_type_delta_health_policy: Optional[_models.ServiceTypeDeltaHealthPolicy] = None, service_type_delta_health_policies: Optional[Dict[str, _models.ServiceTypeDeltaHealthPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables

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.

Keyword Arguments

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: Optional[_models.ServiceTypeHealthPolicy] = None, service_type_health_policies: Optional[Dict[str, _models.ServiceTypeHealthPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables

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.

Keyword Arguments

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: Optional[str] = None, maximum_capacity: Optional[int] = None, reservation_capacity: Optional[int] = None, total_application_capacity: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables

name (str) – The name of the metric.
maximum_capacity (int) – 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 (int) – 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 (int) – 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.

Keyword Arguments

name (str) – The name of the metric.
maximum_capacity (int) – 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 (int) – 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 (int) – 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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.ManagedIdentity] = None, type_version: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, upgrade_policy: Optional[_models.ApplicationUpgradePolicy] = None, minimum_nodes: Optional[int] = None, maximum_nodes: int = 0, remove_application_capacity: Optional[bool] = None, metrics: Optional[List[_models.ApplicationMetricDescription]] = None, managed_identities: Optional[List[_models.ApplicationUserAssignedIdentity]] = None, type_name: Optional[str] = None, **kwargs)[source]¶

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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
identity (ManagedIdentity) – Describes the managed identities for an Azure resource.
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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
type_name (str) – The application type name as defined in the application manifest.

Keyword Arguments

location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
identity (ManagedIdentity) – Describes the managed identities for an Azure resource.
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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.
type_name (str) – The application type name as defined in the application manifest.

class azure.mgmt.servicefabric.models.ApplicationResourceList(*, value: Optional[List[_models.ApplicationResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The list of application resources.

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

Variables

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

Keyword Arguments

value (list[ApplicationResource]) –

class azure.mgmt.servicefabric.models.ApplicationResourceProperties(*, type_version: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, upgrade_policy: Optional[_models.ApplicationUpgradePolicy] = None, minimum_nodes: Optional[int] = None, maximum_nodes: int = 0, remove_application_capacity: Optional[bool] = None, metrics: Optional[List[_models.ApplicationMetricDescription]] = None, managed_identities: Optional[List[_models.ApplicationUserAssignedIdentity]] = None, type_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric.models._models_py3.ApplicationResourceUpdateProperties

The application resource properties.

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

Variables

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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
type_name (str) – The application type name as defined in the application manifest.

Keyword Arguments

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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.
type_name (str) – The application type name as defined in the application manifest.

class azure.mgmt.servicefabric.models.ApplicationResourceUpdate(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, type_version: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, upgrade_policy: Optional[_models.ApplicationUpgradePolicy] = None, minimum_nodes: Optional[int] = None, maximum_nodes: int = 0, remove_application_capacity: Optional[bool] = None, metrics: Optional[List[_models.ApplicationMetricDescription]] = None, managed_identities: Optional[List[_models.ApplicationUserAssignedIdentity]] = None, **kwargs)[source]¶

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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.

Keyword Arguments

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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.

class azure.mgmt.servicefabric.models.ApplicationResourceUpdateProperties(*, type_version: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, upgrade_policy: Optional[_models.ApplicationUpgradePolicy] = None, minimum_nodes: Optional[int] = None, maximum_nodes: int = 0, remove_application_capacity: Optional[bool] = None, metrics: Optional[List[_models.ApplicationMetricDescription]] = None, managed_identities: Optional[List[_models.ApplicationUserAssignedIdentity]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The application resource properties for patch operations.

Variables

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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.

Keyword Arguments

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 (int) – 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 (int) – 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.
remove_application_capacity (bool) – Remove the current application capacity settings.
metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
managed_identities (list[ApplicationUserAssignedIdentity]) – List of user assigned identities for the application, each mapped to a friendly name.

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

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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.

Keyword Arguments

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: Optional[List[_models.ApplicationTypeResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The list of application type names.

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

Variables

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

Keyword Arguments

value (list[ApplicationTypeResource]) –

class azure.mgmt.servicefabric.models.ApplicationTypeVersionResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, app_package_url: Optional[str] = None, **kwargs)[source]¶

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.

Variables

id (str) – Azure resource identifier.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
app_package_url (str) – The URL to the application package.
default_parameter_list (dict[str, str]) – List of application type parameters that can be overridden when creating or updating the application.

Keyword Arguments

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) – The URL to the application package.

class azure.mgmt.servicefabric.models.ApplicationTypeVersionResourceList(*, value: Optional[List[_models.ApplicationTypeVersionResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables

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

Keyword Arguments

value (list[ApplicationTypeVersionResource]) –

class azure.mgmt.servicefabric.models.ApplicationTypeVersionsCleanupPolicy(*, max_unused_versions_to_keep: int, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

ApplicationTypeVersionsCleanupPolicy.

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

Variables: max_unused_versions_to_keep (int) – Number of unused versions per application type to keep. Required.
Keyword Arguments: max_unused_versions_to_keep (int) – Number of unused versions per application type to keep. Required.

class azure.mgmt.servicefabric.models.ApplicationUpgradePolicy(*, upgrade_replica_set_check_timeout: Optional[str] = None, force_restart: bool = False, rolling_upgrade_monitoring_policy: Optional[_models.ArmRollingUpgradeMonitoringPolicy] = None, application_health_policy: Optional[_models.ArmApplicationHealthPolicy] = None, upgrade_mode: Union[str, _models.RollingUpgradeMode] = 'Monitored', recreate_application: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the policy for a monitored application upgrade.

Variables

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.
upgrade_mode (str or RollingUpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Known values are: “Invalid”, “UnmonitoredAuto”, “UnmonitoredManual”, and “Monitored”.
recreate_application (bool) – Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss.

Keyword Arguments

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.
upgrade_mode (str or RollingUpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Known values are: “Invalid”, “UnmonitoredAuto”, “UnmonitoredManual”, and “Monitored”.
recreate_application (bool) – Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss.

class azure.mgmt.servicefabric.models.ApplicationUserAssignedIdentity(*, name: str, principal_id: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

ApplicationUserAssignedIdentity.

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

Variables

name (str) – The friendly name of user assigned identity. Required.
principal_id (str) – The principal id of user assigned identity. Required.

Keyword Arguments

name (str) – The friendly name of user assigned identity. Required.
principal_id (str) – The principal id of user assigned identity. Required.

class azure.mgmt.servicefabric.models.ArmApplicationHealthPolicy(*, consider_warning_as_error: bool = False, max_percent_unhealthy_deployed_applications: int = 0, default_service_type_health_policy: Optional[_models.ArmServiceTypeHealthPolicy] = None, service_type_health_policy_map: Optional[Dict[str, _models.ArmServiceTypeHealthPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables

consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors.
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_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.

Keyword Arguments

consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors.
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_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: Optional[Union[str, _models.ArmUpgradeFailureAction]] = None, health_check_wait_duration: str = '0', health_check_stable_duration: str = 'PT0H2M0S', health_check_retry_timeout: str = 'PT0H10M0S', upgrade_timeout: str = 'P10675199DT02H48M05.4775807S', upgrade_domain_timeout: str = 'P10675199DT02H48M05.4775807S', **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The policy used for monitoring the application upgrade.

Variables

failure_action (str or ArmUpgradeFailureAction) – The activation Mode of the service package. Known values are: “Rollback” and “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.

Keyword Arguments

failure_action (str or ArmUpgradeFailureAction) – The activation Mode of the service package. Known values are: “Rollback” and “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.ArmServicePackageActivationMode(value)[source]¶

Bases: str, enum.Enum

The activation Mode of the service package.

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.

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)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables

max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error.
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.
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.

Keyword Arguments

max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error.
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.
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.

class azure.mgmt.servicefabric.models.ArmUpgradeFailureAction(value)[source]¶

Bases: str, enum.Enum

The activation Mode of the service package.

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.AvailableOperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Operation supported by the Service Fabric resource provider.

Variables

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.

Keyword Arguments

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: Optional[str] = None, cluster_application: Optional[str] = None, client_application: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The settings to enable AAD authentication on the cluster.

Variables

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.

Keyword Arguments

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: Optional[str] = None, x509_store_name: Optional[Union[str, _models.StoreName]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the certificate details.

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

Variables

thumbprint (str) – Thumbprint of the primary certificate. Required.
thumbprint_secondary (str) – Thumbprint of the secondary certificate.
x509_store_name (str or StoreName) – The local certificate store location. Known values are: “AddressBook”, “AuthRoot”, “CertificateAuthority”, “Disallowed”, “My”, “Root”, “TrustedPeople”, and “TrustedPublisher”.

Keyword Arguments

thumbprint (str) – Thumbprint of the primary certificate. Required.
thumbprint_secondary (str) – Thumbprint of the secondary certificate.
x509_store_name (str or StoreName) – The local certificate store location. Known values are: “AddressBook”, “AuthRoot”, “CertificateAuthority”, “Disallowed”, “My”, “Root”, “TrustedPeople”, and “TrustedPublisher”.

class azure.mgmt.servicefabric.models.ClientCertificateCommonName(*, is_admin: bool, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the client certificate details using common name.

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

Variables

is_admin (bool) – Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. Required.
certificate_common_name (str) – The common name of the client certificate. Required.
certificate_issuer_thumbprint (str) – The issuer thumbprint of the client certificate. Required.

Keyword Arguments

is_admin (bool) – Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. Required.
certificate_common_name (str) – The common name of the client certificate. Required.
certificate_issuer_thumbprint (str) – The issuer thumbprint of the client certificate. Required.

class azure.mgmt.servicefabric.models.ClientCertificateThumbprint(*, is_admin: bool, certificate_thumbprint: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the client certificate details using thumbprint.

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

Variables

is_admin (bool) – Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. Required.
certificate_thumbprint (str) – The thumbprint of the client certificate. Required.

Keyword Arguments

is_admin (bool) – Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. Required.
certificate_thumbprint (str) – The thumbprint of the client certificate. Required.

class azure.mgmt.servicefabric.models.Cluster(*, location: str, tags: Optional[Dict[str, str]] = None, add_on_features: Optional[List[Union[str, _models.AddOnFeatures]]] = None, azure_active_directory: Optional[_models.AzureActiveDirectory] = None, certificate: Optional[_models.CertificateDescription] = None, certificate_common_names: Optional[_models.ServerCertificateCommonNames] = None, client_certificate_common_names: Optional[List[_models.ClientCertificateCommonName]] = None, client_certificate_thumbprints: Optional[List[_models.ClientCertificateThumbprint]] = None, cluster_code_version: Optional[str] = None, diagnostics_storage_account_config: Optional[_models.DiagnosticsStorageAccountConfig] = None, event_store_service_enabled: Optional[bool] = None, fabric_settings: Optional[List[_models.SettingsSectionDescription]] = None, management_endpoint: Optional[str] = None, node_types: Optional[List[_models.NodeTypeDescription]] = None, reliability_level: Optional[Union[str, _models.ReliabilityLevel]] = None, reverse_proxy_certificate: Optional[_models.CertificateDescription] = None, reverse_proxy_certificate_common_names: Optional[_models.ServerCertificateCommonNames] = None, upgrade_description: Optional[_models.ClusterUpgradePolicy] = None, upgrade_mode: Union[str, _models.UpgradeMode] = 'Automatic', application_type_versions_cleanup_policy: Optional[_models.ApplicationTypeVersionsCleanupPolicy] = None, vm_image: Optional[str] = None, sf_zonal_upgrade_mode: Optional[Union[str, _models.SfZonalUpgradeMode]] = None, vmss_zonal_upgrade_mode: Optional[Union[str, _models.VmssZonalUpgradeMode]] = None, infrastructure_service_manager: Optional[bool] = None, upgrade_wave: Optional[Union[str, _models.ClusterUpgradeCadence]] = None, upgrade_pause_start_timestamp_utc: Optional[datetime.datetime] = None, upgrade_pause_end_timestamp_utc: Optional[datetime.datetime] = None, wave_upgrade_paused: Optional[bool] = None, notifications: Optional[List[_models.Notification]] = None, **kwargs)[source]¶

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.
location (str) – Azure resource location. Required.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
add_on_features (list[str or AddOnFeatures]) – The list of add-on features to enable in the cluster.
available_cluster_versions (list[ClusterVersionDetails]) – The Service Fabric runtime versions available for this 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. To get the list of available version for existing clusters use availableClusterVersions.
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 ClusterState) –
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. Known values are: “WaitingForNodes”, “Deploying”, “BaselineUpgrade”, “UpdatingUserConfiguration”, “UpdatingUserCertificate”, “UpdatingInfrastructure”, “EnforcingClusterVersion”, “UpgradeServiceUnreachable”, “AutoScale”, and “Ready”.
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) – The http management endpoint of the cluster.
node_types (list[NodeTypeDescription]) – The list of node types in the cluster.
provisioning_state (str or ProvisioningState) – The provisioning state of the cluster resource. Known values are: “Updating”, “Succeeded”, “Failed”, and “Canceled”.
reliability_level (str or ReliabilityLevel) –
The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.
- 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. Known values are: “None”, “Bronze”, “Silver”, “Gold”, and “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 UpgradeMode) – The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: “Automatic” and “Manual”.
application_type_versions_cleanup_policy (ApplicationTypeVersionsCleanupPolicy) – The policy used to clean up unused versions.
vm_image (str) – The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.
sf_zonal_upgrade_mode (str or SfZonalUpgradeMode) – This property controls the logical grouping of VMs in upgrade domains (UDs). This property can’t be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: “Parallel” and “Hierarchical”.
vmss_zonal_upgrade_mode (str or VmssZonalUpgradeMode) – This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: “Parallel” and “Hierarchical”.
infrastructure_service_manager (bool) – Indicates if infrastructure service manager is enabled.
upgrade_wave (str or ClusterUpgradeCadence) – Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to ‘Automatic’. Known values are: “Wave0”, “Wave1”, and “Wave2”.
upgrade_pause_start_timestamp_utc (datetime) – Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).
upgrade_pause_end_timestamp_utc (datetime) – Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).
wave_upgrade_paused (bool) – Boolean to pause automatic runtime version upgrades to the cluster.
notifications (list[Notification]) – Indicates a list of notification channels for cluster events.

Keyword Arguments

location (str) – Azure resource location. Required.
tags (dict[str, str]) – Azure resource tags.
add_on_features (list[str or AddOnFeatures]) – 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. 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) – The http management endpoint of the cluster.
node_types (list[NodeTypeDescription]) – The list of node types in the cluster.
reliability_level (str or ReliabilityLevel) –
The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.
- 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. Known values are: “None”, “Bronze”, “Silver”, “Gold”, and “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 UpgradeMode) – The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: “Automatic” and “Manual”.
application_type_versions_cleanup_policy (ApplicationTypeVersionsCleanupPolicy) – The policy used to clean up unused versions.
vm_image (str) – The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.
sf_zonal_upgrade_mode (str or SfZonalUpgradeMode) – This property controls the logical grouping of VMs in upgrade domains (UDs). This property can’t be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: “Parallel” and “Hierarchical”.
vmss_zonal_upgrade_mode (str or VmssZonalUpgradeMode) – This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: “Parallel” and “Hierarchical”.
infrastructure_service_manager (bool) – Indicates if infrastructure service manager is enabled.
upgrade_wave (str or ClusterUpgradeCadence) – Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to ‘Automatic’. Known values are: “Wave0”, “Wave1”, and “Wave2”.
upgrade_pause_start_timestamp_utc (datetime) – Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).
upgrade_pause_end_timestamp_utc (datetime) – Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).
wave_upgrade_paused (bool) – Boolean to pause automatic runtime version upgrades to the cluster.
notifications (list[Notification]) – Indicates a list of notification channels for cluster events.

class azure.mgmt.servicefabric.models.ClusterCodeVersionsListResult(*, value: Optional[List[_models.ClusterCodeVersionsResult]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The list results of the Service Fabric runtime versions.

Variables

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

Keyword Arguments

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

class azure.mgmt.servicefabric.models.ClusterCodeVersionsResult(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, code_version: Optional[str] = None, support_expiry_utc: Optional[str] = None, environment: Optional[Union[str, _models.ClusterEnvironment]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The result of the Service Fabric runtime versions.

Variables

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 ClusterEnvironment) – Indicates if this version is for Windows or Linux operating system. Known values are: “Windows” and “Linux”.

Keyword Arguments

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 ClusterEnvironment) – Indicates if this version is for Windows or Linux operating system. Known values are: “Windows” and “Linux”.

class azure.mgmt.servicefabric.models.ClusterEnvironment(value)[source]¶

Bases: str, enum.Enum

Cluster operating system, the default will be Windows.

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

class azure.mgmt.servicefabric.models.ClusterHealthPolicy(*, max_percent_unhealthy_nodes: int = 0, max_percent_unhealthy_applications: int = 0, application_health_policies: Optional[Dict[str, _models.ApplicationHealthPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables

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.
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.
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.

Keyword Arguments

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.
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.
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: Optional[List[_models.Cluster]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Cluster list results.

Variables

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

Keyword Arguments

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

class azure.mgmt.servicefabric.models.ClusterState(value)[source]¶

Bases: str, enum.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.

AUTO_SCALE = 'AutoScale'¶

BASELINE_UPGRADE = 'BaselineUpgrade'¶

DEPLOYING = 'Deploying'¶

ENFORCING_CLUSTER_VERSION = 'EnforcingClusterVersion'¶

READY = 'Ready'¶

UPDATING_INFRASTRUCTURE = 'UpdatingInfrastructure'¶

UPDATING_USER_CERTIFICATE = 'UpdatingUserCertificate'¶

UPDATING_USER_CONFIGURATION = 'UpdatingUserConfiguration'¶

UPGRADE_SERVICE_UNREACHABLE = 'UpgradeServiceUnreachable'¶

WAITING_FOR_NODES = 'WaitingForNodes'¶

class azure.mgmt.servicefabric.models.ClusterUpdateParameters(*, tags: Optional[Dict[str, str]] = None, add_on_features: Optional[List[Union[str, _models.AddOnFeatures]]] = None, certificate: Optional[_models.CertificateDescription] = None, certificate_common_names: Optional[_models.ServerCertificateCommonNames] = None, client_certificate_common_names: Optional[List[_models.ClientCertificateCommonName]] = None, client_certificate_thumbprints: Optional[List[_models.ClientCertificateThumbprint]] = None, cluster_code_version: Optional[str] = None, event_store_service_enabled: Optional[bool] = None, fabric_settings: Optional[List[_models.SettingsSectionDescription]] = None, node_types: Optional[List[_models.NodeTypeDescription]] = None, reliability_level: Optional[Union[str, _models.ReliabilityLevel]] = None, reverse_proxy_certificate: Optional[_models.CertificateDescription] = None, upgrade_description: Optional[_models.ClusterUpgradePolicy] = None, application_type_versions_cleanup_policy: Optional[_models.ApplicationTypeVersionsCleanupPolicy] = None, upgrade_mode: Union[str, _models.UpgradeMode] = 'Automatic', sf_zonal_upgrade_mode: Optional[Union[str, _models.SfZonalUpgradeMode]] = None, vmss_zonal_upgrade_mode: Optional[Union[str, _models.VmssZonalUpgradeMode]] = None, infrastructure_service_manager: Optional[bool] = None, upgrade_wave: Optional[Union[str, _models.ClusterUpgradeCadence]] = None, upgrade_pause_start_timestamp_utc: Optional[datetime.datetime] = None, upgrade_pause_end_timestamp_utc: Optional[datetime.datetime] = None, wave_upgrade_paused: Optional[bool] = None, notifications: Optional[List[_models.Notification]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Cluster update request.

Variables

tags (dict[str, str]) – Cluster update parameters.
add_on_features (list[str or AddOnFeatures]) – 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. 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 ReliabilityLevel) –
The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.
- 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. Known values are: “None”, “Bronze”, “Silver”, “Gold”, and “Platinum”.
reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
application_type_versions_cleanup_policy (ApplicationTypeVersionsCleanupPolicy) – The policy used to clean up unused versions.
upgrade_mode (str or UpgradeMode) – The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: “Automatic” and “Manual”.
sf_zonal_upgrade_mode (str or SfZonalUpgradeMode) – This property controls the logical grouping of VMs in upgrade domains (UDs). This property can’t be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: “Parallel” and “Hierarchical”.
vmss_zonal_upgrade_mode (str or VmssZonalUpgradeMode) – This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: “Parallel” and “Hierarchical”.
infrastructure_service_manager (bool) – Indicates if infrastructure service manager is enabled.
upgrade_wave (str or ClusterUpgradeCadence) – Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to ‘Automatic’. Known values are: “Wave0”, “Wave1”, and “Wave2”.
upgrade_pause_start_timestamp_utc (datetime) – The start timestamp to pause runtime version upgrades on the cluster (UTC).
upgrade_pause_end_timestamp_utc (datetime) – The end timestamp of pause runtime version upgrades on the cluster (UTC).
wave_upgrade_paused (bool) – Boolean to pause automatic runtime version upgrades to the cluster.
notifications (list[Notification]) – Indicates a list of notification channels for cluster events.

Keyword Arguments

tags (dict[str, str]) – Cluster update parameters.
add_on_features (list[str or AddOnFeatures]) – 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. 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 ReliabilityLevel) –
The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.
- 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. Known values are: “None”, “Bronze”, “Silver”, “Gold”, and “Platinum”.
reverse_proxy_certificate (CertificateDescription) – The server certificate used by reverse proxy.
upgrade_description (ClusterUpgradePolicy) – The policy to use when upgrading the cluster.
application_type_versions_cleanup_policy (ApplicationTypeVersionsCleanupPolicy) – The policy used to clean up unused versions.
upgrade_mode (str or UpgradeMode) – The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: “Automatic” and “Manual”.
sf_zonal_upgrade_mode (str or SfZonalUpgradeMode) – This property controls the logical grouping of VMs in upgrade domains (UDs). This property can’t be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: “Parallel” and “Hierarchical”.
vmss_zonal_upgrade_mode (str or VmssZonalUpgradeMode) – This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: “Parallel” and “Hierarchical”.
infrastructure_service_manager (bool) – Indicates if infrastructure service manager is enabled.
upgrade_wave (str or ClusterUpgradeCadence) – Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to ‘Automatic’. Known values are: “Wave0”, “Wave1”, and “Wave2”.
upgrade_pause_start_timestamp_utc (datetime) – The start timestamp to pause runtime version upgrades on the cluster (UTC).
upgrade_pause_end_timestamp_utc (datetime) – The end timestamp of pause runtime version upgrades on the cluster (UTC).
wave_upgrade_paused (bool) – Boolean to pause automatic runtime version upgrades to the cluster.
notifications (list[Notification]) – Indicates a list of notification channels for cluster events.

class azure.mgmt.servicefabric.models.ClusterUpgradeCadence(value)[source]¶

Bases: str, enum.Enum

Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0.

WAVE0 = 'Wave0'¶: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters.

WAVE1 = 'Wave1'¶: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters.

WAVE2 = 'Wave2'¶: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters.

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: Optional[Dict[str, _models.ApplicationDeltaHealthPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the delta health policies for the cluster upgrade.

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

Variables

max_percent_delta_unhealthy_nodes (int) – The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. Required.
max_percent_upgrade_domain_delta_unhealthy_nodes (int) – The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. Required.
max_percent_delta_unhealthy_applications (int) – 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. Required.
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.

Keyword Arguments

max_percent_delta_unhealthy_nodes (int) – The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. Required.
max_percent_upgrade_domain_delta_unhealthy_nodes (int) – The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. Required.
max_percent_delta_unhealthy_applications (int) – 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. Required.
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: _models.ClusterHealthPolicy, force_restart: Optional[bool] = None, delta_health_policy: Optional[_models.ClusterUpgradeDeltaHealthPolicy] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the policy used when upgrading the cluster.

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

Variables

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) – 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. Required.
health_check_wait_duration (str) – 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. Required.
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_retry_timeout (str) – 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. Required.
upgrade_timeout (str) – 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. Required.
upgrade_domain_timeout (str) – 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. Required.
health_policy (ClusterHealthPolicy) – The cluster health policy used when upgrading the cluster. Required.
delta_health_policy (ClusterUpgradeDeltaHealthPolicy) – The cluster delta health policy used when upgrading the cluster.

Keyword Arguments

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) – 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. Required.
health_check_wait_duration (str) – 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. Required.
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_retry_timeout (str) – 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. Required.
upgrade_timeout (str) – 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. Required.
upgrade_domain_timeout (str) – 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. Required.
health_policy (ClusterHealthPolicy) – The cluster health policy used when upgrading the cluster. Required.
delta_health_policy (ClusterUpgradeDeltaHealthPolicy) – The cluster delta health policy used when upgrading the cluster.

class azure.mgmt.servicefabric.models.ClusterVersionDetails(*, code_version: Optional[str] = None, support_expiry_utc: Optional[str] = None, environment: Optional[Union[str, _models.ClusterEnvironment]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The detail of the Service Fabric runtime version result.

Variables

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 ClusterEnvironment) – Indicates if this version is for Windows or Linux operating system. Known values are: “Windows” and “Linux”.

Keyword Arguments

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 ClusterEnvironment) – Indicates if this version is for Windows or Linux operating system. Known values are: “Windows” and “Linux”.

class azure.mgmt.servicefabric.models.ClusterVersionsEnvironment(value)[source]¶

Bases: str, enum.Enum

ClusterVersionsEnvironment.

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

class azure.mgmt.servicefabric.models.DiagnosticsStorageAccountConfig(*, storage_account_name: str, protected_account_key_name: str, blob_endpoint: str, queue_endpoint: str, table_endpoint: str, protected_account_key_name2: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The storage account information for storing Service Fabric diagnostic logs.

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

Variables

storage_account_name (str) – The Azure storage account name. Required.
protected_account_key_name (str) – The protected diagnostics storage key name. Required.
protected_account_key_name2 (str) – The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other.
blob_endpoint (str) – The blob endpoint of the azure storage account. Required.
queue_endpoint (str) – The queue endpoint of the azure storage account. Required.
table_endpoint (str) – The table endpoint of the azure storage account. Required.

Keyword Arguments

storage_account_name (str) – The Azure storage account name. Required.
protected_account_key_name (str) – The protected diagnostics storage key name. Required.
protected_account_key_name2 (str) – The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other.
blob_endpoint (str) – The blob endpoint of the azure storage account. Required.
queue_endpoint (str) – The queue endpoint of the azure storage account. Required.
table_endpoint (str) – The table endpoint of the azure storage account. Required.

class azure.mgmt.servicefabric.models.DurabilityLevel(value)[source]¶

Bases: str, enum.Enum

The durability level of the node type. Learn about DurabilityLevel.

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.

BRONZE = 'Bronze'¶

GOLD = 'Gold'¶

SILVER = 'Silver'¶

class azure.mgmt.servicefabric.models.EndpointRangeDescription(*, start_port: int, end_port: int, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Port range details.

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

Variables

start_port (int) – Starting port of a range of ports. Required.
end_port (int) – End port of a range of ports. Required.

Keyword Arguments

start_port (int) – Starting port of a range of ports. Required.
end_port (int) – End port of a range of ports. Required.

class azure.mgmt.servicefabric.models.ErrorModel(*, error: Optional[_models.ErrorModelError] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The structure of the error.

Variables: error (ErrorModelError) – The error details.
Keyword Arguments: error (ErrorModelError) – The error details.

class azure.mgmt.servicefabric.models.ErrorModelError(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The error details.

Variables

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

Keyword Arguments

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

class azure.mgmt.servicefabric.models.ManagedIdentity(*, type: Optional[Union[str, _models.ManagedIdentityType]] = None, user_assigned_identities: Optional[Dict[str, _models.UserAssignedIdentity]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the managed identities for an Azure resource.

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

Variables

principal_id (str) – The principal id of the managed identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id of the managed identity. This property will only be provided for a system assigned identity.
type (str or ManagedIdentityType) – The type of managed identity for the resource. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:

‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. :vartype user_assigned_identities: dict[str,

~azure.mgmt.servicefabric.models.UserAssignedIdentity]

Keyword Arguments

type (str or ManagedIdentityType) – The type of managed identity for the resource. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:

‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. :paramtype user_assigned_identities: dict[str,

~azure.mgmt.servicefabric.models.UserAssignedIdentity]

class azure.mgmt.servicefabric.models.ManagedIdentityType(value)[source]¶

Bases: str, enum.Enum

The type of managed identity for the resource.

NONE = 'None'¶: Indicates that no identity is associated with the resource.

SYSTEM_ASSIGNED = 'SystemAssigned'¶: Indicates that system assigned identity is associated with the resource.

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'¶: Indicates that both system assigned and user assigned identity are associated with the resource.

USER_ASSIGNED = 'UserAssigned'¶: Indicates that user assigned identity is associated with the resource.

class azure.mgmt.servicefabric.models.MoveCost(value)[source]¶

Bases: str, enum.Enum

Specifies the move cost for the service.

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.NamedPartitionSchemeDescription(*, count: int, names: List[str], **kwargs)[source]¶

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.

Variables

partition_scheme (str or PartitionScheme) – Specifies how the service is partitioned. Required. Known values are: “Invalid”, “Singleton”, “UniformInt64Range”, and “Named”.
count (int) – The number of partitions. Required.
names (list[str]) – Array of size specified by the ‘count’ parameter, for the names of the partitions. Required.

Keyword Arguments

count (int) – The number of partitions. Required.
names (list[str]) – Array of size specified by the ‘count’ parameter, for the names of the partitions. Required.

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: Optional[Dict[str, str]] = None, capacities: Optional[Dict[str, str]] = None, durability_level: Optional[Union[str, _models.DurabilityLevel]] = None, application_ports: Optional[_models.EndpointRangeDescription] = None, ephemeral_ports: Optional[_models.EndpointRangeDescription] = None, reverse_proxy_endpoint_port: Optional[int] = None, is_stateless: Optional[bool] = None, multiple_availability_zones: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables

name (str) – The name of the node type. Required.
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) – The TCP cluster management endpoint port. Required.
http_gateway_endpoint_port (int) – The HTTP cluster management endpoint port. Required.
durability_level (str or DurabilityLevel) –
The durability level of the node type. Learn about DurabilityLevel.
- 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. Known values are: “Bronze”, “Silver”, and “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) – 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. Required.
vm_instance_count (int) – VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. Required.
reverse_proxy_endpoint_port (int) – The endpoint used by reverse proxy.
is_stateless (bool) – Indicates if the node type can only host Stateless workloads.
multiple_availability_zones (bool) – Indicates if the node type is enabled to support multiple zones.

Keyword Arguments

name (str) – The name of the node type. Required.
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) – The TCP cluster management endpoint port. Required.
http_gateway_endpoint_port (int) – The HTTP cluster management endpoint port. Required.
durability_level (str or DurabilityLevel) –
The durability level of the node type. Learn about DurabilityLevel.
- 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. Known values are: “Bronze”, “Silver”, and “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) – 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. Required.
vm_instance_count (int) – VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. Required.
reverse_proxy_endpoint_port (int) – The endpoint used by reverse proxy.
is_stateless (bool) – Indicates if the node type can only host Stateless workloads.
multiple_availability_zones (bool) – Indicates if the node type is enabled to support multiple zones.

class azure.mgmt.servicefabric.models.Notification(*, is_enabled: bool, notification_category: Union[str, _models.NotificationCategory], notification_level: Union[str, _models.NotificationLevel], notification_targets: List[_models.NotificationTarget], **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the notification channel for cluster events.

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

Variables

is_enabled (bool) – Indicates if the notification is enabled. Required.
notification_category (str or NotificationCategory) – The category of notification. Required. “WaveProgress”
notification_level (str or NotificationLevel) – The level of notification. Required. Known values are: “Critical” and “All”.
notification_targets (list[NotificationTarget]) – List of targets that subscribe to the notification. Required.

Keyword Arguments

is_enabled (bool) – Indicates if the notification is enabled. Required.
notification_category (str or NotificationCategory) – The category of notification. Required. “WaveProgress”
notification_level (str or NotificationLevel) – The level of notification. Required. Known values are: “Critical” and “All”.
notification_targets (list[NotificationTarget]) – List of targets that subscribe to the notification. Required.

class azure.mgmt.servicefabric.models.NotificationCategory(value)[source]¶

Bases: str, enum.Enum

The category of notification.

WAVE_PROGRESS = 'WaveProgress'¶: Notification will be regarding wave progress.

class azure.mgmt.servicefabric.models.NotificationChannel(value)[source]¶

Bases: str, enum.Enum

The notification channel indicates the type of receivers subscribed to the notification, either user or subscription.

EMAIL_SUBSCRIPTION = 'EmailSubscription'¶: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications.

EMAIL_USER = 'EmailUser'¶: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications.

class azure.mgmt.servicefabric.models.NotificationLevel(value)[source]¶

Bases: str, enum.Enum

The level of notification.

ALL = 'All'¶: Receive all notifications.

CRITICAL = 'Critical'¶: Receive only critical notifications.

class azure.mgmt.servicefabric.models.NotificationTarget(*, notification_channel: Union[str, _models.NotificationChannel], receivers: List[str], **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the notification target properties.

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

Variables

notification_channel (str or NotificationChannel) – The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. Required. Known values are: “EmailUser” and “EmailSubscription”.
receivers (list[str]) – List of targets that subscribe to the notification. Required.

Keyword Arguments

notification_channel (str or NotificationChannel) – The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. Required. Known values are: “EmailUser” and “EmailSubscription”.
receivers (list[str]) – List of targets that subscribe to the notification. Required.

class azure.mgmt.servicefabric.models.OperationListResult(*, value: Optional[List[_models.OperationResult]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the result of the request to list Service Fabric resource provider operations.

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

Variables

value (list[OperationResult]) – List of operations supported by the Service Fabric resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments

value (list[OperationResult]) – List of operations supported by the Service Fabric resource provider.

class azure.mgmt.servicefabric.models.OperationResult(*, name: Optional[str] = None, is_data_action: Optional[bool] = None, display: Optional[_models.AvailableOperationDisplay] = None, origin: Optional[str] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Available operation list result.

Variables

name (str) – The name of the operation.
is_data_action (bool) – Indicates whether the operation is a data action.
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.

Keyword Arguments

name (str) – The name of the operation.
is_data_action (bool) – Indicates whether the operation is a data action.
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.PartitionScheme(value)[source]¶

Bases: str, enum.Enum

Enumerates the ways that a service can be partitioned.

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.PartitionSchemeDescription(**kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables: partition_scheme (str or PartitionScheme) – Specifies how the service is partitioned. Required. Known values are: “Invalid”, “Singleton”, “UniformInt64Range”, and “Named”.

class azure.mgmt.servicefabric.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

The provisioning state of the cluster resource.

CANCELED = 'Canceled'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

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

Bases: azure.mgmt.servicefabric._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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

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.ReliabilityLevel(value)[source]¶

Bases: str, enum.Enum

The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.

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.

BRONZE = 'Bronze'¶

GOLD = 'Gold'¶

NONE = 'None'¶

PLATINUM = 'Platinum'¶

SILVER = 'Silver'¶

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

Bases: azure.mgmt.servicefabric._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.
location (str) – Azure resource location. Required.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

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

class azure.mgmt.servicefabric.models.RollingUpgradeMode(value)[source]¶

Bases: str, enum.Enum

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.

INVALID = 'Invalid'¶: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.

MONITORED = 'Monitored'¶: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3

UNMONITORED_AUTO = 'UnmonitoredAuto'¶: The upgrade will proceed automatically without performing any health monitoring. The value is 1

UNMONITORED_MANUAL = 'UnmonitoredManual'¶: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2

class azure.mgmt.servicefabric.models.ServerCertificateCommonName(*, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes the server certificate details using common name.

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

Variables

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

Keyword Arguments

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

class azure.mgmt.servicefabric.models.ServerCertificateCommonNames(*, common_names: Optional[List[_models.ServerCertificateCommonName]] = None, x509_store_name: Optional[Union[str, _models.StoreName]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables

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 StoreName) – The local certificate store location. Known values are: “AddressBook”, “AuthRoot”, “CertificateAuthority”, “Disallowed”, “My”, “Root”, “TrustedPeople”, and “TrustedPublisher”.

Keyword Arguments

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 StoreName) – The local certificate store location. Known values are: “AddressBook”, “AuthRoot”, “CertificateAuthority”, “Disallowed”, “My”, “Root”, “TrustedPeople”, and “TrustedPublisher”.

class azure.mgmt.servicefabric.models.ServiceCorrelationDescription(*, scheme: Union[str, _models.ServiceCorrelationScheme], service_name: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Creates a particular correlation between services.

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

Variables

scheme (str or ServiceCorrelationScheme) – The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Required. Known values are: “Invalid”, “Affinity”, “AlignedAffinity”, and “NonAlignedAffinity”.
service_name (str) – The name of the service that the correlation relationship is established with. Required.

Keyword Arguments

scheme (str or ServiceCorrelationScheme) – The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Required. Known values are: “Invalid”, “Affinity”, “AlignedAffinity”, and “NonAlignedAffinity”.
service_name (str) – The name of the service that the correlation relationship is established with. Required.

class azure.mgmt.servicefabric.models.ServiceCorrelationScheme(value)[source]¶

Bases: str, enum.Enum

The service correlation scheme.

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.ServiceKind(value)[source]¶

Bases: str, enum.Enum

The kind of service (Stateless or Stateful).

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.ServiceLoadMetricDescription(*, name: str, weight: Optional[Union[str, _models.ServiceLoadMetricWeight]] = None, primary_default_load: Optional[int] = None, secondary_default_load: Optional[int] = None, default_load: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Specifies a metric to load balance a service during runtime.

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

Variables

name (str) – The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive. Required.
weight (str or ServiceLoadMetricWeight) – The service load metric relative weight, compared to other metrics configured for this service, as a number. Known values are: “Zero”, “Low”, “Medium”, and “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.

Keyword Arguments

name (str) – The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive. Required.
weight (str or ServiceLoadMetricWeight) – The service load metric relative weight, compared to other metrics configured for this service, as a number. Known values are: “Zero”, “Low”, “Medium”, and “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.ServiceLoadMetricWeight(value)[source]¶

Bases: str, enum.Enum

Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.

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.ServicePlacementPolicyDescription(**kwargs)[source]¶

Bases: azure.mgmt.servicefabric._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.

Variables: type (str or ServicePlacementPolicyType) – The type of placement policy for a service fabric service. Following are the possible values. Required. Known values are: “Invalid”, “InvalidDomain”, “RequiredDomain”, “PreferredPrimaryDomain”, “RequiredDomainDistribution”, and “NonPartiallyPlaceService”.

class azure.mgmt.servicefabric.models.ServicePlacementPolicyType(value)[source]¶

Bases: str, enum.Enum

The type of placement policy for a service fabric service. Following are the possible values.

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.ServiceResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, service_type_name: Optional[str] = None, partition_description: Optional[_models.PartitionSchemeDescription] = None, service_package_activation_mode: Optional[Union[str, _models.ArmServicePackageActivationMode]] = None, service_dns_name: Optional[str] = None, **kwargs)[source]¶

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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Known values are: “Invalid”, “Stateless”, and “Stateful”.
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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.

class azure.mgmt.servicefabric.models.ServiceResourceList(*, value: Optional[List[_models.ServiceResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The list of service resources.

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

Variables

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

Keyword Arguments

value (list[ServiceResource]) –

class azure.mgmt.servicefabric.models.ServiceResourceProperties(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, service_type_name: Optional[str] = None, partition_description: Optional[_models.PartitionSchemeDescription] = None, service_package_activation_mode: Optional[Union[str, _models.ArmServicePackageActivationMode]] = None, service_dns_name: Optional[str] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.
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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.

class azure.mgmt.servicefabric.models.ServiceResourcePropertiesBase(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The common service resource properties.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.

class azure.mgmt.servicefabric.models.ServiceResourceUpdate(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, **kwargs)[source]¶

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.
location (str) – It will be deprecated in New API, resource location depends on the parent resource.
tags (dict[str, str]) – Azure resource tags.
etag (str) – Azure resource etag.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Known values are: “Invalid”, “Stateless”, and “Stateful”.

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.

class azure.mgmt.servicefabric.models.ServiceResourceUpdateProperties(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.

class azure.mgmt.servicefabric.models.ServiceTypeDeltaHealthPolicy(*, max_percent_delta_unhealthy_services: int = 0, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables: 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.
Keyword Arguments: 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.

class azure.mgmt.servicefabric.models.ServiceTypeHealthPolicy(*, max_percent_unhealthy_services: int = 0, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

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

Variables: max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error.
Keyword Arguments: max_percent_unhealthy_services (int) – The maximum percentage of services allowed to be unhealthy before your application is considered in error.

class azure.mgmt.servicefabric.models.SettingsParameterDescription(*, name: str, value: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes a parameter in fabric settings of the cluster.

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

Variables

name (str) – The parameter name of fabric setting. Required.
value (str) – The parameter value of fabric setting. Required.

Keyword Arguments

name (str) – The parameter name of fabric setting. Required.
value (str) – The parameter value of fabric setting. Required.

class azure.mgmt.servicefabric.models.SettingsSectionDescription(*, name: str, parameters: List[_models.SettingsParameterDescription], **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Describes a section in the fabric settings of the cluster.

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

Variables

name (str) – The section name of the fabric settings. Required.
parameters (list[SettingsParameterDescription]) – The collection of parameters in the section. Required.

Keyword Arguments

name (str) – The section name of the fabric settings. Required.
parameters (list[SettingsParameterDescription]) – The collection of parameters in the section. Required.

class azure.mgmt.servicefabric.models.SfZonalUpgradeMode(value)[source]¶

Bases: str, enum.Enum

This property controls the logical grouping of VMs in upgrade domains (UDs). This property can’t be modified if a node type with multiple Availability Zones is already present in the cluster.

HIERARCHICAL = 'Hierarchical'¶: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application.

PARALLEL = 'Parallel'¶: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don’t recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time.

class azure.mgmt.servicefabric.models.SingletonPartitionSchemeDescription(**kwargs)[source]¶

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

SingletonPartitionSchemeDescription.

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

Variables: partition_scheme (str or PartitionScheme) – Specifies how the service is partitioned. Required. Known values are: “Invalid”, “Singleton”, “UniformInt64Range”, and “Named”.

class azure.mgmt.servicefabric.models.StatefulServiceProperties(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, service_type_name: Optional[str] = None, partition_description: Optional[_models.PartitionSchemeDescription] = None, service_package_activation_mode: Optional[Union[str, _models.ArmServicePackageActivationMode]] = None, service_dns_name: Optional[str] = None, has_persisted_state: Optional[bool] = None, target_replica_set_size: Optional[int] = None, min_replica_set_size: Optional[int] = None, replica_restart_wait_duration: Optional[datetime.datetime] = None, quorum_loss_wait_duration: Optional[datetime.datetime] = None, stand_by_replica_keep_duration: Optional[datetime.datetime] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.
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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
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).

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
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).

class azure.mgmt.servicefabric.models.StatefulServiceUpdateProperties(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, target_replica_set_size: Optional[int] = None, min_replica_set_size: Optional[int] = None, replica_restart_wait_duration: Optional[datetime.datetime] = None, quorum_loss_wait_duration: Optional[datetime.datetime] = None, stand_by_replica_keep_duration: Optional[datetime.datetime] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.
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).

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
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: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, service_type_name: Optional[str] = None, partition_description: Optional[_models.PartitionSchemeDescription] = None, service_package_activation_mode: Optional[Union[str, _models.ArmServicePackageActivationMode]] = None, service_dns_name: Optional[str] = None, instance_count: Optional[int] = None, instance_close_delay_duration: Optional[str] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
provisioning_state (str) – The current deployment or provisioning state, which only appears in the response.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.
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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
instance_count (int) – The instance count.
instance_close_delay_duration (str) – Delay duration for RequestDrain feature to ensures that the endpoint advertised by the stateless instance is removed before the delay starts prior to closing the instance. This delay enables existing requests to drain gracefully before the instance actually goes down (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview). It is represented in ISO 8601 format (hh:mm:ss.s).

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “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. Known values are: “SharedProcess” and “ExclusiveProcess”.
service_dns_name (str) – Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
instance_count (int) – The instance count.
instance_close_delay_duration (str) – Delay duration for RequestDrain feature to ensures that the endpoint advertised by the stateless instance is removed before the delay starts prior to closing the instance. This delay enables existing requests to drain gracefully before the instance actually goes down (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview). It is represented in ISO 8601 format (hh:mm:ss.s).

class azure.mgmt.servicefabric.models.StatelessServiceUpdateProperties(*, placement_constraints: Optional[str] = None, correlation_scheme: Optional[List[_models.ServiceCorrelationDescription]] = None, service_load_metrics: Optional[List[_models.ServiceLoadMetricDescription]] = None, service_placement_policies: Optional[List[_models.ServicePlacementPolicyDescription]] = None, default_move_cost: Optional[Union[str, _models.MoveCost]] = None, instance_count: Optional[int] = None, instance_close_delay_duration: Optional[str] = None, **kwargs)[source]¶

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.

Variables

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
service_kind (str or ServiceKind) – The kind of service (Stateless or Stateful). Required. Known values are: “Invalid”, “Stateless”, and “Stateful”.
instance_count (int) – The instance count.
instance_close_delay_duration (str) – Delay duration for RequestDrain feature to ensures that the endpoint advertised by the stateless instance is removed before the delay starts prior to closing the instance. This delay enables existing requests to drain gracefully before the instance actually goes down (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview). It is first interpreted as a string representing an ISO 8601 duration. It is represented in ISO 8601 format (hh:mm:ss.s).

Keyword Arguments

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. Known values are: “Zero”, “Low”, “Medium”, and “High”.
instance_count (int) – The instance count.
instance_close_delay_duration (str) – Delay duration for RequestDrain feature to ensures that the endpoint advertised by the stateless instance is removed before the delay starts prior to closing the instance. This delay enables existing requests to drain gracefully before the instance actually goes down (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview). It is first interpreted as a string representing an ISO 8601 duration. It is represented in ISO 8601 format (hh:mm:ss.s).

class azure.mgmt.servicefabric.models.StoreName(value)[source]¶

Bases: str, enum.Enum

The local certificate store location.

ADDRESS_BOOK = 'AddressBook'¶

AUTH_ROOT = 'AuthRoot'¶

CERTIFICATE_AUTHORITY = 'CertificateAuthority'¶

DISALLOWED = 'Disallowed'¶

MY = 'My'¶

ROOT = 'Root'¶

TRUSTED_PEOPLE = 'TrustedPeople'¶

TRUSTED_PUBLISHER = 'TrustedPublisher'¶

class azure.mgmt.servicefabric.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[str] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[str] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str) – The type of identity that created the resource.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str) – The type of identity that last modified the resource.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str) – The type of identity that created the resource.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str) – The type of identity that last modified the resource.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.servicefabric.models.UniformInt64RangePartitionSchemeDescription(*, count: int, low_key: str, high_key: str, **kwargs)[source]¶

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.

Variables

partition_scheme (str or PartitionScheme) – Specifies how the service is partitioned. Required. Known values are: “Invalid”, “Singleton”, “UniformInt64Range”, and “Named”.
count (int) – The number of partitions. Required.
low_key (str) – String indicating the lower bound of the partition key range that should be split between the partition ‘count’. Required.
high_key (str) – String indicating the upper bound of the partition key range that should be split between the partition ‘count’. Required.

Keyword Arguments

count (int) – The number of partitions. Required.
low_key (str) – String indicating the lower bound of the partition key range that should be split between the partition ‘count’. Required.
high_key (str) – String indicating the upper bound of the partition key range that should be split between the partition ‘count’. Required.

class azure.mgmt.servicefabric.models.UpgradableVersionPathResult(*, supported_path: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

The list of intermediate cluster code versions for an upgrade or downgrade. Or minimum and maximum upgradable version if no target was given.

Variables: supported_path (list[str]) –
Keyword Arguments: supported_path (list[str]) –

class azure.mgmt.servicefabric.models.UpgradableVersionsDescription(*, target_version: str, **kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

UpgradableVersionsDescription.

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

Variables: target_version (str) – The target code version. Required.
Keyword Arguments: target_version (str) – The target code version. Required.

class azure.mgmt.servicefabric.models.UpgradeMode(value)[source]¶

Bases: str, enum.Enum

The upgrade mode of the cluster when new Service Fabric runtime version is available.

AUTOMATIC = 'Automatic'¶: The cluster will be automatically upgraded to the latest Service Fabric runtime version, upgradeWave will determine when the upgrade starts after the new version becomes available.

MANUAL = '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.

class azure.mgmt.servicefabric.models.UserAssignedIdentity(**kwargs)[source]¶

Bases: azure.mgmt.servicefabric._serialization.Model

UserAssignedIdentity.

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

Variables

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.servicefabric.models.VmssZonalUpgradeMode(value)[source]¶

Bases: str, enum.Enum

This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.

HIERARCHICAL = 'Hierarchical'¶: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone.

PARALLEL = 'Parallel'¶: Updates will happen in all Availability Zones at once for the virtual machine scale sets.