RemoveCimInstanceCommand Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Enables the user to remove a CimInstance.
public class RemoveCimInstanceCommand : Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand[System.Management.Automation.Alias(new System.String[] { "rcim" })]
[System.Management.Automation.Cmdlet("Remove", "CimInstance", DefaultParameterSetName="CimInstanceComputerSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227964", SupportsShouldProcess=true)]
public class RemoveCimInstanceCommand : Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommandtype RemoveCimInstanceCommand = class
inherit CimBaseCommand[<System.Management.Automation.Alias(new System.String[] { "rcim" })>]
[<System.Management.Automation.Cmdlet("Remove", "CimInstance", DefaultParameterSetName="CimInstanceComputerSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227964", SupportsShouldProcess=true)>]
type RemoveCimInstanceCommand = class
inherit CimBaseCommandPublic Class RemoveCimInstanceCommand
Inherits CimBaseCommand- Inheritance
- Attributes
Constructors
| RemoveCimInstanceCommand() |
Initializes a new instance of the RemoveCimInstanceCommand class. |
Properties
| CimSession |
The following is the definition of the input parameter "Session". CIM session used to remove the CIM Instance. |
| CommandOrigin |
This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand) |
| CommandRuntime |
Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet) |
| ComputerName |
The following is the definition of the input parameter "ComputerName". |
| CurrentPSTransaction |
Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet) |
| InputObject |
The following is the definition of the input parameter "InputObject". Used to get a CimInstance using Get-CimInstance | Remove-CimInstance. |
| Namespace |
The following is the definition of the input parameter "Namespace". The Namespace used to look for the Class instances under. |
| OperationTimeoutSec |
The following is the definition of the input parameter "OperationTimeoutSec". Used to set the invocation operation time out. This value overrides the CimSession operation timeout. |
| Query |
The following is the definition of the input parameter "Query". |
| QueryDialect |
The following is the definition of the input parameter "QueryDialect". Specifies the dialect used by the query Engine that interprets the Query string. |
| ResourceUri |
The following is the definition of the input parameter "ResourceUri". Define the Resource Uri for which the instances are retrieved. |
| Stopping |
Is this command stopping? (Inherited from Cmdlet) |
Methods
| BeginProcessing() |
BeginProcessing method. |
| Dispose() |
Dispose() calls Dispose(true). Implement IDisposable. Do not make this method virtual. A derived class should not be able to override this method. (Inherited from CimBaseCommand) |
| Dispose(Boolean) |
Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. (Inherited from CimBaseCommand) |
| DisposeInternal() |
Clean up resources. (Inherited from CimBaseCommand) |
| EndProcessing() |
EndProcessing method. |
| GetResourceString(String, String) |
Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet) |
| Invoke() |
Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet) |
| Invoke<T>() |
Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet) |
| ProcessRecord() |
ProcessRecord method. |
| ShouldContinue(String, String, Boolean, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
| ShouldContinue(String, String, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
| ShouldContinue(String, String) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet) |
| ShouldProcess(String, String, String, ShouldProcessReason) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
| ShouldProcess(String, String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
| ShouldProcess(String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet) |
| ShouldProcess(String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet) |
| StopProcessing() |
StopProcessing method. (Inherited from CimBaseCommand) |
| ThrowTerminatingError(ErrorRecord) |
Terminate the command and report an error. (Inherited from Cmdlet) |
| TransactionAvailable() |
Returns true if a transaction is available and active. (Inherited from Cmdlet) |
| WriteCommandDetail(String) |
Write text into pipeline execution log. (Inherited from Cmdlet) |
| WriteDebug(String) |
Display debug information. (Inherited from Cmdlet) |
| WriteError(ErrorRecord) |
Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet) |
| WriteInformation(InformationRecord) |
Route information to the user or host. (Inherited from Cmdlet) |
| WriteInformation(Object, String[]) |
Route information to the user or host. (Inherited from Cmdlet) |
| WriteObject(Object, Boolean) |
Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet) |
| WriteObject(Object) |
Writes the object to the output pipe. (Inherited from Cmdlet) |
| WriteProgress(ProgressRecord) |
Display progress information. (Inherited from Cmdlet) |
| WriteVerbose(String) |
Display verbose information. (Inherited from Cmdlet) |
| WriteWarning(String) |
Display warning information. (Inherited from Cmdlet) |