@microsoft/msgraph-beta-sdk-directory
Version:
Directory fluent API for Microsoft Graph
98 lines • 4.56 kB
TypeScript
import { type TenantReference, type TenantReferenceCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type TenantReferenceTenantItemRequestBuilder } 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 tenants property of the microsoft.graph.outboundSharedUserProfile entity.
*/
export interface TenantsRequestBuilder extends BaseRequestBuilder<TenantsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the tenants property of the microsoft.graph.outboundSharedUserProfile entity.
* @param tenantReferenceTenantId The unique identifier of tenantReference
* @returns {TenantReferenceTenantItemRequestBuilder}
*/
byTenantReferenceTenantId(tenantReferenceTenantId: string): TenantReferenceTenantItemRequestBuilder;
/**
* List the tenant references of an outboundSharedUserProfile.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<TenantReferenceCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/outboundshareduserprofile-list-tenants?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<TenantsRequestBuilderGetQueryParameters> | undefined): Promise<TenantReferenceCollectionResponse | undefined>;
/**
* Create new navigation property to tenants for directory
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<TenantReference>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: TenantReference, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<TenantReference | undefined>;
/**
* List the tenant references of an outboundSharedUserProfile.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<TenantsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to tenants for directory
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: TenantReference, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* List the tenant references of an outboundSharedUserProfile.
*/
export interface TenantsRequestBuilderGetQueryParameters {
/**
* 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 TenantsRequestBuilderUriTemplate = "{+baseurl}/directory/outboundSharedUserProfiles/{outboundSharedUserProfile%2DuserId}/tenants{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const TenantsRequestBuilderNavigationMetadata: Record<Exclude<keyof TenantsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const TenantsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map