Partager via


models Package

Classes

AadMetadata

Azure Active Directory metadata used for secured connection to cluster.

AadMetadataObject

Azure Active Directory metadata object used for secured connection to cluster.

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.

AddRemoveReplicaScalingMechanism

Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).

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

AnalysisEventMetadata

Metadata about an Analysis Event.

ApplicationBackupConfigurationInfo

Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.

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

ApplicationBackupEntity

Identifies the Service Fabric application which is being backed up.

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

ApplicationCapacityDescription

Describes capacity information for services of this application. This description can be used for describing the following.

  • Reserving the capacity for the services on the nodes
  • Limiting the total number of nodes that services of this application can run on
  • Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application.
ApplicationContainerInstanceExitedEvent

Container Exited event.

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

ApplicationCreatedEvent

Application Created event.

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

ApplicationDeletedEvent

Application Deleted event.

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

ApplicationDescription

Describes a Service Fabric application.

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

ApplicationEvent

Represents the base for all Application Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationCreatedEvent, ApplicationDeletedEvent, ApplicationNewHealthReportEvent, ApplicationHealthReportExpiredEvent, ApplicationUpgradeCompletedEvent, ApplicationUpgradeDomainCompletedEvent, ApplicationUpgradeRollbackCompletedEvent, ApplicationUpgradeRollbackStartedEvent, ApplicationUpgradeStartedEvent, DeployedApplicationNewHealthReportEvent, DeployedApplicationHealthReportExpiredEvent, ApplicationProcessExitedEvent, ApplicationContainerInstanceExitedEvent, DeployedServicePackageNewHealthReportEvent, DeployedServicePackageHealthReportExpiredEvent, ChaosCodePackageRestartScheduledEvent

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

ApplicationHealth

Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.

ApplicationHealthEvaluation

Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.

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

ApplicationHealthPolicies

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

ApplicationHealthPolicy

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

ApplicationHealthPolicyMapItem

Defines an item in ApplicationHealthPolicyMap.

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

ApplicationHealthPolicyMapObject

Represents the map of application health policies for a ServiceFabric cluster upgrade.

ApplicationHealthReportExpiredEvent

Application Health Report Expired event.

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

ApplicationHealthState

Represents the health state of an application, which contains the application identifier and the aggregated health state.

ApplicationHealthStateChunk

Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.

ApplicationHealthStateChunkList

The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

ApplicationHealthStateFilter

Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties.

ApplicationInfo

Information about a Service Fabric application.

ApplicationLoadInfo

Load Information about a Service Fabric application.

ApplicationLoadMetricInformation

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

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.

ApplicationNameInfo

Information about the application name.

ApplicationNewHealthReportEvent

Application Health Report Created event.

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

ApplicationParameter

Describes an application parameter override to be applied when creating or upgrading an application.

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

ApplicationProcessExitedEvent

Process Exited event.

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

ApplicationResourceDescription

This type describes a application 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.

ApplicationResourceUpgradeProgressInfo

This type describes an application resource upgrade.

ApplicationScopedVolume

Describes a volume whose lifetime is scoped to the application's lifetime.

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

ApplicationScopedVolumeCreationParameters

Describes parameters for creating application-scoped volumes.

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

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

ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk

Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks.

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

ApplicationTypeApplicationsHealthEvaluation

Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.

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

ApplicationTypeHealthPolicyMapItem

Defines an item in ApplicationTypeHealthPolicyMap.

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

ApplicationTypeImageStorePath

Path description for the application package in the image store specified during the prior copy operation.

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

ApplicationTypeInfo

Information about an application type.

ApplicationTypeManifest

Contains the manifest describing an application type registered in a Service Fabric cluster.

ApplicationUpdateDescription

Describes the parameters for updating an application instance.

ApplicationUpgradeCompletedEvent

Application Upgrade Completed event.

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

ApplicationUpgradeDescription

Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

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

ApplicationUpgradeDomainCompletedEvent

Application Upgrade Domain Completed event.

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

ApplicationUpgradeProgressInfo

Describes the parameters for an application upgrade.

ApplicationUpgradeRollbackCompletedEvent

Application Upgrade Rollback Completed event.

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

ApplicationUpgradeRollbackStartedEvent

Application Upgrade Rollback Started event.

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

ApplicationUpgradeStartedEvent

Application Upgrade Started event.

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

ApplicationUpgradeUpdateDescription

Describes the parameters for updating an ongoing application upgrade.

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

ApplicationsHealthEvaluation

Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.

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

AutoScalingMechanism

Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.

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

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

AutoScalingMetric

Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.

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

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

AutoScalingPolicy

Describes the auto scaling policy.

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

AutoScalingResourceMetric

Describes the resource that is used for triggering auto scaling.

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

AutoScalingTrigger

Describes the trigger for performing auto scaling operation.

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

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

AverageLoadScalingTrigger

Describes the average load trigger used for auto scaling.

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

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.

AzureBlobBackupStorageDescription

Describes the parameters for Azure blob store used for storing and enumerating backups.

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

AzureInternalMonitoringPipelineSinkDescription

Diagnostics settings for Geneva.

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

BackupConfigurationInfo

Describes the backup configuration information.

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

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

BackupEntity

Describes the Service Fabric entity that is configured for backup.

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

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

BackupInfo

Represents a backup point which can be used to trigger a restore.

BackupPartitionDescription

Describes the parameters for triggering partition's backup.

BackupPolicyDescription

Describes a backup policy for configuring periodic backup.

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

