Package com.azure.resourcemanager.kusto.models

Interface Cluster

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

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

    • sku

      AzureSku sku()
      Gets the sku property: The SKU of the cluster.
      Returns:
      the sku value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • zones

      List<String> zones()
      Gets the zones property: The availability zones of the cluster.
      Returns:
      the zones value.

    • identity

      Identity identity()
      Gets the identity property: The identity of the cluster, if configured.
      Returns:
      the identity value.

    • etag

      String etag()
      Gets the etag property: A unique read-only string that changes whenever the resource is updated.
      Returns:
      the etag value.

    • state

      State state()
      Gets the state property: The state of the resource.
      Returns:
      the state value.

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioningState property: The provisioned state of the resource.
      Returns:
      the provisioningState value.

    • uri

      String uri()
      Gets the uri property: The cluster URI.
      Returns:
      the uri value.

    • dataIngestionUri

      String dataIngestionUri()
      Gets the dataIngestionUri property: The cluster data ingestion URI.
      Returns:
      the dataIngestionUri value.

    • stateReason

      String stateReason()
      Gets the stateReason property: The reason for the cluster's current state.
      Returns:
      the stateReason value.

    • trustedExternalTenants

      List<TrustedExternalTenant> trustedExternalTenants()
      Gets the trustedExternalTenants property: The cluster's external tenants.
      Returns:
      the trustedExternalTenants value.

    • optimizedAutoscale

      OptimizedAutoscale optimizedAutoscale()
      Gets the optimizedAutoscale property: Optimized auto scale definition.
      Returns:
      the optimizedAutoscale value.

    • enableDiskEncryption

      Boolean enableDiskEncryption()
      Gets the enableDiskEncryption property: A boolean value that indicates if the cluster's disks are encrypted.
      Returns:
      the enableDiskEncryption value.

    • enableStreamingIngest

      Boolean enableStreamingIngest()
      Gets the enableStreamingIngest property: A boolean value that indicates if the streaming ingest is enabled.
      Returns:
      the enableStreamingIngest value.

    • virtualNetworkConfiguration

      VirtualNetworkConfiguration virtualNetworkConfiguration()
      Gets the virtualNetworkConfiguration property: Virtual network definition.
      Returns:
      the virtualNetworkConfiguration value.

    • keyVaultProperties

      KeyVaultProperties keyVaultProperties()
      Gets the keyVaultProperties property: KeyVault properties for the cluster encryption.
      Returns:
      the keyVaultProperties value.

    • enablePurge

      Boolean enablePurge()
      Gets the enablePurge property: A boolean value that indicates if the purge operations are enabled.
      Returns:
      the enablePurge value.

    • languageExtensions

      LanguageExtensionsList languageExtensions()
      Gets the languageExtensions property: List of the cluster's language extensions.
      Returns:
      the languageExtensions value.

    • enableDoubleEncryption

      Boolean enableDoubleEncryption()
      Gets the enableDoubleEncryption property: A boolean value that indicates if double encryption is enabled.
      Returns:
      the enableDoubleEncryption value.

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Gets the publicNetworkAccess property: Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed.
      Returns:
      the publicNetworkAccess value.

    • allowedIpRangeList

      List<String> allowedIpRangeList()
      Gets the allowedIpRangeList property: The list of ips in the format of CIDR allowed to connect to the cluster.
      Returns:
      the allowedIpRangeList value.

    • engineType

      EngineType engineType()
      Gets the engineType property: The engine type.
      Returns:
      the engineType value.

    • acceptedAudiences

      List<AcceptedAudiences> acceptedAudiences()
      Gets the acceptedAudiences property: The cluster's accepted audiences.
      Returns:
      the acceptedAudiences value.

    • enableAutoStop

      Boolean enableAutoStop()
      Gets the enableAutoStop property: A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).
      Returns:
      the enableAutoStop value.

    • restrictOutboundNetworkAccess

      ClusterNetworkAccessFlag restrictOutboundNetworkAccess()
      Gets the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
      Returns:
      the restrictOutboundNetworkAccess value.

    • allowedFqdnList

      List<String> allowedFqdnList()
      Gets the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.
      Returns:
      the allowedFqdnList value.

    • publicIpType

      PublicIpType publicIpType()
      Gets the publicIpType property: Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6).
      Returns:
      the publicIpType value.

    • virtualClusterGraduationProperties

      String virtualClusterGraduationProperties()
      Gets the virtualClusterGraduationProperties property: Virtual Cluster graduation properties.
      Returns:
      the virtualClusterGraduationProperties value.

    • privateEndpointConnections

      List<PrivateEndpointConnection> privateEndpointConnections()
      Gets the privateEndpointConnections property: A list of private endpoint connections.
      Returns:
      the privateEndpointConnections 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

      ClusterInner innerModel()
      Gets the inner com.azure.resourcemanager.kusto.fluent.models.ClusterInner object.
      Returns:
      the inner object.

    • update

      Cluster.Update update()
      Begins update for the Cluster resource.
      Returns:
      the stage of resource update.

    • refresh

      Cluster refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

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

    • stop

      void stop()
      Stops a Kusto cluster.
      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.

    • stop

      void stop(com.azure.core.util.Context context)
      Stops a Kusto cluster.
      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.

    • start

      void start()
      Starts a Kusto cluster.
      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.

    • start

      void start(com.azure.core.util.Context context)
      Starts a Kusto cluster.
      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.

    • listFollowerDatabases

      com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases()
      Returns a list of databases that are owned by this cluster and were followed by another cluster.
      Returns:
      the list Kusto database principals operation response as paginated response with PagedIterable.
      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.

    • listFollowerDatabases

      com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases(com.azure.core.util.Context context)
      Returns a list of databases that are owned by this cluster and were followed by another cluster.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the list Kusto database principals operation response as paginated response with PagedIterable.
      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.

    • detachFollowerDatabases

      void detachFollowerDatabases(FollowerDatabaseDefinitionInner followerDatabaseToRemove)
      Detaches all followers of a database owned by this cluster.
      Parameters:
      followerDatabaseToRemove - The follower databases properties to remove.
      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.

    • detachFollowerDatabases

      void detachFollowerDatabases(FollowerDatabaseDefinitionInner followerDatabaseToRemove, com.azure.core.util.Context context)
      Detaches all followers of a database owned by this cluster.
      Parameters:
      followerDatabaseToRemove - The follower databases properties to remove.
      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.

    • diagnoseVirtualNetwork

      DiagnoseVirtualNetworkResult diagnoseVirtualNetwork()
      Diagnoses network connectivity status for external resources on which the service is dependent on.
      Returns:
      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.

    • diagnoseVirtualNetwork

      DiagnoseVirtualNetworkResult diagnoseVirtualNetwork(com.azure.core.util.Context context)
      Diagnoses network connectivity status for external resources on which the service is dependent on.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the response.
      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.

    • listLanguageExtensions

      com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions()
      Returns a list of language extensions that can run within KQL queries.
      Returns:
      the list of language extension objects as paginated response with PagedIterable.
      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.

    • listLanguageExtensions

      com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions(com.azure.core.util.Context context)
      Returns a list of language extensions that can run within KQL queries.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the list of language extension objects as paginated response with PagedIterable.
      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.

    • addLanguageExtensions

      void addLanguageExtensions(LanguageExtensionsList languageExtensionsToAdd)
      Add a list of language extensions that can run within KQL queries.
      Parameters:
      languageExtensionsToAdd - The language extensions to add.
      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.

    • addLanguageExtensions

      void addLanguageExtensions(LanguageExtensionsList languageExtensionsToAdd, com.azure.core.util.Context context)
      Add a list of language extensions that can run within KQL queries.
      Parameters:
      languageExtensionsToAdd - The language extensions to add.
      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.

    • removeLanguageExtensions

      void removeLanguageExtensions(LanguageExtensionsList languageExtensionsToRemove)
      Remove a list of language extensions that can run within KQL queries.
      Parameters:
      languageExtensionsToRemove - The language extensions to remove.
      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.

    • removeLanguageExtensions

      void removeLanguageExtensions(LanguageExtensionsList languageExtensionsToRemove, com.azure.core.util.Context context)
      Remove a list of language extensions that can run within KQL queries.
      Parameters:
      languageExtensionsToRemove - The language extensions to remove.
      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.