@microsoft/msgraph-beta-sdk-admin
Version:
Admin fluent API for Microsoft Graph
99 lines • 5.01 kB
TypeScript
import { type ProfileSource, type ProfileSourceCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type ProfileSourceItemRequestBuilder } 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 profileSources property of the microsoft.graph.peopleAdminSettings entity.
*/
export interface ProfileSourcesRequestBuilder extends BaseRequestBuilder<ProfileSourcesRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the profileSources property of the microsoft.graph.peopleAdminSettings entity.
* @param profileSourceId The unique identifier of profileSource
* @returns {ProfileSourceItemRequestBuilder}
*/
byProfileSourceId(profileSourceId: string): ProfileSourceItemRequestBuilder;
/**
* Get a list of the profileSource objects and their properties, which represent both external data sources and out-of-the-box Microsoft data sources configured for user profiles in an organization.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ProfileSourceCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/peopleadminsettings-list-profilesources?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<ProfileSourcesRequestBuilderGetQueryParameters> | undefined): Promise<ProfileSourceCollectionResponse | undefined>;
/**
* Create a new profileSource object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ProfileSource>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/peopleadminsettings-post-profilesources?view=graph-rest-beta|Find more info here}
*/
post(body: ProfileSource, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ProfileSource | undefined>;
/**
* Get a list of the profileSource objects and their properties, which represent both external data sources and out-of-the-box Microsoft data sources configured for user profiles in an organization.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<ProfileSourcesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create a new profileSource object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: ProfileSource, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get a list of the profileSource objects and their properties, which represent both external data sources and out-of-the-box Microsoft data sources configured for user profiles in an organization.
*/
export interface ProfileSourcesRequestBuilderGetQueryParameters {
/**
* 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 ProfileSourcesRequestBuilderUriTemplate = "{+baseurl}/admin/people/profileSources{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ProfileSourcesRequestBuilderNavigationMetadata: Record<Exclude<keyof ProfileSourcesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ProfileSourcesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map