@microsoft/msgraph-beta-sdk-external
Version:
External fluent API for Microsoft Graph
59 lines • 3.18 kB
TypeScript
import { type Schema } from '@microsoft/msgraph-beta-sdk/models/externalConnectors/index.js';
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the schema property of the microsoft.graph.externalConnectors.externalConnection entity.
*/
export interface SchemaRequestBuilder extends BaseRequestBuilder<SchemaRequestBuilder> {
/**
* Retrieve the properties of a schema for an externalConnection.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Schema>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/externalconnectors-schema-get?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<SchemaRequestBuilderGetQueryParameters> | undefined): Promise<Schema | undefined>;
/**
* Create a new or update an existing schema for a Microsoft Search connection.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Schema>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-patch-schema?view=graph-rest-beta|Find more info here}
*/
patch(body: Schema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Schema | undefined>;
/**
* Retrieve the properties of a schema for an externalConnection.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<SchemaRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create a new or update an existing schema for a Microsoft Search connection.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: Schema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Retrieve the properties of a schema for an externalConnection.
*/
export interface SchemaRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const SchemaRequestBuilderUriTemplate = "{+baseurl}/external/connections/{externalConnection%2Did}/schema{?%24expand,%24select}";
/**
* Metadata for all the requests in the request builder.
*/
export declare const SchemaRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map