Interface Dashboards

Package version

Interface representing a Dashboards.

Hierarchy

Dashboards

Implemented by

DashboardsImpl

Index

Methods

Methods

createOrUpdate

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

- Defined in operationsInterfaces/dashboards.ts:50
Creates or updates a 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.
- Optional options: DashboardsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DashboardsCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/dashboards.ts:62
Deletes the Dashboard.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- dashboardName: string
  
  The name of the dashboard.
- Optional options: DashboardsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/dashboards.ts:73
Gets the Dashboard.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- dashboardName: string
  
  The name of the dashboard.
- Optional options: DashboardsGetOptionalParams
  
  The options parameters.
Returns Promise<DashboardsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: DashboardsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Dashboard>

- Defined in operationsInterfaces/dashboards.ts:32
Gets all the Dashboards within a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: DashboardsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Dashboard>

listBySubscription

listBySubscription(options?: DashboardsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Dashboard>

- Defined in operationsInterfaces/dashboards.ts:40
Gets all the dashboards within a subscription.

Parameters
- Optional options: DashboardsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Dashboard>

update

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

- Defined in operationsInterfaces/dashboards.ts:85
Updates an existing 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.
- Optional options: DashboardsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DashboardsUpdateResponse>

Generated using TypeDoc