BackupProgressInfo

Describes the progress of a partition's backup.

BackupScheduleDescription

Describes the backup schedule parameters.

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

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

BackupStorageDescription

Describes the parameters for the backup storage.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobBackupStorageDescription, FileShareBackupStorageDescription, DsmsAzureBlobBackupStorageDescription, ManagedIdentityAzureBlobBackupStorageDescription

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

BackupSuspensionInfo

Describes the backup suspension details.

BasicRetentionPolicyDescription

Describes basic retention policy.

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

BinaryPropertyValue

Describes a Service Fabric property value of type Binary.

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

Chaos

Contains a description of Chaos.

ChaosCodePackageRestartScheduledEvent

Chaos Restart Code Package Fault Scheduled event.

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

ChaosContext

Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.

ChaosEvent

Represents an event generated during a Chaos run.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExecutingFaultsChaosEvent, StartedChaosEvent, StoppedChaosEvent, TestErrorChaosEvent, ValidationFailedChaosEvent, WaitingChaosEvent

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

ChaosEventWrapper

Wrapper object for Chaos event.

ChaosEventsSegment

Contains the list of Chaos events and the continuation token to get the next segment.

ChaosNodeRestartScheduledEvent

Chaos Restart Node Fault Scheduled event.

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

ChaosParameters

Defines all the parameters to configure a Chaos run.

ChaosParametersDictionaryItem

Defines an item in ChaosParametersDictionary of the Chaos Schedule.

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

ChaosPartitionPrimaryMoveScheduledEvent

Chaos Move Primary Fault Scheduled event.

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

ChaosPartitionSecondaryMoveScheduledEvent

Chaos Move Secondary Fault Scheduled event.

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

ChaosReplicaRemovalScheduledEvent

Chaos Remove Replica Fault Scheduled event.

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

ChaosReplicaRestartScheduledEvent

Chaos Restart Replica Fault Scheduled event.

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

ChaosSchedule

Defines the schedule used by Chaos.

ChaosScheduleDescription

Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.

ChaosScheduleJob

Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.

ChaosScheduleJobActiveDaysOfWeek

Defines the days of the week that a Chaos Schedule Job will run for.

ChaosStartedEvent

Chaos Started event.

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

ChaosStoppedEvent

Chaos Stopped event.

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

ChaosTargetFilter

Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection of NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify "fault this application only when it is on that node type." Once an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if applicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included in NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.

CheckExistsPropertyBatchOperation

Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument. The PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument. The CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

CheckSequencePropertyBatchOperation

Compares the Sequence Number of a property with the SequenceNumber argument. A property's sequence number can be thought of as that property's version. Every time the property is modified, its sequence number is increased. The sequence number can be found in a property's metadata. The comparison fails if the sequence numbers are not equal. CheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

CheckValuePropertyBatchOperation

Represents a PropertyBatchOperation that compares the value of the property with the expected value. The CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

ClusterConfiguration

Information about the standalone cluster configuration.

ClusterConfigurationUpgradeDescription

Describes the parameters for a standalone cluster configuration upgrade.

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

ClusterConfigurationUpgradeStatusInfo

Information about a standalone cluster configuration upgrade status.

ClusterEvent

Represents the base for all Cluster Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterNewHealthReportEvent, ClusterHealthReportExpiredEvent, ClusterUpgradeCompletedEvent, ClusterUpgradeDomainCompletedEvent, ClusterUpgradeRollbackCompletedEvent, ClusterUpgradeRollbackStartedEvent, ClusterUpgradeStartedEvent, ChaosStoppedEvent, ChaosStartedEvent

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

ClusterHealth

Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.

ClusterHealthChunk

Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.

ClusterHealthChunkQueryDescription

The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.

ClusterHealthPolicies

Health policies to evaluate cluster health.

ClusterHealthPolicy

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

ClusterHealthReportExpiredEvent

Cluster Health Report Expired event.

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

ClusterLoadInfo

Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.

ClusterManifest

Information about the cluster manifest.

ClusterNewHealthReportEvent

Cluster Health Report Created event.

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

ClusterUpgradeCompletedEvent

Cluster Upgrade Completed event.

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

ClusterUpgradeDescriptionObject

Represents a ServiceFabric cluster upgrade.

ClusterUpgradeDomainCompletedEvent

Cluster Upgrade Domain Completed event.

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

ClusterUpgradeHealthPolicyObject

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

ClusterUpgradeProgressObject

Information about a cluster upgrade.

ClusterUpgradeRollbackCompletedEvent

Cluster Upgrade Rollback Completed event.

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

ClusterUpgradeRollbackStartedEvent

Cluster Upgrade Rollback Started event.

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

ClusterUpgradeStartedEvent

Cluster Upgrade Started event.

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

ClusterVersion

The cluster version.

CodePackageEntryPoint

Information about setup or main entry point of a code package deployed on a Service Fabric node.

CodePackageEntryPointStatistics

Statistics about setup or main entry point of a code package deployed on a Service Fabric node.

ComposeDeploymentStatusInfo

Information about a Service Fabric compose deployment.

ComposeDeploymentUpgradeDescription

Describes the parameters for a compose deployment upgrade.

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

ComposeDeploymentUpgradeProgressInfo

Describes the parameters for a compose deployment upgrade.

ConfigParameterOverride

Information about a configuration parameter override.

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

ContainerApiRequestBody

parameters for making container API call.

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

ContainerApiResponse

Response body that wraps container API result.

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

