@microsoft/msgraph-beta-sdk-solutions/solutions/sharePoint/migrations/crossOrganizationMigrationTasks/index.d.ts

Solutions fluent API for Microsoft Graph

import { type SharePointMigrationTask, type SharePointMigrationTaskCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type GetBySourceGroupMailNicknameWithSourceGroupMailNicknameRequestBuilder } from './getBySourceGroupMailNicknameWithSourceGroupMailNickname/index.js';
import { type GetBySourceSiteUrlWithSourceSiteUrlRequestBuilder } from './getBySourceSiteUrlWithSourceSiteUrl/index.js';
import { type GetBySourceUserPrincipalNameWithSourcePrincipalNameRequestBuilder } from './getBySourceUserPrincipalNameWithSourcePrincipalName/index.js';
import { type SharePointMigrationTaskItemRequestBuilder } 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 crossOrganizationMigrationTasks property of the microsoft.graph.sharePointMigrationsRoot entity.
 */
export interface CrossOrganizationMigrationTasksRequestBuilder extends BaseRequestBuilder<CrossOrganizationMigrationTasksRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the crossOrganizationMigrationTasks property of the microsoft.graph.sharePointMigrationsRoot entity.
     * @param sharePointMigrationTaskId The unique identifier of sharePointMigrationTask
     * @returns {SharePointMigrationTaskItemRequestBuilder}
     */
    bySharePointMigrationTaskId(sharePointMigrationTaskId: string): SharePointMigrationTaskItemRequestBuilder;
    /**
     * Get a sharePointMigrationTask that was previously created, using the task ID. The returned sharePointMigrationTask object includes the source and target site URLs, migration status, optional timestamps (startedDateTime and finishedDateTime), and error details about issues during processing.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<SharePointMigrationTaskCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    get(requestConfiguration?: RequestConfiguration<CrossOrganizationMigrationTasksRequestBuilderGetQueryParameters> | undefined): Promise<SharePointMigrationTaskCollectionResponse | undefined>;
    /**
     * Provides operations to call the getBySourceGroupMailNickname method.
     * @param sourceGroupMailNickname Usage: sourceGroupMailNickname='{sourceGroupMailNickname}'
     * @returns {GetBySourceGroupMailNicknameWithSourceGroupMailNicknameRequestBuilder}
     */
    getBySourceGroupMailNicknameWithSourceGroupMailNickname(sourceGroupMailNickname: string | undefined): GetBySourceGroupMailNicknameWithSourceGroupMailNicknameRequestBuilder;
    /**
     * Provides operations to call the getBySourceSiteUrl method.
     * @param sourceSiteUrl Usage: sourceSiteUrl='{sourceSiteUrl}'
     * @returns {GetBySourceSiteUrlWithSourceSiteUrlRequestBuilder}
     */
    getBySourceSiteUrlWithSourceSiteUrl(sourceSiteUrl: string | undefined): GetBySourceSiteUrlWithSourceSiteUrlRequestBuilder;
    /**
     * Provides operations to call the getBySourceUserPrincipalName method.
     * @param sourcePrincipalName Usage: sourcePrincipalName='{sourcePrincipalName}'
     * @returns {GetBySourceUserPrincipalNameWithSourcePrincipalNameRequestBuilder}
     */
    getBySourceUserPrincipalNameWithSourcePrincipalName(sourcePrincipalName: string | undefined): GetBySourceUserPrincipalNameWithSourcePrincipalNameRequestBuilder;
    /**
     * Create or update a sharePointMigrationTask to migrate a resource from the source organization to the target organization, using the sharePointMigrationTaskParameters. The resource can be a user, a group, or a site. When an existing sharePointMigrationTask is retrieved, it might contain not only the specifics of the source and target organizations and resources, but also the status of the migration and errors encountered during the migration operation. The API calls occur on the source site and only add list items to the my site root web, for example, contoso-my.sharepoint.com. Then, it triggers a multi-geo site move job in the backend to enqueue and orchestrate several tenant workflow jobs, such as backup, restore, and cleanup, supported by TJ infrastructure. The OData type of sharePointResourceMigrationParameters differentiates user migration from site migration, rather than using different subpaths. For a user's OneDrive migration, specify sharePointUserMigrationParameters. If this migration task is a regular SharePoint site migration, specify sharePointSiteMigrationParameters. If this migration task is a group-connected site migration, specify sharePointGroupMigrationParameters.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<SharePointMigrationTask>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/sharepointmigrationtask-update?view=graph-rest-beta|Find more info here}
     */
    post(body: SharePointMigrationTask, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SharePointMigrationTask | undefined>;
    /**
     * Get a sharePointMigrationTask that was previously created, using the task ID. The returned sharePointMigrationTask object includes the source and target site URLs, migration status, optional timestamps (startedDateTime and finishedDateTime), and error details about issues during processing.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<CrossOrganizationMigrationTasksRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create or update a sharePointMigrationTask to migrate a resource from the source organization to the target organization, using the sharePointMigrationTaskParameters. The resource can be a user, a group, or a site. When an existing sharePointMigrationTask is retrieved, it might contain not only the specifics of the source and target organizations and resources, but also the status of the migration and errors encountered during the migration operation. The API calls occur on the source site and only add list items to the my site root web, for example, contoso-my.sharepoint.com. Then, it triggers a multi-geo site move job in the backend to enqueue and orchestrate several tenant workflow jobs, such as backup, restore, and cleanup, supported by TJ infrastructure. The OData type of sharePointResourceMigrationParameters differentiates user migration from site migration, rather than using different subpaths. For a user's OneDrive migration, specify sharePointUserMigrationParameters. If this migration task is a regular SharePoint site migration, specify sharePointSiteMigrationParameters. If this migration task is a group-connected site migration, specify sharePointGroupMigrationParameters.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: SharePointMigrationTask, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get a sharePointMigrationTask that was previously created, using the task ID. The returned sharePointMigrationTask object includes the source and target site URLs, migration status, optional timestamps (startedDateTime and finishedDateTime), and error details about issues during processing.
 */
export interface CrossOrganizationMigrationTasksRequestBuilderGetQueryParameters {
    /**
     * 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 CrossOrganizationMigrationTasksRequestBuilderUriTemplate = "{+baseurl}/solutions/sharePoint/migrations/crossOrganizationMigrationTasks{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const CrossOrganizationMigrationTasksRequestBuilderNavigationMetadata: Record<Exclude<keyof CrossOrganizationMigrationTasksRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const CrossOrganizationMigrationTasksRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map