@azure/arm-servicefabric package

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

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

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.

The application resource.

The list of application resources.

The application resource properties.

The application resource for patch operations.

The application resource properties for patch operations.

The application type name resource

The list of application type names.

An application type version resource for the specified application type name resource.

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

Interface representing a ApplicationTypeVersions.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ApplicationTypes.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Describes the policy for a monitored application upgrade.

Interface representing a Applications.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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

The policy used for monitoring the application upgrade

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

Operation supported by the Service Fabric resource provider

The settings to enable AAD authentication on the cluster.

Describes the certificate details.

Describes the client certificate details using common name.

Describes the client certificate details using thumbprint.

The cluster resource

The list results of the Service Fabric runtime versions.

The result of the Service Fabric runtime versions

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

Cluster list results

Cluster update request

Describes the delta health policies for the cluster upgrade.

Describes the policy used when upgrading the cluster.

The detail of the Service Fabric runtime version result

Interface representing a ClusterVersions.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Clusters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The storage account information for storing Service Fabric diagnostic logs.

Port range details

The structure of the error.

The error details.

Describes the managed identities for an Azure resource.

Describes the named partition scheme of the service.

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

Describes the notification channel for cluster events.

Describes the notification target properties.

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

Available operation list result

Interface representing a Operations.

Optional parameters.

Optional parameters.

Describes how the service is partitioned.

The resource model definition for proxy-only resource.

The resource model definition.

Describes the server certificate details using common name.

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

Creates a particular correlation between services.

Optional parameters.

Specifies a metric to load balance a service during runtime.

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

The service resource.

The list of service resources.

The service resource properties.

The common service resource properties.

The service resource for patch operations.

The service resource properties for patch operations.

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

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

Interface representing a Services.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Describes a parameter in fabric settings of the cluster.

Describes a section in the fabric settings of the cluster.

SingletonPartitionSchemeDescription

The properties of a stateful service resource.

The properties of a stateful service resource for patch operations.

The properties of a stateless service resource.

The properties of a stateless service resource for patch operations.

Metadata pertaining to creation and last modification of the resource.

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

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

Defines values for AddOnFeatures.
KnownAddOnFeatures can be used interchangeably with AddOnFeatures, this enum contains the known values that the service supports.

Known values supported by the service

RepairManager
DnsService
BackupRestoreService
ResourceMonitorService

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for ArmServicePackageActivationMode.
KnownArmServicePackageActivationMode can be used interchangeably with ArmServicePackageActivationMode, this enum contains the known values that the service supports.

Known values supported by the service

SharedProcess: Indicates the application package activation mode will use shared process.
ExclusiveProcess: Indicates the application package activation mode will use exclusive process.

Defines values for ArmUpgradeFailureAction.
KnownArmUpgradeFailureAction can be used interchangeably with ArmUpgradeFailureAction, this enum contains the known values that the service supports.

Known values supported by the service

Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails.
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.

Defines values for ClusterEnvironment.
KnownClusterEnvironment can be used interchangeably with ClusterEnvironment, this enum contains the known values that the service supports.

Known values supported by the service

Windows
Linux

Defines values for ClusterState.
KnownClusterState can be used interchangeably with ClusterState, this enum contains the known values that the service supports.

Known values supported by the service

WaitingForNodes
Deploying
BaselineUpgrade
UpdatingUserConfiguration
UpdatingUserCertificate
UpdatingInfrastructure
EnforcingClusterVersion
UpgradeServiceUnreachable
AutoScale
Ready

Defines values for ClusterUpgradeCadence.
KnownClusterUpgradeCadence can be used interchangeably with ClusterUpgradeCadence, this enum contains the known values that the service supports.

Known values supported by the service

Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters.
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters.
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters.

Defines values for ClusterVersionsEnvironment.
KnownClusterVersionsEnvironment can be used interchangeably with ClusterVersionsEnvironment, this enum contains the known values that the service supports.

Known values supported by the service

Windows
Linux

Contains response data for the getByEnvironment operation.

Contains response data for the get operation.

Contains response data for the listByEnvironment operation.

Contains response data for the list operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the listUpgradableVersions operation.

Contains response data for the update operation.

Defines values for DurabilityLevel.
KnownDurabilityLevel can be used interchangeably with DurabilityLevel, this enum contains the known values that the service supports.

Known values supported by the service

Bronze
Silver
Gold

Defines values for ManagedIdentityType.

Defines values for MoveCost.
KnownMoveCost can be used interchangeably with MoveCost, this enum contains the known values that the service supports.

