Interface Workspace

public interface Workspace
An immutable client-side representation of Workspace.

  • 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

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • identity

      Identity identity()
      Gets the identity property: The identity of the resource.
      Returns:
      the identity value.

    • etag

      String etag()
      Gets the etag property: The etag of the workspace.
      Returns:
      the etag value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData 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

      OffsetDateTime createdDate()
      Gets the createdDate property: Workspace creation date.
      Returns:
      the createdDate value.

    • modifiedDate

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

    • replication

      WorkspaceReplicationProperties replication()
      Gets the replication property: workspace replication properties.
      Returns:
      the replication value.

    • failover

      WorkspaceFailoverProperties failover()
      Gets the failover property: workspace failover properties.
      Returns:
      the failover 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

      Workspace refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • failback

      void failback()
      Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • failback

      void failback(com.azure.core.util.Context context)
      Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.