Service​Fabric

This topic displays help topics for the Azure Service Fabric Cmdlets. Service Fabric is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices and addresses the significant challenges in developing and managing cloud applications. By using Service Fabric, developers and administrators can avoid solving complex infrastructure problems and focus instead on implementing mission-critical, demanding workloads knowing that they are scalable, reliable, and manageable. Service Fabric represents the next-generation middleware platform for building and managing these enterprise-class, Tier-1 cloud-scale applications. With Azure Service Fabric, you can do the following: Simplify microservice-based application development and lifecycle management Deliver low-latency performance and efficiency at massive scale * Proven platform used by Azure and other Microsoft services

  • Run in Azure, on-premises, or in other clouds

The Service Fabric PowerShell module is installed with the Service Fabric SDK, runtime, and tools.

ServiceFabric

Add-​Service​Fabric​Node

Adds a Service Fabric node to a cluster.

Approve-​Service​Fabric​Repair​Task

Forces approval of a repair task.

Complete-​Service​Fabric​Repair​Task

Reports that a manual repair task is finished.

Connect-​Service​Fabric​Cluster

Creates a connection to a Service Fabric cluster.

Copy-​Service​Fabric​Application​Package

Copies a Service Fabric application package to the image store.

Copy-​Service​Fabric​Cluster​Package

Copies a Service Fabric runtime installation file and/or cluster manifest to the image store.

Copy-​Service​Fabric​Service​Package​To​Node

Copies a service package to a target node.

Disable-​Service​Fabric​Node

Disables a Service Fabric node.

Enable-​Service​Fabric​Node

Enables a Service Fabric node.

Get-​Service​Fabric​Application

Gets all the applications in the Service Fabric cluster or a specific application.

Get-​Service​Fabric​Application​Health

Gets the health of a Service Fabric application.

Get-​Service​Fabric​Application​Load​Information

Gets application capacity parameters and load information for a Service Fabric application.

Get-​Service​Fabric​Application​Manifest

Gets the manifest for a Service Fabric application type.

Get-​Service​Fabric​Application​Name

Gets the Service Fabric Application name from the Service Fabric Service name.

Get-​Service​Fabric​Application​Type

Gets the Service Fabric application types registered on the Service Fabric cluster which match the provided filters.

Get-​Service​Fabric​Application​Upgrade

Gets the status of a Service Fabric application upgrade.

Get-​Service​Fabric​Chaos​Report

Gets a report of Chaos results.

Get-​Service​Fabric​Cluster​Configuration

Gets the latest JSON format cluster configuration.

Get-​Service​Fabric​Cluster​Configuration​Upgrade​Status

Gets the status for Service Fabric cluster configuration upgrade.

Get-​Service​Fabric​Cluster​Connection

Gets the current Service Fabric cluster connection.

Get-​Service​Fabric​Cluster​Health

Gets health information for a Service Fabric cluster.

Get-​Service​Fabric​Cluster​Health​Chunk

Gets health information for a Service Fabric cluster and its children.

Get-​Service​Fabric​Cluster​Load​Information

Gets the load reports of a Service Fabric cluster.

Get-​Service​Fabric​Cluster​Manifest

Gets the Service Fabric cluster manifest.

Get-​Service​Fabric​Cluster​Upgrade

Gets the status of a Service Fabric cluster upgrade.

Get-​Service​Fabric​Deployed​Application

Gets a Service Fabric application on a node.

Get-​Service​Fabric​Deployed​Application​Health

Gets the health of a Service Fabric application on a node.

Get-​Service​Fabric​Deployed​Code​Package

Gets the Service Fabric code packages deployed on a node.

Get-​Service​Fabric​Deployed​Replica

Gets information about a Service Fabric replica on a node.

Get-​Service​Fabric​Deployed​Replica​Detail

Gets information about Service Fabric replicas from a host process.

Get-​Service​Fabric​Deployed​Service​Package

Gets the Service Fabric service packages on a node.

Get-​Service​Fabric​Deployed​Service​Package​Health

Gets the health of a Service Fabric service package.

Get-​Service​Fabric​Deployed​Service​Type