ContainerApiResult

Container API result.

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

ContainerCodePackageProperties

Describes a container and its runtime properties.

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.

ContainerEvent

A container event.

ContainerInstanceEvent

Represents the base for all Container Events.

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

ContainerInstanceView

Runtime information of a container instance.

ContainerLabel

Describes a container label.

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

ContainerLogs

Container logs.

ContainerState

The container state.

CreateComposeDeploymentDescription

Defines description for creating a Service Fabric compose deployment.

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

CurrentUpgradeDomainProgressInfo

Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.

CurrentUpgradeUnitsProgressInfo

Information about the current in-progress upgrade units.

DeactivationIntentDescription

Describes the intent or reason for deactivating the node.

DefaultExecutionPolicy

The default execution policy. Always restart the service if an exit occurs.

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

DeletePropertyBatchOperation

Represents a PropertyBatchOperation that deletes a specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

DeltaNodesCheckHealthEvaluation

Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.

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

DeployServicePackageToNodeDescription

Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.

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

DeployedApplicationHealth

Information about the health of an application deployed on a Service Fabric node.

DeployedApplicationHealthEvaluation

Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.

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

DeployedApplicationHealthReportExpiredEvent

Deployed Application Health Report Expired event.

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

DeployedApplicationHealthState

Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.

DeployedApplicationHealthStateChunk

Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.

DeployedApplicationHealthStateChunkList

The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

DeployedApplicationHealthStateFilter

Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties.

DeployedApplicationInfo

Information about application deployed on the node.

DeployedApplicationNewHealthReportEvent

Deployed Application Health Report Created event.

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

DeployedApplicationsHealthEvaluation

Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

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

DeployedCodePackageInfo

Information about code package deployed on a Service Fabric node.

DeployedServicePackageHealth

Information about the health of a service package for a specific application deployed on a Service Fabric node.

DeployedServicePackageHealthEvaluation

Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

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

DeployedServicePackageHealthReportExpiredEvent

Deployed Service Health Report Expired event.

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

DeployedServicePackageHealthState

Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.

DeployedServicePackageHealthStateChunk

Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.

DeployedServicePackageHealthStateChunkList

The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

DeployedServicePackageHealthStateFilter

Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties.

DeployedServicePackageInfo

Information about service package deployed on a Service Fabric node.

DeployedServicePackageNewHealthReportEvent

Deployed Service Health Report Created event.

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

DeployedServicePackagesHealthEvaluation

Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.

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

DeployedServiceReplicaDetailInfo

Information about a Service Fabric service replica deployed on a node.

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

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

DeployedServiceReplicaInfo

Information about a Service Fabric service replica deployed on a node.

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

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

DeployedServiceTypeInfo

Information about service type deployed on a node, information such as the status of the service type registration on a node.

DeployedStatefulServiceReplicaDetailInfo

Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.

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

DeployedStatefulServiceReplicaInfo

Information about a stateful service replica deployed on a node.

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

DeployedStatelessServiceInstanceDetailInfo

Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.

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

DeployedStatelessServiceInstanceInfo

Information about a stateless service instance deployed on a node.

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

DiagnosticsDescription

Describes the diagnostics options available.

DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

DiagnosticsSinkProperties

Properties of a DiagnosticsSink.

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

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

DisableBackupDescription

It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).

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

DiskInfo

Information about the disk.

DoublePropertyValue

Describes a Service Fabric property value of type Double.

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

DsmsAzureBlobBackupStorageDescription

Describes the parameters for Dsms Azure blob store used for storing and enumerating backups.

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

EnableBackupDescription

Specifies the parameters needed to enable periodic backup.

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

EndpointProperties

Describes a container endpoint.

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

EndpointRef

Describes a reference to a service endpoint.

EnsureAvailabilitySafetyCheck

Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.

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

EnsurePartitionQuorumSafetyCheck

Safety check that ensures that a quorum of replicas are not lost for a partition.

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

EntityHealth

Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.

EntityHealthState

A base type for the health state of various entities in the cluster. It contains the aggregated health state.

EntityHealthStateChunk

A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.

EntityHealthStateChunkList

A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.

EntityKindHealthStateCount

Represents health state count for entities of the specified entity kind.

EnvironmentVariable

Describes an environment variable for the container.

Epoch

An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.

EventHealthEvaluation

Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning.

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

ExecutingFaultsChaosEvent

Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.

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

ExecutionPolicy

The execution policy of the service.

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

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

ExternalStoreProvisionApplicationTypeDescription

Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.

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

FabricCodeVersionInfo

Information about a Service Fabric code version.

FabricConfigVersionInfo

Information about a Service Fabric config version.

FabricError

The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.

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

FabricErrorError

Error object containing error code and error message.

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

FabricErrorException

Server responsed with exception of type: 'FabricError'.

FabricEvent

Represents the base for all Fabric Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationEvent, ClusterEvent, ContainerInstanceEvent, NodeEvent, PartitionEvent, ReplicaEvent, ServiceEvent

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

FailedPropertyBatchInfo

Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.

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

FailedUpgradeDomainProgressObject

The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.

FailureUpgradeDomainProgressInfo

Information about the upgrade domain progress at the time of upgrade failure.

FileInfo

Information about a image store file.

FileShareBackupStorageDescription

Describes the parameters for file share storage used for storing or enumerating backups.

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

FileVersion

Information about the version of image store file.

FolderInfo

Information about a image store folder. It includes how many files this folder contains and its image store relative path.

FolderSizeInfo

