models Package

Classes

AddRemoveIncrementalNamedPartitionScalingMechanism

Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.

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

ApplicationHealthPolicy

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

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

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.

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.

ApplicationTypeUpdateParameters

Application type update 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.

ApplicationTypeVersionUpdateParameters

Application type version update request.

ApplicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3.

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

ApplicationUpdateParameters

Application update request.

ApplicationUpgradePolicy

Describes the policy for a monitored application upgrade.

ApplicationUserAssignedIdentity

ApplicationUserAssignedIdentity.

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

AvailableOperationDisplay

Operation supported by the Service Fabric resource provider.

AveragePartitionLoadScalingTrigger

Represents a scaling trigger related to an average load of a metric/resource of a partition.

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

AverageServiceLoadScalingTrigger

Represents a scaling policy related to an average load of a metric/resource of a service.

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

AzureActiveDirectory

The settings to enable AAD authentication on the cluster.

ClientCertificate

Client certificate definition.

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.

LoadBalancingRule

Describes a load balancing rule.

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

ManagedCluster

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

ManagedClusterCodeVersionResult

The result of the Service Fabric runtime versions.

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

ManagedClusterListResult

Managed Cluster list results.

ManagedClusterUpdateParameters

Managed cluster update request.

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,

~service_fabric_managed_clusters_management_client.models.UserAssignedIdentity]

ManagedProxyResource

The resource model definition for proxy-only resource.

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

NamedPartitionScheme

Describes the named partition scheme of the service.

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

NetworkSecurityRule

Describes a network security rule.

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

NodeType

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

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

NodeTypeActionParameters

Parameters for Node type action.

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

NodeTypeListResult

Node type list results.

NodeTypeUpdateParameters

Node type update request.

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.

Partition

Describes how the service is partitioned.

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

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

PartitionInstanceCountScaleMechanism

Represents a scaling mechanism for adding or removing instances of stateless service partition.

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.

RollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade.

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

ScalingMechanism

Describes the mechanism for performing a scaling operation.

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

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

ScalingPolicy

Specifies a metric to load balance a service during runtime.

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

ScalingTrigger

Describes the trigger for performing a scaling operation.

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

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

ServiceCorrelation

Creates a particular correlation between services.

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

ServiceLoadMetric

Specifies a metric to load balance a service during runtime.

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

ServicePlacementInvalidDomainPolicy

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

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

ServicePlacementNonPartiallyPlaceServicePolicy

ServicePlacementNonPartiallyPlaceServicePolicy.

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

ServicePlacementPolicy

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: ServicePlacementInvalidDomainPolicy, ServicePlacementNonPartiallyPlaceServicePolicy, ServicePlacementPreferPrimaryDomainPolicy, ServicePlacementRequiredDomainPolicy, ServicePlacementRequireDomainDistributionPolicy.

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

ServicePlacementPreferPrimaryDomainPolicy

Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.

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

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

param type: Required. The type of placement policy for a service fabric service. Following are the possible values.Constant filled by server. Possible values include: "InvalidDomain", "RequiredDomain", "PreferredPrimaryDomain", "RequiredDomainDistribution", "NonPartiallyPlaceService".

type type: str or ~service_fabric_managed_clusters_management_client.models.ServicePlacementPolicyType

param domain_name: Required. The name of the domain that should used for placement as per this policy.

type domain_name: str

ServicePlacementRequireDomainDistributionPolicy

Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.

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

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

param type: Required. The type of placement policy for a service fabric service. Following are the possible values.Constant filled by server. Possible values include: "InvalidDomain", "RequiredDomain", "PreferredPrimaryDomain", "RequiredDomainDistribution", "NonPartiallyPlaceService".

type type: str or ~service_fabric_managed_clusters_management_client.models.ServicePlacementPolicyType

param domain_name: Required. The name of the domain that should used for placement as per this policy.

type domain_name: str

ServicePlacementRequiredDomainPolicy

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

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.

ServiceTypeHealthPolicy

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

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

ServiceUpdateParameters

Service update request.

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.

SingletonPartitionScheme

SingletonPartitionScheme.

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

Sku

Service Fabric managed cluster Sku definition.

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.

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.

SubResource

Azure resource identifier.

SystemData

Metadata pertaining to creation and last modification of the resource.

UniformInt64RangePartitionScheme

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.

UserAssignedIdentity

UserAssignedIdentity.

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

VMSSExtension

Specifies set of extensions that should be installed onto the virtual machines.

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.

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

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

VaultSecretGroup

Specifies set of certificates that should be installed onto the virtual machines.

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

VmManagedIdentity

Identities for the virtual machine scale set under the node type.

Enums

Access

The network traffic is allowed or denied.

ClusterState

The current state of the cluster.

ClusterUpgradeCadence

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

ClusterUpgradeMode

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

Direction

Network security rule direction.

DiskType

Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types.

FailureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.

ManagedClusterAddOnFeature

Available cluster add-on features

ManagedIdentityType

The type of managed identity for the resource.

ManagedResourceProvisioningState

The provisioning state of the managed resource.

MoveCost

Specifies the move cost for the service.

NsgProtocol

Network protocol this rule applies to.

PartitionScheme

Enumerates the ways that a service can be partitioned.

ProbeProtocol

the reference to the load balancer probe used by the load balancing rule.

Protocol

The reference to the transport protocol used by the load balancing rule.

RollingUpgradeMode

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

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.

ServicePackageActivationMode

The activation Mode of the service package

ServicePlacementPolicyType

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

ServiceScalingMechanismKind

Enumerates the ways that a service can be partitioned.

ServiceScalingTriggerKind

Enumerates the ways that a service can be partitioned.

SkuName

Sku Name.