Workspace interface

Package:

@azure/arm-operationalinsights

The top level Workspace resource container.

Extends

TrackedResource

Properties

createdDate	Workspace creation date. NOTE: This property will not be serialized. It can only be populated by the server.
customerId	This is a read-only property. Represents the ID associated with the workspace. NOTE: This property will not be serialized. It can only be populated by the server.
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.
features	Workspace features.
forceCmkForQuery	Indicates whether customer managed storage is mandatory for query management.
identity	The identity of the resource.
modifiedDate	Workspace modification date. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkScopedResources	List of linked private link scope resources. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The provisioning state of the workspace. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccessForIngestion	The network access type for accessing Log Analytics ingestion.
publicNetworkAccessForQuery	The network access type for accessing Log Analytics query.
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.
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
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} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

createdDate

Workspace creation date. NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: string

Property Value

string

customerId

This is a read-only property. Represents the ID associated with the workspace. NOTE: This property will not be serialized. It can only be populated by the server.

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedDate?: string

Property Value

string

privateLinkScopedResources

List of linked private link scope resources. NOTE: This property will not be serialized. It can only be populated by the server.

privateLinkScopedResources?: PrivateLinkScopedResource[]

Property Value

PrivateLinkScopedResource[]

provisioningState

The provisioning state of the workspace. NOTE: This property will not be serialized. It can only be populated by the server.

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

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

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemDataAutoGenerated

Property Value

SystemDataAutoGenerated

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} NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type