Stop-AzsInfrastructureRoleInstance

Module:

Azs.Fabric.Admin Module

Power off an infrastructure role instance.

Syntax

PowerOff (Default)

Stop-AzsInfrastructureRoleInstance
    -Name <String>
    [-Location <String>]
    [-ResourceGroupName <String>]
    [-SubscriptionId <String>]
    [-Force]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

PowerOffViaIdentity

Stop-AzsInfrastructureRoleInstance
    -InputObject <IFabricAdminIdentity>
    [-Force]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

Power off an infrastructure role instance.

Examples

Example 1:

PS C:\> Stop-AzsInfrastructureRoleInstancef -Name "AzS-ACS01"

Power off a infrastructure role instance.

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	System.Management.Automation.PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Force

Don't ask for confirmation.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

PowerOffViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Location

Location of the resource.

Parameter properties

Type:	System.String
Default value:	(Get-AzLocation)[0].Location
Supports wildcards:	False
DontShow:	False

Parameter sets

PowerOff

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Name of an infrastructure role instance.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

PowerOff

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NoWait

Run the command asynchronously

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Name of the resource group.

Parameter properties

Type:	System.String
Default value:	-join("System.",(Get-AzLocation)[0].Location)
Supports wildcards:	False
DontShow:	False

Parameter sets

PowerOff

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Parameter properties

Type:	System.String
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

PowerOff

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IFabricAdminIdentity>: Identity Parameter

• [Drive <String>]: Name of the storage drive.
• [EdgeGateway <String>]: Name of the edge gateway.
• [EdgeGatewayPool <String>]: Name of the edge gateway pool.
• [FabricLocation <String>]: Fabric location.
• [FileShare <String>]: Fabric file share name.
• [IPPool <String>]: IP pool name.
• [Id <String>]: Resource identity path
• [InfraRole <String>]: Infrastructure role name.
• [InfraRoleInstance <String>]: Name of an infrastructure role instance.
• [Location <String>]: Location of the resource.
• [LogicalNetwork <String>]: Name of the logical network.
• [LogicalSubnet <String>]: Name of the logical subnet.
• [MacAddressPool <String>]: Name of the MAC address pool.
• [Operation <String>]: Operation identifier.
• [ResourceGroupName <String>]: Name of the resource group.
• [ScaleUnit <String>]: Name of the scale units.
• [ScaleUnitNode <String>]: Name of the scale unit node.
• [SlbMuxInstance <String>]: Name of a SLB MUX instance.
• [StoragePool <String>]: Storage pool name.
• [StorageSubSystem <String>]: Name of the storage system.
• [SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
• [Volume <String>]: Name of the storage volume.