Class WorkspacePatch

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.loganalytics.models.AzureEntityResource
com.azure.resourcemanager.loganalytics.models.WorkspacePatch
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class WorkspacePatch extends AzureEntityResource
The top level Workspace resource container.

  • Constructor Details

    • WorkspacePatch

      public WorkspacePatch()
      Creates an instance of WorkspacePatch class.

  • Method Details

    • identity

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

    • withIdentity

      public WorkspacePatch withIdentity(Identity identity)
      Set the identity property: The identity of the resource.
      Parameters:
      identity - the identity value to set.
      Returns:
      the WorkspacePatch object itself.

    • tags

      public Map<String,String> tags()
      Get the tags property: Resource tags. Optional.
      Returns:
      the tags value.

    • withTags

      public WorkspacePatch withTags(Map<String,String> tags)
      Set the tags property: Resource tags. Optional.
      Parameters:
      tags - the tags value to set.
      Returns:
      the WorkspacePatch object itself.

    • systemData

      public com.azure.core.management.SystemData systemData()
      Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Overrides:
      systemData in class AzureEntityResource
      Returns:
      the systemData value.

    • etag

      public String etag()
      Get the etag property: Resource Etag.
      Overrides:
      etag in class AzureEntityResource
      Returns:
      the etag value.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class AzureEntityResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class AzureEntityResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class AzureEntityResource
      Returns:
      the id value.

    • provisioningState

      public WorkspaceEntityStatus provisioningState()
      Get the provisioningState property: The provisioning state of the workspace.
      Returns:
      the provisioningState value.

    • customerId

      public String customerId()
      Get the customerId property: This is a read-only property. Represents the ID associated with the workspace.
      Returns:
      the customerId value.

    • sku

      public WorkspaceSku sku()
      Get the sku property: The SKU of the workspace.
      Returns:
      the sku value.

    • withSku

      public WorkspacePatch withSku(WorkspaceSku sku)
      Set the sku property: The SKU of the workspace.
      Parameters:
      sku - the sku value to set.
      Returns:
      the WorkspacePatch object itself.

    • retentionInDays

      public Integer retentionInDays()
      Get 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.

    • withRetentionInDays

      public WorkspacePatch withRetentionInDays(Integer retentionInDays)
      Set the retentionInDays property: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
      Parameters:
      retentionInDays - the retentionInDays value to set.
      Returns:
      the WorkspacePatch object itself.

    • workspaceCapping

      public WorkspaceCapping workspaceCapping()
      Get the workspaceCapping property: The daily volume cap for ingestion.
      Returns:
      the workspaceCapping value.

    • withWorkspaceCapping

      public WorkspacePatch withWorkspaceCapping(WorkspaceCapping workspaceCapping)
      Set the workspaceCapping property: The daily volume cap for ingestion.
      Parameters:
      workspaceCapping - the workspaceCapping value to set.
      Returns:
      the WorkspacePatch object itself.

    • createdDate

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

    • modifiedDate

      public OffsetDateTime modifiedDate()
      Get the modifiedDate property: Workspace modification date.
      Returns:
      the modifiedDate value.

    • publicNetworkAccessForIngestion

      public PublicNetworkAccessType publicNetworkAccessForIngestion()
      Get the publicNetworkAccessForIngestion property: The network access type for accessing Log Analytics ingestion.
      Returns:
      the publicNetworkAccessForIngestion value.

    • withPublicNetworkAccessForIngestion

      public WorkspacePatch withPublicNetworkAccessForIngestion(PublicNetworkAccessType publicNetworkAccessForIngestion)
      Set the publicNetworkAccessForIngestion property: The network access type for accessing Log Analytics ingestion.
      Parameters:
      publicNetworkAccessForIngestion - the publicNetworkAccessForIngestion value to set.
      Returns:
      the WorkspacePatch object itself.

    • publicNetworkAccessForQuery

      public PublicNetworkAccessType publicNetworkAccessForQuery()
      Get the publicNetworkAccessForQuery property: The network access type for accessing Log Analytics query.
      Returns:
      the publicNetworkAccessForQuery value.

    • withPublicNetworkAccessForQuery

      public WorkspacePatch withPublicNetworkAccessForQuery(PublicNetworkAccessType publicNetworkAccessForQuery)
      Set the publicNetworkAccessForQuery property: The network access type for accessing Log Analytics query.
      Parameters:
      publicNetworkAccessForQuery - the publicNetworkAccessForQuery value to set.
      Returns:
      the WorkspacePatch object itself.

    • forceCmkForQuery

      public Boolean forceCmkForQuery()
      Get the forceCmkForQuery property: Indicates whether customer managed storage is mandatory for query management.
      Returns:
      the forceCmkForQuery value.

    • withForceCmkForQuery

      public WorkspacePatch withForceCmkForQuery(Boolean forceCmkForQuery)
      Set the forceCmkForQuery property: Indicates whether customer managed storage is mandatory for query management.
      Parameters:
      forceCmkForQuery - the forceCmkForQuery value to set.
      Returns:
      the WorkspacePatch object itself.

    • privateLinkScopedResources

      public List<PrivateLinkScopedResource> privateLinkScopedResources()
      Get the privateLinkScopedResources property: List of linked private link scope resources.
      Returns:
      the privateLinkScopedResources value.

    • features

      public WorkspaceFeatures features()
      Get the features property: Workspace features.
      Returns:
      the features value.

    • withFeatures

      public WorkspacePatch withFeatures(WorkspaceFeatures features)
      Set the features property: Workspace features.
      Parameters:
      features - the features value to set.
      Returns:
      the WorkspacePatch object itself.

    • defaultDataCollectionRuleResourceId

      public String defaultDataCollectionRuleResourceId()
      Get 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.

    • withDefaultDataCollectionRuleResourceId

      public WorkspacePatch withDefaultDataCollectionRuleResourceId(String defaultDataCollectionRuleResourceId)
      Set 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}.
      Parameters:
      defaultDataCollectionRuleResourceId - the defaultDataCollectionRuleResourceId value to set.
      Returns:
      the WorkspacePatch object itself.

    • replication

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

    • withReplication

      public WorkspacePatch withReplication(WorkspaceReplicationProperties replication)
      Set the replication property: workspace replication properties.
      Parameters:
      replication - the replication value to set.
      Returns:
      the WorkspacePatch object itself.

    • failover

      public WorkspaceFailoverProperties failover()
      Get the failover property: workspace failover properties.
      Returns:
      the failover value.

    • withFailover

      public WorkspacePatch withFailover(WorkspaceFailoverProperties failover)
      Set the failover property: workspace failover properties.
      Parameters:
      failover - the failover value to set.
      Returns:
      the WorkspacePatch object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class AzureEntityResource
      Throws:
      IOException

    • fromJson

      public static WorkspacePatch fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of WorkspacePatch from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of WorkspacePatch if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the WorkspacePatch.