AzureMonitorWorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:azure_monitor_workspaces> attribute.

Inheritance

builtins.object

AzureMonitorWorkspacesOperations

Constructor

AzureMonitorWorkspacesOperations(*args, **kwargs)

Methods

create	Create or update a workspace.
delete	Delete a workspace.
get	Returns the specific Azure Monitor workspace.
list_by_resource_group	Lists all workspaces in the specified resource group.
list_by_subscription	Lists all workspaces in the specified subscription.
update	Updates part of a workspace.

create

Create or update a 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	AzureMonitorWorkspaceResource or IO Properties that need to be specified to create a new workspace. Is either a AzureMonitorWorkspaceResource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AzureMonitorWorkspaceResource	AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete a workspace.

delete(resource_group_name: str, azure_monitor_workspace_name: str, **kwargs: Any) -> 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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Returns the specific 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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AzureMonitorWorkspaceResource	AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all workspaces in the specified resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[AzureMonitorWorkspaceResource]	An iterator like instance of either AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists all workspaces in the specified subscription.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[AzureMonitorWorkspaceResource]	An iterator like instance of either AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates part of a 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 Required	AzureMonitorWorkspaceResourceForUpdate or IO The payload. Is either a AzureMonitorWorkspaceResourceForUpdate type or a IO type. Default value is None.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AzureMonitorWorkspaceResource	AzureMonitorWorkspaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.monitor.v2021_06_03_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2021_06_03_preview\\models\\__init__.py'>