Workspace interface

Package:
@azure/arm-operationalinsights

The top level Workspace resource container.

Extends
TrackedResource

Properties

createdDate

Workspace creation date.
customerId

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

The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
etag

The etag of the workspace.
failover

workspace failover properties.
features

Workspace features.
forceCmkForQuery

Indicates whether customer managed storage is mandatory for query management.
identity

The identity of the resource.
modifiedDate

Workspace modification date.
privateLinkScopedResources

List of linked private link scope resources.
provisioningState

The provisioning state of the workspace.
publicNetworkAccessForIngestion

The network access type for accessing Log Analytics ingestion.
publicNetworkAccessForQuery

The network access type for accessing Log Analytics query.
replication

workspace replication properties.
retentionInDays

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

The SKU of the workspace.
workspaceCapping

The daily volume cap for ingestion.

Inherited Properties

id

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

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

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

Property Details

createdDate

Workspace creation date.

createdDate?: Date

Property Value

Date

customerId

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

customerId?: string

Property Value

string

defaultDataCollectionRuleResourceId

The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

defaultDataCollectionRuleResourceId?: string

Property Value

string

etag

The etag of the workspace.

etag?: string

Property Value

string

failover

workspace failover properties.

failover?: WorkspaceFailoverProperties

Property Value

WorkspaceFailoverProperties

features

Workspace features.

features?: WorkspaceFeatures

Property Value

WorkspaceFeatures

forceCmkForQuery

Indicates whether customer managed storage is mandatory for query management.

forceCmkForQuery?: boolean

Property Value

boolean

identity

The identity of the resource.

identity?: Identity

Property Value

Identity

modifiedDate

Workspace modification date.

modifiedDate?: Date

Property Value

Date

privateLinkScopedResources

List of linked private link scope resources.

privateLinkScopedResources?: PrivateLinkScopedResource[]

Property Value

PrivateLinkScopedResource[]

provisioningState

The provisioning state of the workspace.

provisioningState?: string

Property Value

string

publicNetworkAccessForIngestion

The network access type for accessing Log Analytics ingestion.

publicNetworkAccessForIngestion?: string

Property Value

string

publicNetworkAccessForQuery

The network access type for accessing Log Analytics query.

publicNetworkAccessForQuery?: string

Property Value

string

replication

workspace replication properties.

replication?: WorkspaceReplicationProperties

Property Value

WorkspaceReplicationProperties

retentionInDays

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

retentionInDays?: number

Property Value

number

sku

The SKU of the workspace.

sku?: WorkspaceSku

Property Value

WorkspaceSku

workspaceCapping

The daily volume cap for ingestion.

workspaceCapping?: WorkspaceCapping

Property Value

WorkspaceCapping

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type