Gets the Service Fabric service types deployed on a node.

Get-​Service​Fabric​Image​Store​Content

Gets image store content information

Get-​Service​Fabric​Node

Gets information for the all nodes in a Service Fabric cluster or for a specific node.

Get-​Service​Fabric​Node​Configuration

Gets the configuration of a Service Fabric node.

Get-​Service​Fabric​Node​Health

Gets the health state of a Service Fabric node.

Get-​Service​Fabric​Node​Load​Information

Gets detailed metrics load information for a Service Fabric node.

Get-​Service​Fabric​Node​Transition​Progress

Gets the progress of a node transition operation.

Get-​Service​Fabric​Package​Debug​Parameters

{{Manually Enter Get-ServiceFabricPackageDebugParameters Description Here}}

Get-​Service​Fabric​Partition

Gets information about the partitions of a specified Service Fabric partition or service.

Get-​Service​Fabric​Partition​Data​Loss​Progress

Gets the progress of a data loss fault operation.

Get-​Service​Fabric​Partition​Health

Gets the health of a Service Fabric partition.

Get-​Service​Fabric​Partition​Load​Information

Gets the load reports for a Service Fabric partition.

Get-​Service​Fabric​Partition​Quorum​Loss​Progress

Gets the progress of a quorum loss faults.

Get-​Service​Fabric​Partition​Restart​Progress

Gets the progress of a partition restart.

Get-​Service​Fabric​Registered​Cluster​Code​Version

Gets all provisioned fabric code versions in a Service Fabric cluster.

Get-​Service​Fabric​Registered​Cluster​Config​Version

Gets provisioned fabric configuration versions in a Service Fabric cluster.

Get-​Service​Fabric​Repair​Task

Gets the repair tasks.

Get-​Service​Fabric​Replica

Gets the list of System.Fabric.Query.Replica objects.

Get-​Service​Fabric​Replica​Health

Gets the health of a Service Fabric replica.

Get-​Service​Fabric​Replica​Load​Information

Returns detailed metrics load information for a Service Fabric replica.

Get-​Service​Fabric​Runtime​Supported​Version

Gets a list of all currently supported service fabric runtime versions for standalone deployments.

Get-​Service​Fabric​Runtime​Upgrade​Version

Gets a list of all service fabric runtime versions which are upgrade compatible to a given version for standalone deployments.

Get-​Service​Fabric​Service

Gets a list of Service Fabric services.

Get-​Service​Fabric​Service​Description

Gets the Service Fabric service description of a service that is running.

Get-​Service​Fabric​Service​Group​Description

Gets a Service Fabric service group description.

Get-​Service​Fabric​Service​Group​Member

Gets members of service groups.

Get-​Service​Fabric​Service​Group​Member​Type

Gets member types of Service Fabric service groups.

Get-​Service​Fabric​Service​Health

Gets the health of a Service Fabric service.

Get-​Service​Fabric​Service​Manifest

Gets the Service Fabric service type manifest.

Get-​Service​Fabric​Service​Name

Gets the name of the service for a Service Fabric partition.

Get-​Service​Fabric​Service​Type

Gets all the Service Fabric service types for the given application type or a specific service type.

Get-​Service​Fabric​Test​Command​Status​List

Gets the list of all the fault operations triggered in the cluster and their status

Get-​Service​Fabric​Unplaced​Replica​Information

{{Fill in the Synopsis}}

Invoke-​Service​Fabric​Chaos​Test​Scenario

This cmdlet is Obsolete. Please use Start-ServiceFabricChaos.

Invoke-​Service​Fabric​Decrypt​Text

Decrypts the text encrypted by the Invoke-ServiceFabricEncryptText cmdlet.

Invoke-​Service​Fabric​Encrypt​Secret

Obsolete

Invoke-​Service​Fabric​Encrypt​Text

Encrypts text to include in Service Fabric manifests or configurations.

Invoke-​Service​Fabric​Failover​Test​Scenario

Invokes a test scenario to induce faults in a Service Fabric partition.

Invoke-​Service​Fabric​Infrastructure​Command

