Edit

Share via

Stop-AzureStorSimpleJob

Module:
Azure Module

Stops a StorSimple job.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Default (Default) 

Stop-AzureStorSimpleJob
    -InstanceId <String>
    [-Force]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Stop-AzureStorSimpleJob cmdlet stops an on-going StorSimple job. You can specify a jobs by supplying an instance ID or a job name.

Examples

Example 1: Stop jobs for a device

PS C:\>Get-AzureStorSimpleJob -DeviceName "Device07" | Stop-AzureStorSimpleJob -Force

This command gets the jobs for the device named Device07, by using the Get-AzureStorSimpleJob cmdlet. The command passes the jobs to the current cmdlet by using the pipeline operator. The current cmdlet stops any jobs that the command passes to it. The command specifies the Force parameter, and, so, it does not prompt you for confirmation before it stops a job.

Example 2: Stop a specific job

PS C:\>Stop-AzureStorSimpleJob -InstanceId "574f47e0-44e9-495c-b8a5-0203c57ebf6d" -Force

This command stops the job that has the specified instance ID.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type: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

-InstanceId

Specifies the ID of the device job to stop.

Parameter properties

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

Parameter sets

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

-Profile

Specifies an Azure profile.

Parameter properties

Type:AzureSMProfile
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

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

None

Outputs

DeviceJobDetails

This cmdlet gets details of the DeviceJob that this cmdlet stops.