Package version:

Interface Workspace

The top level Workspace resource container.

Hierarchy

Properties

createdDate? customerId? defaultDataCollectionRuleResourceId? etag? features? forceCmkForQuery? id? identity? location modifiedDate? name? privateLinkScopedResources? provisioningState? publicNetworkAccessForIngestion? publicNetworkAccessForQuery? retentionInDays? sku? systemData? tags? type? workspaceCapping?

Properties

Optional Readonly createdDate

createdDate?: string

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

Optional Readonly customerId

customerId?: string

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.

Optional defaultDataCollectionRuleResourceId

defaultDataCollectionRuleResourceId?: string

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}.

Optional etag

etag?: string

The etag of the workspace.

Optional features

features?: WorkspaceFeatures

Workspace features.

Optional forceCmkForQuery

forceCmkForQuery?: boolean

Indicates whether customer managed storage is mandatory for query management.

Optional Readonly id

id?: string

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.

Optional identity

identity?: Identity

The identity of the resource.

location

location: string

The geo-location where the resource lives

Optional Readonly modifiedDate

modifiedDate?: string

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

Optional Readonly name

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly privateLinkScopedResources

privateLinkScopedResources?: PrivateLinkScopedResource[]

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

Optional Readonly provisioningState

provisioningState?: string

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

Optional publicNetworkAccessForIngestion

publicNetworkAccessForIngestion?: string

The network access type for accessing Log Analytics ingestion.

Optional publicNetworkAccessForQuery

publicNetworkAccessForQuery?: string

The network access type for accessing Log Analytics query.

Optional retentionInDays

retentionInDays?: number

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

Optional sku

sku?: WorkspaceSku

The SKU of the workspace.

Optional Readonly systemData

systemData?: SystemDataAutoGenerated

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.

Optional tags

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

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional Readonly type

type?: string

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.

Optional workspaceCapping

workspaceCapping?: WorkspaceCapping

The daily volume cap for ingestion.

Settings

Member Visibility

Theme

Generated using TypeDoc