ViewsOperations interface

Interface representing a Views operations.

Properties

createOrUpdate

The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

createOrUpdateByScope

The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

delete

The operation to delete a view.

deleteByScope

The operation to delete a view.

get

Gets the view by view name.

getByScope

Gets the view for the defined scope by view name.

list

Lists all views by tenant and object.

listByScope

Lists all views at the given scope.

Property Details

createOrUpdate

The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

createOrUpdate: (viewName: string, parameters: View, options?: ViewsCreateOrUpdateOptionalParams) => Promise<View>

Property Value

(viewName: string, parameters: View, options?: ViewsCreateOrUpdateOptionalParams) => Promise<View>

createOrUpdateByScope

The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

createOrUpdateByScope: (scope: string, viewName: string, parameters: View, options?: ViewsCreateOrUpdateByScopeOptionalParams) => Promise<View>

Property Value

(scope: string, viewName: string, parameters: View, options?: ViewsCreateOrUpdateByScopeOptionalParams) => Promise<View>

delete

The operation to delete a view.

delete: (viewName: string, options?: ViewsDeleteOptionalParams) => Promise<void>

Property Value

(viewName: string, options?: ViewsDeleteOptionalParams) => Promise<void>

deleteByScope

The operation to delete a view.

deleteByScope: (scope: string, viewName: string, options?: ViewsDeleteByScopeOptionalParams) => Promise<void>

Property Value

(scope: string, viewName: string, options?: ViewsDeleteByScopeOptionalParams) => Promise<void>

get

Gets the view by view name.

get: (viewName: string, options?: ViewsGetOptionalParams) => Promise<View>

Property Value

(viewName: string, options?: ViewsGetOptionalParams) => Promise<View>

getByScope

Gets the view for the defined scope by view name.

getByScope: (scope: string, viewName: string, options?: ViewsGetByScopeOptionalParams) => Promise<View>

Property Value

(scope: string, viewName: string, options?: ViewsGetByScopeOptionalParams) => Promise<View>

list

Lists all views by tenant and object.

list: (options?: ViewsListOptionalParams) => PagedAsyncIterableIterator<View, View[], PageSettings>

Property Value

(options?: ViewsListOptionalParams) => PagedAsyncIterableIterator<View, View[], PageSettings>

listByScope

Lists all views at the given scope.

listByScope: (scope: string, options?: ViewsListByScopeOptionalParams) => PagedAsyncIterableIterator<View, View[], PageSettings>

Property Value

(scope: string, options?: ViewsListByScopeOptionalParams) => PagedAsyncIterableIterator<View, View[], PageSettings>