Edit

Share via

Remove-AzureRmServiceFabricNode

  • Reference
Module:
AzureRM.ServiceFabric

Remove nodes from the specific node type from a cluster.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Remove-AzureRmServiceFabricNode
      -NumberOfNodesToRemove <Int32>
      [-ResourceGroupName] <String>
      [-Name] <String>
      -NodeType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use Remove-AzureRmServiceFabricNode to remove nodes from a specific node type from a cluster. The removal proceeds only if it meets cluster health metrics.

Examples

Example 1

PS c:> Remove-AzureRmServiceFabricNode -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeTypeName 'nt1' -NumberOfNodesToRemove 2

This command will remove 2 nodes from the NodeType 'nt1'.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specify the name of the cluster.

Type:String
Aliases:ClusterName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NodeType

Node type name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NumberOfNodesToRemove

Number of nodes to remove.

Type:Int32
Aliases:Number
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Int32

Parameters: NumberOfNodesToRemove (ByValue)

String

Parameters: NodeType (ByValue)

Outputs

PSCluster