GetCimInstanceCommand Class

Returns zero or more dynamic CIM instances with the properties specified in the Property parameter, the KeysOnly parameter, or the SELECT clause of the Query parameter.

Namespace:   Microsoft.Management.Infrastructure.CimCmdlets
Assembly:  Microsoft.Management.Infrastructure.CimCmdlets (in Microsoft.Management.Infrastructure.CimCmdlets.dll)

Inheritance Hierarchy

System.Object
  System.Management.Automation.Internal.InternalCommand
    System.Management.Automation.Cmdlet
      Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand
        Microsoft.Management.Infrastructure.CimCmdlets.GetCimInstanceCommand

Syntax

[CmdletAttribute("Get", "CimInstance", DefaultParameterSetName = "ClassNameComputerSet", 
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227961")]
[OutputTypeAttribute(new Type[] { ... })]
public class GetCimInstanceCommand : CimBaseCommand

[CmdletAttribute("Get", "CimInstance", DefaultParameterSetName = "ClassNameComputerSet", 
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227961")]
[OutputTypeAttribute(new array<Type^>^ { ... })]
public ref class GetCimInstanceCommand : CimBaseCommand

[<CmdletAttribute("Get", "CimInstance", DefaultParameterSetName = "ClassNameComputerSet",
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227961")>]
[<OutputTypeAttribute([| ... |])>]
type GetCimInstanceCommand = 
    class
        inherit CimBaseCommand
    end

<CmdletAttribute("Get", "CimInstance", DefaultParameterSetName := "ClassNameComputerSet",
    HelpUri := "https://go.microsoft.com/fwlink/?LinkId=227961")>
<OutputTypeAttribute(New Type() { ... })>
Public Class GetCimInstanceCommand
    Inherits CimBaseCommand

Constructors

	Name	Description
	GetCimInstanceCommand()	Constructor for the GetCimInstanceCommand class, which provides zero or more CIM instances with the properties specified in the Property parameter, KeysOnly parameter, or the SELECT clause of the Query parameter.

Properties

	Name	Description
	CimSession	Gets and sets the CimSession parameter, which identifies the CimSession to be used to retrieve the instances.
	ClassName	Gets and sets the ClassName parameter, which specifies the type of CIM instances to retrieve.
	CommandOrigin	(Inherited from InternalCommand.)
	CommandRuntime	(Inherited from Cmdlet.)
	ComputerName	Gets and sets the ComputerName parameter, which specifies the name of the computer from which to retrieve the instances. The name is used to create a temporary CimSession with default parameter values, which is then used to retrieve the instances. If this parameter isn't set, then the default value is "localhost".
	CurrentPSTransaction	(Inherited from Cmdlet.)
	Filter	Gets and sets the Filter property, which specifies the WHERE close of the query.
	InputObject	Gets and sets the InputObject parameter, which is the CimInstance object that contains the key properties.
	KeyOnly	Gets and sets the KeyOnly parameter, which indicates whether only key properties of the retrieved instances should be returned to the client.
	Namespace	Gets and sets the Namespace parameter, which identifies the namespace in which the class, indicated by ClassName, is registered. If this property isn't set, the default namespace is root\cimv2.
	OperationTimeoutSec	Gets and sets the OperationTimeoutSec parameter, which specifies the timeout after which the client operation is to be canceled.
	Property	Gets and sets the Property parameter, which enables the user to specify instances with specific property values. Example: -Property @{P1="Value1";P2="Value2"}
	Query	Gets and sets the Query parameter, which determines the instances and properties to retrieve.
	QueryDialect	Gets and sets the QueryDialect parameter, which specifies the dialect used by the query engine that interprets the query string.
	ResourceUri	Gets and sets the ResourceUri parameter, which defines the resource URI for which the instances are retrieved.
	Shallow	Gets and sets the switch parameter Shallow. If the switch is set to True, only the instance of the class identified by Namespace and ClassName will be returned. If the switch is not set, instances of the class and of all of its descendents will be returned (the enumeration will cascade the class inheritance hierarchy).
	Stopping	(Inherited from Cmdlet.)

Methods

	Name	Description
	BeginProcessing()	BeginProcessing method.(Overrides Cmdlet.BeginProcessing().)
	Dispose()	Releases resources.(Inherited from CimBaseCommand.)
	Dispose(Boolean)	Releases resources.(Inherited from CimBaseCommand.)
	DisposeInternal()	Disposes of all managed and unmanaged resources.(Inherited from CimBaseCommand.)
	EndProcessing()	EndProcessing method.(Overrides Cmdlet.EndProcessing().)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetResourceString(String, String)	(Inherited from Cmdlet.)
	GetType()	(Inherited from Object.)
	Invoke()	(Inherited from Cmdlet.)
	MemberwiseClone()	(Inherited from Object.)
	ProcessRecord()	ProcessRecord method.(Overrides Cmdlet.ProcessRecord().)
	ShouldContinue(String, String)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldProcess(String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String, ShouldProcessReason)	(Inherited from Cmdlet.)
	StopProcessing()	StopProcessing method.(Inherited from CimBaseCommand.)
	ThrowTerminatingError(ErrorRecord)	(Inherited from Cmdlet.)
	ToString()	(Inherited from Object.)
	TransactionAvailable()	(Inherited from Cmdlet.)
	WriteCommandDetail(String)	(Inherited from Cmdlet.)
	WriteDebug(String)	(Inherited from Cmdlet.)
	WriteError(ErrorRecord)	(Inherited from Cmdlet.)
	WriteInformation(InformationRecord)	(Inherited from Cmdlet.)
	WriteInformation(Object, String[])	(Inherited from Cmdlet.)
	WriteObject(Object)	(Inherited from Cmdlet.)
	WriteObject(Object, Boolean)	(Inherited from Cmdlet.)
	WriteProgress(ProgressRecord)	(Inherited from Cmdlet.)
	WriteVerbose(String)	(Inherited from Cmdlet.)
	WriteWarning(String)	(Inherited from Cmdlet.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Management.Infrastructure.CimCmdlets Namespace

Return to top