Interface Workspace
public interface Workspace
An immutable client-side representation of Workspace.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the Workspace definition.static interface
The Workspace definition stages.static interface
The template for Workspace update.static interface
The Workspace update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the createdDate property: Workspace creation date.Gets the customerId property: This is a read-only property.Gets the defaultDataCollectionRuleResourceId property: The resource ID of the default Data Collection Rule to use for this workspace.etag()
Gets the etag property: The ETag of the workspace.features()
Gets the features property: Workspace features.Gets the forceCmkForQuery property: Indicates whether customer managed storage is mandatory for query management.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.WorkspaceInner object.location()
Gets the location property: The geo-location where the resource lives.Gets the modifiedDate property: Workspace modification date.name()
Gets the name property: The name of the resource.Gets the privateLinkScopedResources property: List of linked private link scope resources.Gets the provisioningState property: The provisioning state of the workspace.Gets the publicNetworkAccessForIngestion property: The network access type for accessing Log Analytics ingestion.Gets the publicNetworkAccessForQuery property: The network access type for accessing Log Analytics query.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.Gets the retentionInDays property: The workspace data retention in days.sku()
Gets the sku property: The SKU of the workspace.Gets the systemData property: Metadata pertaining to creation and last modification of the resource.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the Workspace resource.Gets the workspaceCapping property: The daily volume cap for ingestion.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
systemData
SystemDataAutoGenerated systemData()Gets the systemData property: Metadata pertaining to creation and last modification of the resource.- Returns:
- the systemData value.
-
etag
String etag()Gets the etag property: The ETag of the workspace.- Returns:
- the etag value.
-
provisioningState
WorkspaceEntityStatus provisioningState()Gets the provisioningState property: The provisioning state of the workspace.- Returns:
- the provisioningState value.
-
customerId
String customerId()Gets the customerId property: This is a read-only property. Represents the ID associated with the workspace.- Returns:
- the customerId value.
-
sku
WorkspaceSku sku()Gets the sku property: The SKU of the workspace.- Returns:
- the sku value.
-
retentionInDays
Integer retentionInDays()Gets the retentionInDays property: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.- Returns:
- the retentionInDays value.
-
workspaceCapping
WorkspaceCapping workspaceCapping()Gets the workspaceCapping property: The daily volume cap for ingestion.- Returns:
- the workspaceCapping value.
-
createdDate
String createdDate()Gets the createdDate property: Workspace creation date.- Returns:
- the createdDate value.
-
modifiedDate
String modifiedDate()Gets the modifiedDate property: Workspace modification date.- Returns:
- the modifiedDate value.
-
publicNetworkAccessForIngestion
PublicNetworkAccessType publicNetworkAccessForIngestion()Gets the publicNetworkAccessForIngestion property: The network access type for accessing Log Analytics ingestion.- Returns:
- the publicNetworkAccessForIngestion value.
-
publicNetworkAccessForQuery
PublicNetworkAccessType publicNetworkAccessForQuery()Gets the publicNetworkAccessForQuery property: The network access type for accessing Log Analytics query.- Returns:
- the publicNetworkAccessForQuery value.
-
forceCmkForQuery
Boolean forceCmkForQuery()Gets the forceCmkForQuery property: Indicates whether customer managed storage is mandatory for query management.- Returns:
- the forceCmkForQuery value.
-
privateLinkScopedResources
List<PrivateLinkScopedResource> privateLinkScopedResources()Gets the privateLinkScopedResources property: List of linked private link scope resources.- Returns:
- the privateLinkScopedResources value.
-
features
WorkspaceFeatures features()Gets the features property: Workspace features.- Returns:
- the features value.
-
defaultDataCollectionRuleResourceId
String defaultDataCollectionRuleResourceId()Gets the defaultDataCollectionRuleResourceId property: 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}.- Returns:
- the defaultDataCollectionRuleResourceId value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
WorkspaceInner innerModel()Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.WorkspaceInner object.- Returns:
- the inner object.
-
update
Workspace.Update update()Begins update for the Workspace resource.- Returns:
- the stage of resource update.
-
refresh
Workspace refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-