Information of a image store folder size.

FrequencyBasedBackupScheduleDescription

Describes the frequency based backup schedule.

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

GatewayDestination

Describes destination endpoint for routing traffic.

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

GatewayResourceDescription

This type describes a gateway 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.

GetBackupByStorageQueryDescription

Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.

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

GetPropertyBatchOperation

Represents a PropertyBatchOperation that gets the specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

GuidPropertyValue

Describes a Service Fabric property value of type Guid.

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

HealthEvaluation

Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationHealthEvaluation, ApplicationsHealthEvaluation, ApplicationTypeApplicationsHealthEvaluation, DeltaNodesCheckHealthEvaluation, DeployedApplicationHealthEvaluation, DeployedApplicationsHealthEvaluation, DeployedServicePackageHealthEvaluation, DeployedServicePackagesHealthEvaluation, EventHealthEvaluation, NodeHealthEvaluation, NodesHealthEvaluation, PartitionHealthEvaluation, PartitionsHealthEvaluation, ReplicaHealthEvaluation, ReplicasHealthEvaluation, ServiceHealthEvaluation, ServicesHealthEvaluation, SystemApplicationHealthEvaluation, UpgradeDomainDeltaNodesCheckHealthEvaluation, UpgradeDomainDeployedApplicationsHealthEvaluation, UpgradeDomainNodesHealthEvaluation, NodeTypeNodesHealthEvaluation

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

HealthEvaluationWrapper

Wrapper object for health evaluation.

HealthEvent

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.

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

HealthInformation

Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.

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

HealthStateCount

Represents information about how many health entities are in Ok, Warning and Error health state.

HealthStatistics

The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.

HttpConfig

Describes the http configuration for external connectivity for this network.

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

HttpHostConfig

Describes the hostname properties for http routing.

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

HttpRouteConfig

Describes the hostname properties for http routing.

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

HttpRouteMatchHeader

Describes header information for http route matching.

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

HttpRouteMatchPath

Path to match for routing.

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.

HttpRouteMatchRule

Describes a rule for http route matching.

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

IdentityDescription

Information describing the identities associated with this application.

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

IdentityItemDescription

Describes a single user-assigned identity associated with the application.

ImageRegistryCredential

Image registry credential.

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

ImageStoreContent

Information about the image store content.

ImageStoreCopyDescription

Information about how to copy image store content from one image store relative path to another image store relative path.

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

ImageStoreInfo

Information about the ImageStore's resource usage.

InlinedValueSecretResourceProperties

Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.

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.

InstanceLifecycleDescription

Describes how the instance will behave.

Int64PropertyValue

Describes a Service Fabric property value of type Int64.

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

Int64RangePartitionInformation

Describes the partition information for the integer range that is based on partition schemes.

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

InvokeDataLossResult

Represents information about an operation in a terminal state (Completed or Faulted).

InvokeQuorumLossResult

Represents information about an operation in a terminal state (Completed or Faulted).

KeyValueStoreReplicaStatus

Key value store related information for the replica.

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

LoadMetricInformation

Represents data structure that contains load information for a certain metric in a cluster.

LoadMetricReport

Represents the load metric report which contains the time metric was reported, its name and value.

LoadMetricReportInfo

Information about load reported by replica.

LoadedPartitionInformationQueryDescription

Represents data structure that contains query information.

LoadedPartitionInformationResult

Represents partition information.

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

LoadedPartitionInformationResultList

Represents data structure that contains top/least loaded partitions for a certain metric.

LocalNetworkResourceProperties

Information about a Service Fabric container network local to a single Service Fabric cluster.

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.

ManagedApplicationIdentity

Describes a managed application identity.

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

ManagedApplicationIdentityDescription

Managed application identity description.

ManagedIdentityAzureBlobBackupStorageDescription

Describes the parameters for Azure blob store (connected using managed identity) used for storing and enumerating backups.

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

MetricLoadDescription

Specifies metric load information.

MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

NameDescription

Describes a Service Fabric name.

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

NamedPartitionInformation

Describes the partition information for the name as a string that is based on partition schemes.

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

NamedPartitionSchemeDescription

Describes the named partition scheme of the service.

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

NetworkRef

Describes a network reference in a service.

NetworkResourceDescription

This type describes a network resource.

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

NetworkResourceProperties

Describes properties of a network resource.

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

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.

NetworkResourcePropertiesBase

This type describes the properties of a network resource, including its kind.

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

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

NodeAbortedEvent

Node Aborted event.

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

NodeAddedToClusterEvent

Node Added event.

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

NodeClosedEvent

Node Closed event.

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

NodeDeactivateCompletedEvent

Node Deactivate Completed event.

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

NodeDeactivateStartedEvent

Node Deactivate Started event.

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

NodeDeactivationInfo

Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.

NodeDeactivationTask

The task representing the deactivation operation on the node.

NodeDeactivationTaskId

Identity of the task related to deactivation operation on the node.

NodeDownEvent

Node Down event.

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

NodeEvent

Represents the base for all Node Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: NodeAbortedEvent, NodeAddedToClusterEvent, NodeClosedEvent, NodeDeactivateCompletedEvent, NodeDeactivateStartedEvent, NodeDownEvent, NodeNewHealthReportEvent, NodeHealthReportExpiredEvent, NodeOpenSucceededEvent, NodeOpenFailedEvent, NodeRemovedFromClusterEvent, NodeUpEvent, ChaosNodeRestartScheduledEvent

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

