NewCimInstanceCommand Class

Definition

Namespace:

Microsoft.Management.Infrastructure.CimCmdlets

Assembly:

Microsoft.Management.Infrastructure.CimCmdlets.dll

Package:

Microsoft.Management.Infrastructure.CimCmdlets v7.4.0

This Cmdlet creates an instance of a CIM class based on the class definition, which is an instance factory

If -ClientOnly is not specified, New-CimInstance will create a new instance on the server, otherwise just create client in-memory instance

[System.Management.Automation.Alias(new System.String[] { "ncim" })]
[System.Management.Automation.Cmdlet("New", "CimInstance", DefaultParameterSetName="ClassNameComputerSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227963", SupportsShouldProcess=true)]
[System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.CimInstance) })]
public class NewCimInstanceCommand : Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand

[<System.Management.Automation.Alias(new System.String[] { "ncim" })>]
[<System.Management.Automation.Cmdlet("New", "CimInstance", DefaultParameterSetName="ClassNameComputerSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227963", SupportsShouldProcess=true)>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.CimInstance) })>]
type NewCimInstanceCommand = class
    inherit CimBaseCommand

Public Class NewCimInstanceCommand
Inherits CimBaseCommand

Inheritance

Object

InternalCommand

Cmdlet

CimBaseCommand

NewCimInstanceCommand

Attributes

AliasAttribute CmdletAttribute OutputTypeAttribute

Constructors

NewCimInstanceCommand()

Initializes a new instance of the NewCimInstanceCommand class.

Properties

CimClass	The following is the definition of the input parameter "CimClass". The CimClass is used to create Instance.
CimSession	The following is the definition of the input parameter "CimSession". Identifies the CimSession which is to be used to create the instances.
ClassName	The following is the definition of the input parameter "ClassName". Name of the Class to use to create Instance.
ClientOnly	The following is the definition of the input parameter "ClientOnly". Indicates to create a client only ciminstance object, NOT on the server.
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". Provides the name of the computer from which to create the instances. If no ComputerName is specified the default value is "localhost"
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Key	The following is the definition of the input parameter "Key". Enables the user to specify list of key property name. Example: -Key {"K1", "K2"}
Namespace	The following is the definition of the input parameter "Namespace". Namespace used to look for the classes under to store the instances. Default namespace is 'root\cimv2'
OperationTimeoutSec	The following is the definition of the input parameter "OperationTimeoutSec". Operation Timeout of the cmdlet in seconds. Overrides the value in the Cim Session.
Property	The following is the definition of the input parameter "Property". Enables the user to specify instances with specific property values. Example: -Property @{P1="Value1";P2="Value2"}
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)	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)
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, 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)
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)
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, 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, 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)
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)	Writes the object to the output pipe. (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)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)