Disable-AzsInfrastructureRoleInstance
Syntax
Disable-AzsInfrastructureRoleInstance
-Name <String>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String>]
[-Force]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Disable-AzsInfrastructureRoleInstance
-INPUTOBJECT \<IFabricAdminIdentity>
[-Force]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Description
Shutdown an infrastructure role instance for maintenance.
Examples
Example 1:
PS C:\> Disable-AzsInfrastructureRoleInstance -Name "n22r0903-Xrp03"
Shutdown an infrastructure role instance for maintenance.Shutdown an infrastructure role instance for maintenance.
Parameters
-AsJob
Run the command as a job
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | System.Management.Automation.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: | System.Management.Automation.PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Don't ask for confirmation.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
Location of the resource.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzLocation)[0].Location |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Name of an infrastructure role instance.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource group in which the resource provider has been registered.
| Type: | System.String |
| Position: | Named |
| Default value: | -join("System.",(Get-AzLocation)[0].Location) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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.