NodeHealth

Information about the health of a Service Fabric node.

NodeHealthEvaluation

Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

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

NodeHealthReportExpiredEvent

Node Health Report Expired event.

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

NodeHealthState

Represents the health state of a node, which contains the node identifier and its aggregated health state.

NodeHealthStateChunk

Represents the health state chunk of a node, which contains the node name and its aggregated health state.

NodeHealthStateChunkList

The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

NodeHealthStateFilter

Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description.

NodeId

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

NodeImpact

Describes the expected impact of a repair to a particular node. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

NodeInfo

Information about a node in Service Fabric cluster.

NodeLoadInfo

Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.

NodeLoadMetricInformation

Represents data structure that contains load information for a certain metric on a node.

NodeNewHealthReportEvent

Node Health Report Created event.

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

NodeOpenFailedEvent

Node Open Failed event.

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

NodeOpenSucceededEvent

Node Opened Succeeded event.

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

NodeRemovedFromClusterEvent

Node Removed event.

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

NodeRepairImpactDescription

Describes the expected impact of a repair on a set of nodes. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

NodeRepairTargetDescription

Describes the list of nodes targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

NodeResult

Contains information about a node that was targeted by a user-induced operation.

NodeTagsDescription

Describes the tags required for placement or running of the service.

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

NodeTransitionProgress

Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted.

NodeTransitionResult

Represents information about an operation in a terminal state (Completed or Faulted).

NodeTypeHealthPolicyMapItem

Defines an item in NodeTypeHealthPolicyMap.

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

NodeTypeNodesHealthEvaluation

Represents health evaluation for nodes of a particular node type. The node type nodes evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy node of the included node type that impacted current aggregated health state.

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

NodeUpEvent

Node Up event.

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

NodeUpgradeProgressInfo

Information about the upgrading node and its status.

NodesHealthEvaluation

Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.

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

OperationStatus

Contains the OperationId, OperationState, and OperationType for user-induced operations.

PackageSharingPolicyInfo

Represents a policy for the package sharing.

PagedApplicationInfoList

The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedApplicationResourceDescriptionList

The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedApplicationTypeInfoList

The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedBackupConfigurationInfoList

The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedBackupEntityList

The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedBackupInfoList

The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedBackupPolicyDescriptionList

The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedComposeDeploymentStatusInfoList

The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedDeployedApplicationInfoList

The list of deployed applications in activating, downloading, or active states on a node. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedGatewayResourceDescriptionList

The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedNetworkResourceDescriptionList

The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedNodeInfoList

The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedPropertyInfoList

The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedReplicaInfoList

The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedSecretResourceDescriptionList

The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedSecretValueResourceDescriptionList

The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.

PagedServiceInfoList

The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedServicePartitionInfoList

The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedServiceReplicaDescriptionList

The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedServiceResourceDescriptionList

The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedSubNameInfoList

A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedUpdatePartitionLoadResultList

The list of results of the call UpdatePartitionLoad. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PagedVolumeResourceDescriptionList

The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

PartitionAnalysisEvent

Represents the base for all Partition Analysis Events.

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

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

PartitionBackupConfigurationInfo

Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.

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

PartitionBackupEntity

Identifies the Service Fabric stateful partition which is being backed up.

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

PartitionDataLossProgress

Information about a partition data loss user-induced operation.

PartitionEvent

Represents the base for all Partition Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: PartitionAnalysisEvent, PartitionNewHealthReportEvent, PartitionHealthReportExpiredEvent, PartitionReconfiguredEvent, ChaosPartitionSecondaryMoveScheduledEvent, ChaosPartitionPrimaryMoveScheduledEvent

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

PartitionHealth

Information about the health of a Service Fabric partition.

PartitionHealthEvaluation

Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

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

PartitionHealthReportExpiredEvent

Partition Health Report Expired event.

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

PartitionHealthState

Represents the health state of a partition, which contains the partition identifier and its aggregated health state.

PartitionHealthStateChunk

Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.

PartitionHealthStateChunkList

The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy.

PartitionHealthStateFilter

Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties.

PartitionInformation

Information about the partition identity, partitioning scheme and keys supported by it.

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

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.

PartitionLoadInformation

Represents load information for a partition, which contains the primary, secondary and auxiliary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport's LastReportedUtc is set to 0.

PartitionMetricLoadDescription

Represents load information for a partition, which contains the metrics load information about primary, all secondary replicas/instances or a specific secondary replica/instance on a specific node , all auxiliary replicas or a specific auxiliary replica on a specific node.

PartitionNewHealthReportEvent

Partition Health Report Created event.

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

PartitionPrimaryMoveAnalysisEvent

Partition Primary Move Analysis event.

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

PartitionQuorumLossProgress

Information about a partition quorum loss user-induced operation.

PartitionReconfiguredEvent

Partition Reconfiguration event.

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

PartitionRestartProgress

Information about a partition restart user-induced operation.

PartitionSafetyCheck

Represents a safety check for the service partition being performed by service fabric before continuing with operations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EnsureAvailabilitySafetyCheck, EnsurePartitionQuorumSafetyCheck, WaitForInbuildReplicaSafetyCheck, WaitForPrimaryPlacementSafetyCheck, WaitForPrimarySwapSafetyCheck, WaitForReconfigurationSafetyCheck

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

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.

PartitionsHealthEvaluation

Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.

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

PrimaryReplicatorStatus

Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.

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

Probe

Probes have a number of fields that you can use to control their behavior.

