@shi-corp/sdk-data-gateway
Version:
SDK client used to interface with the SHI Data Gateway service.
39 lines (38 loc) • 2.46 kB
TypeScript
import { type Channel } from '../../../../models/update/shield/index.js';
import { type WithChannelNameItemRequestBuilder } from './item/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Builds and executes requests for operations under /Api/Update/Shield/Channel
*/
export interface ChannelRequestBuilder extends BaseRequestBuilder<ChannelRequestBuilder> {
/**
* Gets an item from the ApiSdk.Api.Update.Shield.Channel.item collection
* @param channelName Name of the deploy channel to operate against.
* @returns {WithChannelNameItemRequestBuilder}
*/
byChannelName(channelName: string): WithChannelNameItemRequestBuilder;
/**
* Retrieves all of the channel configurations that are present in the update service.This endpoint requires the `UpdateShield.ReadWrite.All` scope (permission). This endpoint is also only accessible form the `SHI Lab` tenant. End user access is restricted.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Channel[]>}
*/
get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Channel[] | undefined>;
/**
* Retrieves all of the channel configurations that are present in the update service.This endpoint requires the `UpdateShield.ReadWrite.All` scope (permission). This endpoint is also only accessible form the `SHI Lab` tenant. End user access is restricted.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Uri template for the request builder.
*/
export declare const ChannelRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Shield/Channel";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ChannelRequestBuilderNavigationMetadata: Record<Exclude<keyof ChannelRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ChannelRequestBuilderRequestsMetadata: RequestsMetadata;