DashboardsOperations Class

DashboardsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DashboardsOperations

Constructor

DashboardsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Creates or updates a Dashboard.
delete	Deletes the Dashboard.
get	Gets the Dashboard.
list_by_resource_group	Gets all the Dashboards within a resource group.
list_by_subscription	Gets all the dashboards within a subscription.
update	Updates an existing Dashboard.

create_or_update

Creates or updates a Dashboard.

async create_or_update(resource_group_name: str, dashboard_name: str, dashboard: azure.mgmt.portal.models._models_py3.Dashboard, **kwargs: Any) -> azure.mgmt.portal.models._models_py3.Dashboard

Parameters

resource_group_name

str

Required

The name of the resource group.

dashboard_name

str

Required

The name of the dashboard.

dashboard

Dashboard

Required

The parameters required to create or update a dashboard.

cls

callable

A custom type or function that will be passed the direct response

Returns

Dashboard, or the result of cls(response)

Return type

Dashboard

Exceptions

HttpResponseError

delete

Deletes the Dashboard.

async delete(resource_group_name: str, dashboard_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

dashboard_name

str

Required

The name of the dashboard.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the Dashboard.

async get(resource_group_name: str, dashboard_name: str, **kwargs: Any) -> Optional[azure.mgmt.portal.models._models_py3.Dashboard]

Parameters

resource_group_name

str

Required

The name of the resource group.

dashboard_name

str

Required

The name of the dashboard.

cls

callable

A custom type or function that will be passed the direct response

Returns

Dashboard, or the result of cls(response)

Return type

Dashboard,

None

Exceptions

HttpResponseError

list_by_resource_group

Gets all the Dashboards within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.portal.models._models_py3.DashboardListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DashboardListResult or the result of cls(response)

Return type

AsyncItemPaged[DashboardListResult]

Exceptions

HttpResponseError

list_by_subscription

Gets all the dashboards within a subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.portal.models._models_py3.DashboardListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DashboardListResult or the result of cls(response)

Return type

AsyncItemPaged[DashboardListResult]

Exceptions

HttpResponseError

update

Updates an existing Dashboard.

async update(resource_group_name: str, dashboard_name: str, dashboard: azure.mgmt.portal.models._models_py3.PatchableDashboard, **kwargs: Any) -> Optional[azure.mgmt.portal.models._models_py3.Dashboard]

Parameters

resource_group_name

str

Required

The name of the resource group.

dashboard_name

str

Required

The name of the dashboard.

dashboard

PatchableDashboard

Required

The updatable fields of a Dashboard.

cls

callable

A custom type or function that will be passed the direct response

Returns

Dashboard, or the result of cls(response)

Return type

Dashboard,

None

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.portal.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\portal\\models\\__init__.py'>