ProbeExec

Exec command to run inside the container.

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

ProbeHttpGet

Http probe for the container.

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

ProbeHttpGetHeaders

Http headers.

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

ProbeTcpSocket

Tcp port to probe inside the container.

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

PropertyBatchDescriptionList

Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.

PropertyBatchInfo

Information about the results of a property batch.

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

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

PropertyBatchOperation

Represents the base type for property operations that can be put into a batch and submitted.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CheckExistsPropertyBatchOperation, CheckSequencePropertyBatchOperation, CheckValuePropertyBatchOperation, DeletePropertyBatchOperation, GetPropertyBatchOperation, PutPropertyBatchOperation

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

PropertyDescription

Description of a Service Fabric property.

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

PropertyInfo

Information about a Service Fabric property.

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

PropertyMetadata

The metadata associated with a property, including the property's name.

PropertyValue

Describes a Service Fabric property value.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BinaryPropertyValue, Int64PropertyValue, DoublePropertyValue, StringPropertyValue, GuidPropertyValue

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

ProvisionApplicationTypeDescription

Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.

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

ProvisionApplicationTypeDescriptionBase

Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.

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

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

ProvisionFabricDescription

Describes the parameters for provisioning a cluster.

PutPropertyBatchOperation

Puts the specified property under the specified name. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

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

ReconfigurationInformation

Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.

RegistryCredential

Credential information to connect to container registry.

ReliableCollectionsRef

Specifying this parameter adds support for reliable collections.

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

RemoteReplicatorAcknowledgementDetail

Provides various statistics of the acknowledgements that are being received from the remote replicator.

RemoteReplicatorAcknowledgementStatus

Provides details about the remote replicators from the primary replicator's point of view.

RemoteReplicatorStatus

Represents the state of the secondary replicator from the primary replicator's point of view.

RepairImpactDescriptionBase

Describes the expected impact of executing a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

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

RepairTargetDescriptionBase

Describes the entities targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

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

RepairTask

Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

RepairTaskApproveDescription

Describes a request for forced approval of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

RepairTaskCancelDescription

Describes a request to cancel a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

RepairTaskDeleteDescription

Describes a request to delete a completed repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

RepairTaskHistory

A record of the times when the repair task entered each state. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

RepairTaskUpdateHealthPolicyDescription

Describes a request to update the health policy of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

RepairTaskUpdateInfo

Describes the result of an operation that created or updated a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

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

ReplicaEvent

Represents the base for all Replica Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulReplicaNewHealthReportEvent, StatefulReplicaHealthReportExpiredEvent, StatelessReplicaNewHealthReportEvent, StatelessReplicaHealthReportExpiredEvent, ChaosReplicaRemovalScheduledEvent, ChaosReplicaRestartScheduledEvent

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

ReplicaHealth

Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations.

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

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

ReplicaHealthEvaluation

Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

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

ReplicaHealthState

Represents a base class for stateful service replica or stateless service instance health state.

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

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

ReplicaHealthStateChunk

Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state.

ReplicaHealthStateChunkList

The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

ReplicaHealthStateFilter

Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties.

ReplicaInfo

Information about the identity, status, health, node name, uptime, and other details about the replica.

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

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

ReplicaLifecycleDescription

Describes how the replica will behave.

ReplicaMetricLoadDescription

Specifies metric loads of a partition's specific secondary replica or instance.

ReplicaStatusBase

Information about the replica.

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

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

ReplicasHealthEvaluation

Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.

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

ReplicatorQueueStatus

Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings.

ReplicatorStatus

Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.

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

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

ResolvedServiceEndpoint

Endpoint of a resolved service partition.

ResolvedServicePartition

Information about a service partition and its associated endpoints.

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

ResourceLimits

This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.

ResourceRequests

This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.

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

ResourceRequirements

This type describes the resource requirements for a container or a service.

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

RestartDeployedCodePackageDescription

Defines description for restarting a deployed code package on Service Fabric node.

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

RestartNodeDescription

Describes the parameters to restart a Service Fabric node.

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

RestartPartitionResult

Represents information about an operation in a terminal state (Completed or Faulted).

RestorePartitionDescription

Specifies the parameters needed to trigger a restore of a specific partition.

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

RestoreProgressInfo

Describes the progress of a restore operation on a partition.

ResumeApplicationUpgradeDescription

Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade.

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

ResumeClusterUpgradeDescription

Describes the parameters for resuming a cluster upgrade.

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

RetentionPolicyDescription

Describes the retention policy configured.

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

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

RollingUpgradeUpdateDescription

Describes the parameters for updating a rolling upgrade of application or cluster.

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

RunToCompletionExecutionPolicy

The run to completion execution policy, the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again.

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

SafetyCheck

Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.

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

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

SafetyCheckWrapper

A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.

ScalingMechanismDescription

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: PartitionInstanceCountScaleMechanism, AddRemoveIncrementalNamedPartitionScalingMechanism

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

ScalingPolicyDescription

Describes how the scaling should be performed.

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

ScalingTriggerDescription

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.

SecondaryActiveReplicatorStatus

Status of the secondary replicator when it is in active mode and is part of the replica set.

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

SecondaryIdleReplicatorStatus

Status of the secondary replicator when it is in idle mode and is being built by the primary.

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

SecondaryReplicatorStatus

Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.

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

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

SecretResourceDescription

This type describes a secret resource.

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

SecretResourceProperties

Describes the properties of a secret resource.

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

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.

SecretResourcePropertiesBase

