Workspace Class

The top level Workspace resource container.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.loganalytics.models._models_py3.TrackedResource
Workspace

Constructor

Workspace(*, location: str, tags: Dict[str, str] | None = None, e_tag: str | None = None, provisioning_state: str | WorkspaceEntityStatus | None = None, sku: WorkspaceSku | None = None, retention_in_days: int | None = None, workspace_capping: WorkspaceCapping | None = None, public_network_access_for_ingestion: str | PublicNetworkAccessType | None = 'Enabled', public_network_access_for_query: str | PublicNetworkAccessType | None = 'Enabled', force_cmk_for_query: bool | None = None, features: WorkspaceFeatures | None = None, **kwargs)

Parameters

Name Description
tags
Required

A set of tags. Resource tags.

location
Required
str

Required. The geo-location where the resource lives.

e_tag
Required
str

The ETag of the workspace.

provisioning_state
Required

The provisioning state of the workspace. Possible values include: "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", "Updating".

sku
Required

The SKU of the workspace.

retention_in_days
Required
int

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

workspace_capping
Required

The daily volume cap for ingestion.

public_network_access_for_ingestion
Required

The network access type for accessing Log Analytics ingestion. Possible values include: "Enabled", "Disabled". Default value: "Enabled".

public_network_access_for_query
Required

The network access type for accessing Log Analytics query. Possible values include: "Enabled", "Disabled". Default value: "Enabled".

force_cmk_for_query
Required

Indicates whether customer managed storage is mandatory for query management.

features
Required

Workspace features.

Keyword-Only Parameters

Name Description
location
Required
tags
Required
e_tag
Required
provisioning_state
Required
sku
Required
retention_in_days
Required
workspace_capping
Required
public_network_access_for_ingestion
default value: Enabled
public_network_access_for_query
default value: Enabled
force_cmk_for_query
Required
features
Required

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name
str

The name of the resource.

type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

customer_id
str

This is a read-only property. Represents the ID associated with the workspace.

created_date
str

Workspace creation date.

modified_date
str

Workspace modification date.

private_link_scoped_resources

List of linked private link scope resources.