models Package

Classes

ApplicationDeltaHealthPolicy

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

ApplicationHealthPolicy

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

ApplicationMetricDescription

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.

ApplicationResource

The application resource.

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

ApplicationResourceList

The list of application resources.

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

ApplicationResourceProperties

The application resource properties.

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

ApplicationResourceUpdate

The application resource for patch operations.

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

ApplicationResourceUpdateProperties

The application resource properties for patch operations.

ApplicationTypeResource

The application type name resource.

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

ApplicationTypeResourceList

The list of application type names.

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

ApplicationTypeVersionResource

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.

ApplicationTypeVersionResourceList

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.

ApplicationTypeVersionsCleanupPolicy

ApplicationTypeVersionsCleanupPolicy.

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

ApplicationUpgradePolicy

Describes the policy for a monitored application upgrade.

ApplicationUserAssignedIdentity

ApplicationUserAssignedIdentity.

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

ArmApplicationHealthPolicy

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

ArmRollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade.

ArmServiceTypeHealthPolicy

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

AvailableOperationDisplay

Operation supported by the Service Fabric resource provider.

AzureActiveDirectory

The settings to enable AAD authentication on the cluster.

CertificateDescription

Describes the certificate details.

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

ClientCertificateCommonName

Describes the client certificate details using common name.

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

ClientCertificateThumbprint

Describes the client certificate details using thumbprint.

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

Cluster

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.

ClusterCodeVersionsListResult

The list results of the Service Fabric runtime versions.

ClusterCodeVersionsResult

The result of the Service Fabric runtime versions.

ClusterHealthPolicy

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

ClusterListResult

Cluster list results.

ClusterUpdateParameters

Cluster update request.

ClusterUpgradeDeltaHealthPolicy

Describes the delta health policies for the cluster upgrade.

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

ClusterUpgradePolicy

Describes the policy used when upgrading the cluster.

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

ClusterVersionDetails

The detail of the Service Fabric runtime version result.

DiagnosticsStorageAccountConfig

The storage account information for storing Service Fabric diagnostic logs.

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

EndpointRangeDescription

Port range details.

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

ErrorModel

The structure of the error.

ErrorModelError

The error details.

ManagedIdentity

Describes the managed identities for an Azure resource.

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

'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. :type user_assigned_identities: dict[str,

~azure.mgmt.servicefabric.models.UserAssignedIdentity]

NamedPartitionSchemeDescription

Describes the named partition scheme of the service.

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

NodeTypeDescription

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.

Notification

Describes the notification channel for cluster events.

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

NotificationTarget

Describes the notification target properties.

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

OperationListResult

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.

OperationResult

Available operation list result.

PartitionSchemeDescription

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.

ProxyResource

The resource model definition for proxy-only resource.

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

Resource

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.

ServerCertificateCommonName

Describes the server certificate details using common name.

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

ServerCertificateCommonNames

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

ServiceCorrelationDescription

Creates a particular correlation between services.

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

ServiceLoadMetricDescription

Specifies a metric to load balance a service during runtime.

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

ServicePlacementPolicyDescription

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

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

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

ServiceResource

The service resource.

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

ServiceResourceList

The list of service resources.

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

ServiceResourceProperties

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.

ServiceResourcePropertiesBase

The common service resource properties.

ServiceResourceUpdate

The service resource for patch operations.

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

ServiceResourceUpdateProperties

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.

ServiceTypeDeltaHealthPolicy

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

ServiceTypeHealthPolicy

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

SettingsParameterDescription

Describes a parameter in fabric settings of the cluster.

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

SettingsSectionDescription

Describes a section in the fabric settings of the cluster.

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

SingletonPartitionSchemeDescription

SingletonPartitionSchemeDescription.

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

StatefulServiceProperties

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.

StatefulServiceUpdateProperties

The properties of a stateful service resource for patch operations.

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

StatelessServiceProperties

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.

StatelessServiceUpdateProperties

The properties of a stateless service resource for patch operations.

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

SystemData

Metadata pertaining to creation and last modification of the resource.

UniformInt64RangePartitionSchemeDescription

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.

UpgradableVersionPathResult

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

UpgradableVersionsDescription

UpgradableVersionsDescription.

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

UserAssignedIdentity

UserAssignedIdentity.

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

Enums

AddOnFeatures

Available cluster add-on features

ArmServicePackageActivationMode

The activation Mode of the service package

ArmUpgradeFailureAction

The activation Mode of the service package

ClusterEnvironment

Cluster operating system, the default will be Windows

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

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

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.

Enum14

An enumeration.

ManagedIdentityType

The type of managed identity for the resource.

MoveCost

Specifies the move cost for the service.

NotificationCategory

The category of notification.

NotificationChannel

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

NotificationLevel

The level of notification.

PartitionScheme

Enumerates the ways that a service can be partitioned.

ProvisioningState

The provisioning state of the cluster resource.

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

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

ServiceCorrelationScheme

The service correlation scheme.

ServiceKind

The kind of service (Stateless or Stateful).

ServiceLoadMetricWeight

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.

ServicePlacementPolicyType

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

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.

StoreName

The local certificate store location.

UpgradeMode

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

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.