This type describes the properties of a secret resource, including its kind.

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

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

SecretValue

This type represents the unencrypted value of the secret.

SecretValueProperties

This type describes properties of secret value resource.

SecretValueResourceDescription

This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.

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

SeedNodeSafetyCheck

Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.

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

SelectedPartition

This class returns information about the partition that the user-induced operation acted upon.

ServiceBackupConfigurationInfo

Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.

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

ServiceBackupEntity

Identifies the Service Fabric stateful service which is being backed up.

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

ServiceCorrelationDescription

Creates a particular correlation between services.

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

ServiceCreatedEvent

Service Created event.

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

ServiceDeletedEvent

Service Deleted event.

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

ServiceDescription

A ServiceDescription contains all of the information necessary to create a service.

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

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

ServiceEvent

Represents the base for all Service Events.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServiceCreatedEvent, ServiceDeletedEvent, ServiceNewHealthReportEvent, ServiceHealthReportExpiredEvent

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

ServiceFromTemplateDescription

Defines description for creating a Service Fabric service from a template defined in the application manifest.

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

ServiceHealth

Information about the health of a Service Fabric service.

ServiceHealthEvaluation

Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

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

ServiceHealthReportExpiredEvent

Service Health Report Expired event.

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

ServiceHealthState

Represents the health state of a service, which contains the service identifier and its aggregated health state.

ServiceHealthStateChunk

Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.

ServiceHealthStateChunkList

The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

ServiceHealthStateFilter

Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties.

ServiceIdentity

Map service identity friendly name to an application identity.

ServiceInfo

Information about a Service Fabric service.

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

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.

ServiceNameInfo

Information about the service name.

ServiceNewHealthReportEvent

Service Health Report Created event.

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

ServicePartitionInfo

Information about a partition of a Service Fabric service.

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

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

ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription

Describes the policy to be used for placement of a Service Fabric service allowing multiple stateless instances of a partition of the service to be placed on a node.

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

ServicePlacementInvalidDomainPolicyDescription

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.

ServicePlacementNonPartiallyPlaceServicePolicyDescription

Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.

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: ServicePlacementInvalidDomainPolicyDescription, ServicePlacementNonPartiallyPlaceServicePolicyDescription, ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription, ServicePlacementPreferPrimaryDomainPolicyDescription, ServicePlacementRequiredDomainPolicyDescription, ServicePlacementRequireDomainDistributionPolicyDescription

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

ServicePlacementPreferPrimaryDomainPolicyDescription

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.

ServicePlacementRequireDomainDistributionPolicyDescription

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.

ServicePlacementRequiredDomainPolicyDescription

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.

ServiceProperties

Describes properties of a service resource.

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

ServiceReplicaDescription

Describes a replica of a service resource.

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

ServiceReplicaProperties

Describes the properties of a service replica.

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

ServiceResourceDescription

This type describes a 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.

ServiceTypeDescription

Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.

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

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

ServiceTypeExtensionDescription

Describes extension of a service type defined in the service manifest.

ServiceTypeHealthPolicy

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

ServiceTypeHealthPolicyMapItem

Defines an item in ServiceTypeHealthPolicyMap.

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

ServiceTypeInfo

Information about a service type that is defined in a service manifest of a provisioned application type.

ServiceTypeManifest

Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.

ServiceUpdateDescription

A ServiceUpdateDescription contains all of the information necessary to update a service.

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

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

ServiceUpgradeProgress

Information about how many replicas are completed or pending for a specific service during upgrade.

ServicesHealthEvaluation

Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

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

Setting

Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:secrets". The path for Linux container is "/var/secrets".

SingletonPartitionInformation

Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.

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

SingletonPartitionSchemeDescription

Describes the partition scheme of a singleton-partitioned, or non-partitioned service.

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

StartClusterUpgradeDescription

Describes the parameters for starting a cluster upgrade.

StartedChaosEvent

Describes a Chaos event that gets generated when Chaos is started.

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

StatefulReplicaHealthReportExpiredEvent

Stateful Replica Health Report Expired event.

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

StatefulReplicaNewHealthReportEvent

Stateful Replica Health Report Created event.

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

StatefulServiceDescription

Describes a stateful service.

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

StatefulServiceInfo

Information about a stateful Service Fabric service.

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

StatefulServicePartitionInfo

Information about a partition of a stateful Service Fabric service..

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

StatefulServiceReplicaHealth

Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations.

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

StatefulServiceReplicaHealthState

Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.

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

StatefulServiceReplicaInfo

Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.

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

StatefulServiceTypeDescription

Describes a stateful service type defined in the service manifest of a provisioned application type.

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

StatefulServiceUpdateDescription

Describes an update for a stateful service.

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

StatelessReplicaHealthReportExpiredEvent

Stateless Replica Health Report Expired event.

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

StatelessReplicaNewHealthReportEvent

Stateless Replica Health Report Created event.

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

StatelessServiceDescription

Describes a stateless service.

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

StatelessServiceInfo

Information about a stateless Service Fabric service.

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

StatelessServiceInstanceHealth

Represents the health of the stateless service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations.

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

StatelessServiceInstanceHealthState

Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.

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

StatelessServiceInstanceInfo

Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.

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

StatelessServicePartitionInfo

Information about a partition of a stateless Service Fabric service.

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

StatelessServiceTypeDescription

Describes a stateless service type defined in the service manifest of a provisioned application type.

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

StatelessServiceUpdateDescription

Describes an update for a stateless service.

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

