Dashboards interface

Package:

@azure/arm-portal

Interface representing a Dashboards.

Methods

createOrUpdate(string, string, Dashboard, DashboardsCreateOrUpdateOptionalParams)	Creates or updates a Dashboard.
delete(string, string, DashboardsDeleteOptionalParams)	Deletes the Dashboard.
get(string, string, DashboardsGetOptionalParams)	Gets the Dashboard.
listByResourceGroup(string, DashboardsListByResourceGroupOptionalParams)	Gets all the Dashboards within a resource group.
listBySubscription(DashboardsListBySubscriptionOptionalParams)	Gets all the dashboards within a subscription.
update(string, string, PatchableDashboard, DashboardsUpdateOptionalParams)	Updates an existing Dashboard.

Method Details

createOrUpdate(string, string, Dashboard, DashboardsCreateOrUpdateOptionalParams)

Creates or updates a Dashboard.

function createOrUpdate(resourceGroupName: string, dashboardName: string, dashboard: Dashboard, options?: DashboardsCreateOrUpdateOptionalParams): Promise<Dashboard>

Parameters

resourceGroupName

string

The name of the resource group.

dashboardName

string

The name of the dashboard.

dashboard

Dashboard

The parameters required to create or update a dashboard.

options

DashboardsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Dashboard>

delete(string, string, DashboardsDeleteOptionalParams)

Deletes the Dashboard.

function delete(resourceGroupName: string, dashboardName: string, options?: DashboardsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

dashboardName

string

The name of the dashboard.

options

DashboardsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DashboardsGetOptionalParams)

Gets the Dashboard.

function get(resourceGroupName: string, dashboardName: string, options?: DashboardsGetOptionalParams): Promise<Dashboard>

Parameters

resourceGroupName

string

The name of the resource group.

dashboardName

string

The name of the dashboard.

options

DashboardsGetOptionalParams

The options parameters.

Returns

Promise<Dashboard>

listByResourceGroup(string, DashboardsListByResourceGroupOptionalParams)

Gets all the Dashboards within a resource group.

function listByResourceGroup(resourceGroupName: string, options?: DashboardsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Dashboard, Dashboard[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

DashboardsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Dashboard, Dashboard[], PageSettings>

listBySubscription(DashboardsListBySubscriptionOptionalParams)

Gets all the dashboards within a subscription.

function listBySubscription(options?: DashboardsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Dashboard, Dashboard[], PageSettings>

Parameters

options

DashboardsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Dashboard, Dashboard[], PageSettings>

update(string, string, PatchableDashboard, DashboardsUpdateOptionalParams)

Updates an existing Dashboard.

function update(resourceGroupName: string, dashboardName: string, dashboard: PatchableDashboard, options?: DashboardsUpdateOptionalParams): Promise<Dashboard>

Parameters

resourceGroupName

string

The name of the resource group.

dashboardName

string

The name of the dashboard.

dashboard

PatchableDashboard

The updatable fields of a Dashboard.

options

DashboardsUpdateOptionalParams

The options parameters.

Returns

Promise<Dashboard>