@microsoft/msgraph-beta-sdk-admin/admin/cloudLicensing/assignments/index.d.ts

Admin fluent API for Microsoft Graph

import { type Assignment, type AssignmentCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/cloudLicensing/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type AssignmentItemRequestBuilder } from './item/index.js';
import { type MicrosoftGraphCloudLicensingReprocessAssignmentsRequestBuilder } from './microsoftGraphCloudLicensingReprocessAssignments/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the assignments property of the microsoft.graph.cloudLicensing.adminCloudLicensing entity.
 */
export interface AssignmentsRequestBuilder extends BaseRequestBuilder<AssignmentsRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to call the reprocessAssignments method.
     */
    get microsoftGraphCloudLicensingReprocessAssignments(): MicrosoftGraphCloudLicensingReprocessAssignmentsRequestBuilder;
    /**
     * Provides operations to manage the assignments property of the microsoft.graph.cloudLicensing.adminCloudLicensing entity.
     * @param assignmentId The unique identifier of assignment
     * @returns {AssignmentItemRequestBuilder}
     */
    byAssignmentId(assignmentId: string): AssignmentItemRequestBuilder;
    /**
     * Get a list of license assignment objects within an organization.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<AssignmentCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/cloudlicensing-admincloudlicensing-list-assignments?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<AssignmentsRequestBuilderGetQueryParameters> | undefined): Promise<AssignmentCollectionResponse | undefined>;
    /**
     * Create a new license assignment by posting to the assignments collection of an organization. An assignment must always have a direct relationship to an allotment and to a user or group. If an assignment is created by posting to the central assignments collection located at /admin/cloudLicensing/assignments, both of those relationships must be established in the request body. Assignments can also be created by posting to the assignments collection of an allotment, the assignments collection of a user or the assignments collection of a group.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Assignment>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/cloudlicensing-admincloudlicensing-post-assignments?view=graph-rest-beta|Find more info here}
     */
    post(body: Assignment, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Assignment | undefined>;
    /**
     * Get a list of license assignment objects within an organization.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<AssignmentsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create a new license assignment by posting to the assignments collection of an organization. An assignment must always have a direct relationship to an allotment and to a user or group. If an assignment is created by posting to the central assignments collection located at /admin/cloudLicensing/assignments, both of those relationships must be established in the request body. Assignments can also be created by posting to the assignments collection of an allotment, the assignments collection of a user or the assignments collection of a group.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: Assignment, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get a list of license assignment objects within an organization.
 */
export interface AssignmentsRequestBuilderGetQueryParameters {
    /**
     * 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 AssignmentsRequestBuilderUriTemplate = "{+baseurl}/admin/cloudLicensing/assignments{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const AssignmentsRequestBuilderNavigationMetadata: Record<Exclude<keyof AssignmentsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const AssignmentsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map