Invokes an administrative command on an infrastructure service.

Invoke-​Service​Fabric​Infrastructure​Query

Invokes a read-only query on an infrastructure service.

Invoke-​Service​Fabric​Partition​Data​Loss

DEPRECATED. Please use the Start-ServiceFabricPartitionDataLoss.

Invoke-​Service​Fabric​Partition​Quorum​Loss

DEPRECATED. Please use the Start-ServiceFabricPartitionQuorumLoss.

Move-​Service​Fabric​Primary​Replica

Moves the Service Fabric primary replica of a stateful service partition.

Move-​Service​Fabric​Secondary​Replica

Moves the Service Fabric secondary replica of a stateful service.

New-​Service​Fabric​Application

Creates a Service Fabric application.

New-​Service​Fabric​Cluster

Creates a Service Fabric cluster.

New-​Service​Fabric​Node​Configuration

Configures a node to join a Service Fabric cluster. Works for development clusters and Azure clusters.

New-​Service​Fabric​Package​Debug​Parameter

Adds debug parameters for a code package in a service package.

New-​Service​Fabric​Package​Sharing​Policy

Creates a package sharing policy.

New-​Service​Fabric​Service

Creates a Service Fabric service.

New-​Service​Fabric​Service​From​Template

If the application manifest has defined a service templates section, then this command can be used to create new services with service description parameters populated from the template.

New-​Service​Fabric​Service​Group

Creates a Service Fabric service group.

New-​Service​Fabric​Service​Group​From​Template

Creates a Service Fabric service group from a service template.

Register-​Service​Fabric​Application​Type

Registers a Service Fabric application type.

Register-​Service​Fabric​Cluster​Package

Registers Service Fabric runtime installation file and/or cluster manifest with the cluster.

Remove-​Service​Fabric​Application

Removes a Service Fabric application.

Remove-​Service​Fabric​Application​Package

Removes a Service Fabric application package from the image store.

Remove-​Service​Fabric​Cluster

Removes a Service Fabric cluster.

Remove-​Service​Fabric​Cluster​Package

Removes a Service Fabric cluster package from the image store.

Remove-​Service​Fabric​Node

Removes a Service Fabric node from the cluster.

Remove-​Service​Fabric​Node​Configuration

Removes information related to a configured node.

Remove-​Service​Fabric​Node​State

Notifies Service Fabric that the state on a node has been removed by an external mechanism.

Remove-​Service​Fabric​Repair​Task

Removes a completed repair task.

Remove-​Service​Fabric​Replica

Removes a replica from a cluster to simulate a replica failure.

Remove-​Service​Fabric​Service

Removes an existing Service Fabric service.

Remove-​Service​Fabric​Service​Group

Removes a Service Fabric service group.

Remove-​Service​Fabric​Test​State

Removes all test state data from a Service Fabric cluster.

Repair-​Service​Fabric​Partition

Brings a partition out of quorum loss.

Reset-​Service​Fabric​Partition​Load

Resets the current load of a Service Fabric partition.

Resolve-​Service​Fabric​Service

Retrieves the replica address of a stateful Service Fabric partitioned service or the address of an instance of a stateless Service Fabric service.

Restart-​Service​Fabric​Deployed​Code​Package

Restarts a code package deployed on a node in a cluster to simulate a process failure.

Restart-​Service​Fabric​Node

Restarts a Service Fabric node to simulate a cluster node failure.

Restart-​Service​Fabric​Partition

Restarts replicas of a Service Fabric partition to simulate a data center blackout or cluster blackout scenario.

Restart-​Service​Fabric​Replica

Restarts a Service Fabric replica to simulate the reopening of a stateful service replica.

Resume-​Service​Fabric​Application​Upgrade

Resumes an unmonitored Service Fabric application upgrade.

Resume-​Service​Fabric​Cluster​Upgrade

Resumes an unmonitored Service Fabric cluster upgrade.

Send-​Service​Fabric​Application​Health​Report

Sends a health report on a Service Fabric application.

Send-​Service​Fabric​Cluster​Health​Report

Sends a health report on a Service Fabric cluster.

