@microsoft/windows-admin-center-sdk/core/data/cim.d.ts

Microsoft - Windows Admin Center Shell

export declare class Cim {
    private static cimClassRelativeUri;
    private static cimQueryRelativeUri;
    private static cimInvokeRelativeUri;
    static namespace: {
        cimV2: string;
        cluster: string;
        standardCimV2: string;
        managementTools: string;
        serverManager: string;
        windowsUpdate: string;
        /**
         * @deprecated namespace is deprecated use "Cim.namespace.managementTools"
         */
        managementTools2: string;
    };
    static cimClass: {
        clusterResource: string;
        clusterNode: string;
        win32NetworkAdapter: string;
        clusterUtilities: string;
        win32ComputerSystem: string;
        win32OperatingSystem: string;
        win32Processor: string;
        win32LogicalDisks: string;
        win32PhysicalMemory: string;
        win32Service: string;
        Win32DependentService: string;
        win32PnpEntity: string;
        win32Sid: string;
        msftMTProcessorSummary: string;
        msftMTMemorySummary: string;
        msftMTDisk: string;
        msftMTNetworkAdapter: string;
        msftMTTaskManager: string;
        msftMTProcesses: string;
        msftMTEventProvider: string;
        msftMTEventChannel: string;
        msftMTRegistryKey: string;
        msftMTRegistryValue: string;
        msftMTRegistryTasks: string;
        msftMTRegistryString: string;
        msftMTRegistryBinary: string;
        msftMTRegistryDword: string;
        msftMTRegistryMultiString: string;
        msftMTRegistryQword: string;
        msftNetAdapter: string;
        msftNetIPInterface: string;
        msftNetIPAddress: string;
        msftNetRoute: string;
        msftDnsClientServerAddress: string;
        msftServerManagerTasks: string;
        msftWUOperationsSession: string;
        msftWUSettings: string;
        msftNetFirewallRule: string;
        msftNetAddressFilter: string;
        msftNetApplicationFilter: string;
        msftNetInterfaceFilter: string;
        msftNetInterfaceTypeFilter: string;
        msftNetProtocolPortFilter: string;
        msftNetNetworkLayerSecurityFilter: string;
        msftNetServiceFilter: string;
    };
    /**
     * WQL query to select by a single property value
     * @param className the class name to query for
     * @param propertyName The property Name to filter by
     * @param properties the collection of properties to retrieve. To get all properties specify and array
     * of one element: ["*"]
     * @returns the WQL query for the given parameters formatted to add the desired property value:
     * Select {properties} from {className} where {PropertyName}='{0}'
     */
    static wqlSelectBySingleProperty(className: string, propertyName: string, properties: string[]): string;
    /**
     * CIM URL builder for MultipleInstances
     *
     * @param namespace the cim namespace.
     * @param className the class name.
     */
    static cimUrlMultipleInstances(namespace: string, className: string): string;
    /**
     * CIM URL builder for SingleInstance
     *
     * @param namespace the cim namespace.
     * @param className the class name.
     * @param keyProperties the key properties object.
     */
    static cimUrlSingleInstance(namespace: string, className: string, keyProperties: any): string;
    /**
     * CIM URL builder for InstanceMethod
     *
     * @param namespace the cim namespace.
     * @param className the class name.
     * @param methodName the method name.
     * @param keyProperties the key properties object.
     */
    static cimUrlInstanceMethod(namespace: string, className: string, methodName: string, keyProperties: any): string;
    /**
     * CIM URL builder for StaticMethod
     *
     * @param namespace the cim namespace.
     * @param className the class name.
     * @param methodName the method name.
     */
    static cimUrlStaticMethod(namespace: string, className: string, methodName: string): string;
    /**
     * CIM URL builder for WqlQuery
     */
    static cimUrlWqlQuery(namespace: string): string;
    /**
     * Create Get URL of cim instances.
     *
     * @param namespaceName name of CIM namespace.
     * @param className name of CIM class.
     * @return relative URL of GET call.
     */
    private static instanceMultiple;
    /**
     * Create Get URL of cim single instance.
     *
     * @param namespaceName name of CIM namespace.
     * @param className name of CIM class.
     * @return relative URL of GET call.
     */
    private static instanceSingle;
    /**
     * Create POST URL of cim static method.
     *
     * @param namespaceName name of CIM namespace.
     * @param className name of CIM class.
     * @param methodName name of CIM method.
     * @return relative URL of POST call.
     */
    private static invokeStatic;
    /**
     * Create POST URL of cim instance method.
     *
     * @param namespaceName name of CIM namespace.
     * @param className name of CIM class.
     * @param methodName name of CIM method.
     * @return relative URL of POST call.
     */
    private static invokeInstance;
}
/**
 * CIM single instance.
 */
export interface CimSingle {
    name?: string;
    id?: string;
    properties: any;
}
/**
 * CIM multiple instances.
 */
export interface CimMultiple {
    value: CimSingle[];
}
/**
 * Cim result object including an error.
 */
export declare type CimResult = any;
/**
 * Cim key properties set with name value pair.
 */
export interface CimKeyProperties {
    [name: string]: string | number;
}