StoppedChaosEvent

Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.

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

StringPropertyValue

Describes a Service Fabric property value of type String.

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

SuccessfulPropertyBatchInfo

Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any "Get" operations in the batch.

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

SystemApplicationHealthEvaluation

Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.

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

TcpConfig

Describes the tcp configuration for external connectivity for this network.

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

TestErrorChaosEvent

Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted – which would be an unexpected event.

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

TimeBasedBackupScheduleDescription

Describes the time based backup schedule.

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

TimeOfDay

Defines an hour and minute of the day specified in 24 hour time.

TimeRange

Defines a time range in a 24 hour day specified by a start and end time.

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.

UnplacedReplicaInformation

Contains information for an unplaced replica.

UnprovisionApplicationTypeDescriptionInfo

Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.

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

UnprovisionFabricDescription

Describes the parameters for unprovisioning a cluster.

UpdateClusterUpgradeDescription

Parameters for updating a cluster upgrade.

UpdatePartitionLoadResult

Specifies result of updating load for specified partitions. The output will be ordered based on the partition ID.

UpgradeDomainDeltaNodesCheckHealthEvaluation

Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error.

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

UpgradeDomainDeployedApplicationsHealthEvaluation

Represents health evaluation for deployed applications in an upgrade domain, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.

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

UpgradeDomainInfo

Information about an upgrade domain.

UpgradeDomainNodesHealthEvaluation

Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.

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

UpgradeOrchestrationServiceState

Service state of Service Fabric Upgrade Orchestration Service.

UpgradeOrchestrationServiceStateSummary

Service state summary of Service Fabric Upgrade Orchestration Service.

UpgradeUnitInfo

Information about an upgrade unit.

UploadChunkRange

Information about which portion of the file to upload.

UploadSession

Information about a image store upload session.

UploadSessionInfo

Information about an image store upload session. A session is associated with a relative path in the image store.

UsageInfo

Information about how much space and how many files in the file system the ImageStore is using in this category.

ValidateClusterUpgradeResult

Specifies result of validating a cluster upgrade.

ValidationFailedChaosEvent

Chaos event corresponding to a failure during validation.

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

VolumeProviderParametersAzureFile

This type describes a volume provided by an Azure Files file share.

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

VolumeReference

Describes a reference to a volume resource.

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

VolumeResourceDescription

This type describes a volume 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.

WaitForInbuildReplicaSafetyCheck

Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.

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

WaitForPrimaryPlacementSafetyCheck

Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.

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

WaitForPrimarySwapSafetyCheck

Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.

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

WaitForReconfigurationSafetyCheck

Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.

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

WaitingChaosEvent

Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.

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

Enums

ApplicationDefinitionKind
ApplicationPackageCleanupPolicy
ApplicationResourceUpgradeState
ApplicationScopedVolumeKind
ApplicationStatus
ApplicationTypeDefinitionKind
ApplicationTypeStatus
AutoScalingMechanismKind
AutoScalingMetricKind
AutoScalingResourceMetricName
AutoScalingTriggerKind
BackupEntityKind
BackupPolicyScope
BackupScheduleFrequencyType
BackupScheduleKind
BackupState
BackupStorageKind
BackupSuspensionScope
BackupType
ChaosEventKind
ChaosScheduleStatus
ChaosStatus
ComposeDeploymentStatus
ComposeDeploymentUpgradeState
CreateFabricDump
DataLossMode
DayOfWeek
DeactivationIntent
DeployedApplicationStatus
DeploymentStatus
DiagnosticsSinkKind
EntityKind
EntryPointStatus
EnvironmentVariableType
ExecutionPolicyType
FabricErrorCodes
FabricEventKind
FabricReplicaStatus
FailureAction
FailureReason
HeaderMatchType
HealthEvaluationKind
HealthState
HostIsolationMode
HostType
ImageRegistryPasswordType
ImpactLevel
ManagedIdentityType
MoveCost
NetworkKind
NodeDeactivationIntent
NodeDeactivationStatus
NodeDeactivationTaskType
NodeStatus
NodeStatusFilter
NodeTransitionType
NodeUpgradePhase
OperatingSystemType
OperationState
OperationType
Ordering
PackageSharingPolicyScope
PartitionAccessStatus
PartitionScheme
PropertyBatchInfoKind
PropertyBatchOperationKind
PropertyValueKind
ProvisionApplicationTypeKind
QuorumLossMode
ReconfigurationPhase
ReconfigurationType
RepairImpactKind
RepairTargetKind
RepairTaskHealthCheckState
ReplicaHealthReportServiceKind
ReplicaKind
ReplicaRole
ReplicaStatus
ReplicatorOperationName
ResourceStatus
RestartPartitionMode
RestartPolicy
RestoreState
ResultStatus
RetentionPolicyType
RollingUpgradeMode
SafetyCheckKind
ScalingMechanismKind
ScalingTriggerKind
Scheme
SecretKind
ServiceCorrelationScheme
ServiceEndpointRole
ServiceHostUpgradeImpact
ServiceKind
ServiceLoadMetricWeight
ServiceOperationName
ServicePackageActivationMode
ServicePartitionKind
ServicePartitionStatus
ServicePlacementPolicyType
ServiceStatus
ServiceTypeRegistrationStatus
SettingType
SizeTypes
State
UpgradeDomainState
UpgradeKind
UpgradeMode
UpgradeSortOrder
UpgradeState
UpgradeType
UpgradeUnitState
VolumeProvider