Suspend-AzsInfrastructureRoleInstance

Shut down an infrastructure role instance.

Syntax

Suspend-AzsInfrastructureRoleInstance
       -Name <String>
       [-Location <String>]
       [-ResourceGroupName <String>]
       [-AsJob]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Suspend-AzsInfrastructureRoleInstance
       -ResourceId <String>
       [-AsJob]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Shut down an infrastructure role instance.

Examples

EXAMPLE 1

Suspend-AzsInfrastructureRoleInstance -Name "AzS-ACS01"

Shut down an infrastructure role instance. On failure an exception is thrown.

Parameters

-AsJob

Run asynchronous as a job and return the job object.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

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

Don't ask for confirmation

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Location

Location of the resource.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Name of an infrastructure role instance.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Resource group in which the resource provider has been registered.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Infrastructure role instance resource ID.

Type:String
Aliases:id
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False