Send-​Service​Fabric​Deployed​Application​Health​Report

Sends a health report on a Service Fabric application deployed on a node.

Send-​Service​Fabric​Deployed​Service​Package​Health​Report

Sends a health report on a Service Fabric deployed service package.

Send-​Service​Fabric​Node​Health​Report

Sends a health report on a Service Fabric node.

Send-​Service​Fabric​Partition​Health​Report

Sends a health report on a Service Fabric service partition.

Send-​Service​Fabric​Replica​Health​Report

Sends a health report on a Service Fabric replica.

Send-​Service​Fabric​Service​Health​Report

Sends a health report on a Service Fabric service.

Set-​Service​Fabric​Replica​Placement​Health​Reporting

{{Fill in the Synopsis}}

Start-​Service​Fabric​Application​Rollback

Starts rolling back a Service Fabric application upgrade.

Start-​Service​Fabric​Application​Upgrade

Upgrades a Service Fabric application to specified ApplicationTypeVersion.

Start-​Service​Fabric​Chaos

Starts a Chaos run in the cluster.

Start-​Service​Fabric​Cluster​Configuration​Upgrade

Upgrades a cluster configuration.

Start-​Service​Fabric​Cluster​Rollback

Starts rolling back a Service Fabric cluster upgrade.

Start-​Service​Fabric​Cluster​Upgrade

Upgrades a Service Fabric cluster.

Start-​Service​Fabric​Node

OBSOLETE. Please use the Start-ServiceFabricNodeTransition cmdlet instead.

Start-​Service​Fabric​Node​Transition

Initiates an operation to start or stop a Service Fabric cluster node.

Start-​Service​Fabric​Partition​Data​Loss

Initiates a data loss fault operation on a partition of a stateful Service Fabric service. For details about how to invoke a data loss operation, see the Invoke Data Loss (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-use-data-loss-api) article. The various ways to specify or to choose the partition to invoke data loss on are below.

Start-​Service​Fabric​Partition​Quorum​Loss

Initiates a fault to put a partition into quorum loss. The various ways to specify or to choose the partition to invoke quorum loss on are below.

Start-​Service​Fabric​Partition​Restart

Initiates the restart of a stateful service partition.

Start-​Service​Fabric​Repair​Task

Starts a repair task.

Stop-​Service​Fabric​Chaos

Stops Chaos in the cluster.

Stop-​Service​Fabric​Node

OBSOLETE. Use the Start-ServiceFabricNodeTransition cmdlet instead.

Stop-​Service​Fabric​Repair​Task

Cancels a repair task.

Stop-​Service​Fabric​Test​Command

Cancels a running Service Fabric fault operation.

Test-​Service​Fabric​Application

Validates the health and availability of a Service Fabric application.

Test-​Service​Fabric​Application​Package

Validates a Service Fabric application package.

Test-​Service​Fabric​Cluster​Connection

Checks and confirms that you are connected to a Service Fabric cluster.

Test-​Service​Fabric​Cluster​Manifest

Validates a Service Fabric cluster manifest.

Test-​Service​Fabric​Configuration

Validates cluster configuration and tests whether deployment can succeed.

Test-​Service​Fabric​Service

Validates the health and availability of a Service Fabric service.

Unregister-​Service​Fabric​Application​Type

Unregisters a Service Fabric application type.

Unregister-​Service​Fabric​Cluster​Package

Unregisters Service Fabric runtime installation version and/or cluster manifest version from the cluster.

Update-​Service​Fabric​Application

Updates or removes application capacity.

Update-​Service​Fabric​Application​Upgrade

Modifies the upgrade description of an active Application upgrade.

Update-​Service​Fabric​Cluster​Upgrade

Modifies the upgrade description of an active Cluster upgrade.

Update-​Service​Fabric​Node​Configuration

Updates a Service Fabric cluster configuration.

Update-​Service​Fabric​Repair​Task​Health​Policy

Updates the health policy of a repair task.

Update-​Service​Fabric​Service

Updates a Service Fabric service.

Update-​Service​Fabric​Service​Group

Updates a Service Fabric service group.