Known values supported by the service

Zero: Zero move cost. This value is zero.
Low: Specifies the move cost of the service as Low. The value is 1.
Medium: Specifies the move cost of the service as Medium. The value is 2.
High: Specifies the move cost of the service as High. The value is 3.

Defines values for NotificationCategory.
KnownNotificationCategory can be used interchangeably with NotificationCategory, this enum contains the known values that the service supports.

Known values supported by the service

WaveProgress: Notification will be regarding wave progress.

Defines values for NotificationChannel.
KnownNotificationChannel can be used interchangeably with NotificationChannel, this enum contains the known values that the service supports.

Known values supported by the service

EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications.
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.

Defines values for NotificationLevel.
KnownNotificationLevel can be used interchangeably with NotificationLevel, this enum contains the known values that the service supports.

Known values supported by the service

Critical: Receive only critical notifications.
All: Receive all notifications.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for PartitionScheme.
KnownPartitionScheme can be used interchangeably with PartitionScheme, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Updating
Succeeded
Failed
Canceled

Defines values for ReliabilityLevel.
KnownReliabilityLevel can be used interchangeably with ReliabilityLevel, this enum contains the known values that the service supports.

Known values supported by the service

None
Bronze
Silver
Gold
Platinum

Defines values for RollingUpgradeMode.
KnownRollingUpgradeMode can be used interchangeably with RollingUpgradeMode, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. The value is 1
UnmonitoredManual: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3

Defines values for ServiceCorrelationScheme.
KnownServiceCorrelationScheme can be used interchangeably with ServiceCorrelationScheme, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: An invalid correlation scheme. Cannot be used. The value is zero.
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.
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.
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.

Defines values for ServiceKind.
KnownServiceKind can be used interchangeably with ServiceKind, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1.
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.

Defines values for ServiceLoadMetricWeight.
KnownServiceLoadMetricWeight can be used interchangeably with ServiceLoadMetricWeight, this enum contains the known values that the service supports.

Known values supported by the service

Zero: Disables resource balancing for this metric. This value is zero.
Low: Specifies the metric weight of the service load as Low. The value is 1.
Medium: Specifies the metric weight of the service load as Medium. The value is 2.
High: Specifies the metric weight of the service load as High. The value is 3.

Defines values for ServicePlacementPolicyType.
KnownServicePlacementPolicyType can be used interchangeably with ServicePlacementPolicyType, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
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.
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.
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.
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.
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.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for SfZonalUpgradeMode.
KnownSfZonalUpgradeMode can be used interchangeably with SfZonalUpgradeMode, this enum contains the known values that the service supports.

Known values supported by the service

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

Defines values for StoreName.
KnownStoreName can be used interchangeably with StoreName, this enum contains the known values that the service supports.

Known values supported by the service

AddressBook
AuthRoot
CertificateAuthority
Disallowed
My
Root
TrustedPeople
TrustedPublisher

Defines values for UpgradeMode.
KnownUpgradeMode can be used interchangeably with UpgradeMode, this enum contains the known values that the service supports.

Known values supported by the service

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

Defines values for VmssZonalUpgradeMode.
KnownVmssZonalUpgradeMode can be used interchangeably with VmssZonalUpgradeMode, this enum contains the known values that the service supports.

Known values supported by the service

Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets.
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.

Known values of AddOnFeatures that the service accepts.

Known values of ArmServicePackageActivationMode that the service accepts.

Known values of ArmUpgradeFailureAction that the service accepts.

Known values of ClusterEnvironment that the service accepts.

Known values of ClusterState that the service accepts.

Known values of ClusterUpgradeCadence that the service accepts.

Known values of ClusterVersionsEnvironment that the service accepts.

Known values of DurabilityLevel that the service accepts.

Known values of MoveCost that the service accepts.

Known values of NotificationCategory that the service accepts.

Known values of NotificationChannel that the service accepts.

Known values of NotificationLevel that the service accepts.

Known values of PartitionScheme that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of ReliabilityLevel that the service accepts.

Known values of RollingUpgradeMode that the service accepts.

Known values of ServiceCorrelationScheme that the service accepts.

Known values of ServiceKind that the service accepts.

Known values of ServiceLoadMetricWeight that the service accepts.

Known values of ServicePlacementPolicyType that the service accepts.

Known values of SfZonalUpgradeMode that the service accepts.

Known values of StoreName that the service accepts.

Known values of UpgradeMode that the service accepts.

Known values of VmssZonalUpgradeMode that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.