Views interface

Interface representing a Views.

Methods

createOrUpdate(string, View, ViewsCreateOrUpdateOptionalParams)

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(string, string, View, ViewsCreateOrUpdateByScopeOptionalParams)

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(string, ViewsDeleteOptionalParams)

The operation to delete a view.

deleteByScope(string, string, ViewsDeleteByScopeOptionalParams)

The operation to delete a view.

get(string, ViewsGetOptionalParams)

Gets the view by view name.

getByScope(string, string, ViewsGetByScopeOptionalParams)

Gets the view for the defined scope by view name.

list(ViewsListOptionalParams)

Lists all views by tenant and object.

listByScope(string, ViewsListByScopeOptionalParams)

Lists all views at the given scope.

Method Details

createOrUpdate(string, View, ViewsCreateOrUpdateOptionalParams)

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.

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

Parameters

viewName

string

View name

parameters
View

Parameters supplied to the CreateOrUpdate View operation.

options
ViewsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<View>

createOrUpdateByScope(string, string, View, ViewsCreateOrUpdateByScopeOptionalParams)

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.

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

Parameters

scope

string

The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.

viewName

string

View name

parameters
View

Parameters supplied to the CreateOrUpdate View operation.

options
ViewsCreateOrUpdateByScopeOptionalParams

The options parameters.

Returns

Promise<View>

delete(string, ViewsDeleteOptionalParams)

The operation to delete a view.

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

Parameters

viewName

string

View name

options
ViewsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteByScope(string, string, ViewsDeleteByScopeOptionalParams)

The operation to delete a view.

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

Parameters

scope

string

The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.

viewName

string

View name

options
ViewsDeleteByScopeOptionalParams

The options parameters.

Returns

Promise<void>

get(string, ViewsGetOptionalParams)

Gets the view by view name.

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

Parameters

viewName

string

View name

options
ViewsGetOptionalParams

The options parameters.

Returns

Promise<View>

getByScope(string, string, ViewsGetByScopeOptionalParams)

Gets the view for the defined scope by view name.

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

Parameters

scope

string

The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.

viewName

string

View name

options
ViewsGetByScopeOptionalParams

The options parameters.

Returns

Promise<View>

list(ViewsListOptionalParams)

Lists all views by tenant and object.

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

Parameters

options
ViewsListOptionalParams

The options parameters.

Returns

listByScope(string, ViewsListByScopeOptionalParams)

Lists all views at the given scope.

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

Parameters

scope

string

The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.

options
ViewsListByScopeOptionalParams

The options parameters.

Returns