AzureMonitorWorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:azure_monitor_workspaces> attribute.

Constructor

AzureMonitorWorkspacesOperations(*args, **kwargs)

Methods

begin_delete

Deletes an Azure Monitor Workspace.

create

Creates or updates an Azure Monitor Workspace.

get

Returns the specified Azure Monitor Workspace.

list_by_resource_group

Lists all Azure Monitor Workspaces in the specified resource group.

list_by_subscription

Lists all Azure Monitor Workspaces in the specified subscription.

update

Updates part of an Azure Monitor Workspace.

begin_delete

Deletes an Azure Monitor Workspace.

begin_delete(resource_group_name: str, azure_monitor_workspace_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

azure_monitor_workspace_name
Required
str

The name of the Azure Monitor Workspace. The name is case insensitive. Required.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

create

Creates or updates an Azure Monitor Workspace.

create(resource_group_name: str, azure_monitor_workspace_name: str, azure_monitor_workspace_properties: _models.AzureMonitorWorkspaceResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AzureMonitorWorkspaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

azure_monitor_workspace_name
Required
str

The name of the Azure Monitor Workspace. The name is case insensitive. Required.

azure_monitor_workspace_properties
Required

Properties that need to be specified to create a new Azure Monitor Workspace. Is either a AzureMonitorWorkspaceResource type or a IO[bytes] type. Required.

Returns

Type Description

AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type Description

get

Returns the specified Azure Monitor Workspace.

get(resource_group_name: str, azure_monitor_workspace_name: str, **kwargs: Any) -> AzureMonitorWorkspaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

azure_monitor_workspace_name
Required
str

The name of the Azure Monitor Workspace. The name is case insensitive. Required.

Returns

Type Description

AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type Description

list_by_resource_group

Lists all Azure Monitor Workspaces in the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[AzureMonitorWorkspaceResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Returns

Type Description

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

Exceptions

Type Description

list_by_subscription

Lists all Azure Monitor Workspaces in the specified subscription.

list_by_subscription(**kwargs: Any) -> ItemPaged[AzureMonitorWorkspaceResource]

Returns

Type Description

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

Exceptions

Type Description

update

Updates part of an Azure Monitor Workspace.

update(resource_group_name: str, azure_monitor_workspace_name: str, azure_monitor_workspace_properties: _models.AzureMonitorWorkspaceResourceForUpdate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AzureMonitorWorkspaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

azure_monitor_workspace_name
Required
str

The name of the Azure Monitor Workspace. The name is case insensitive. Required.

azure_monitor_workspace_properties

The payload. Is either a AzureMonitorWorkspaceResourceForUpdate type or a IO[bytes] type. Default value is None.

Default value: None

Returns

Type Description

AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.monitor.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv181\\Lib\\site-packages\\azure\\mgmt\\monitor\\models\\__init__.py'>