@microsoft/msgraph-beta-sdk-directory
Version:
Directory fluent API for Microsoft Graph
82 lines • 3.42 kB
TypeScript
import { type DeviceCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DeviceItemRequestBuilder } from './item/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the deviceInstances property of the microsoft.graph.deviceTemplate entity.
*/
export interface DeviceInstancesRequestBuilder extends BaseRequestBuilder<DeviceInstancesRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the deviceInstances property of the microsoft.graph.deviceTemplate entity.
* @param deviceId The unique identifier of device
* @returns {DeviceItemRequestBuilder}
*/
byDeviceId(deviceId: string): DeviceItemRequestBuilder;
/**
* Collection of device objects created based on this template.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<DeviceCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<DeviceInstancesRequestBuilderGetQueryParameters> | undefined): Promise<DeviceCollectionResponse | undefined>;
/**
* Collection of device objects created based on this template.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<DeviceInstancesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
* Collection of device objects created based on this template.
*/
export interface DeviceInstancesRequestBuilderGetQueryParameters {
/**
* Include count of items
*/
count?: boolean;
/**
* Expand related entities
*/
expand?: string[];
/**
* Filter items by property values
*/
filter?: string;
/**
* Order items by property values
*/
orderby?: string[];
/**
* Search items by search phrases
*/
search?: string;
/**
* Select properties to be returned
*/
select?: string[];
/**
* Skip the first n items
*/
skip?: number;
/**
* Show only the first n items
*/
top?: number;
}
/**
* Uri template for the request builder.
*/
export declare const DeviceInstancesRequestBuilderUriTemplate = "{+baseurl}/directory/templates/deviceTemplates/{deviceTemplate%2Did}/deviceInstances{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const DeviceInstancesRequestBuilderNavigationMetadata: Record<Exclude<keyof DeviceInstancesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const DeviceInstancesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map