Package com.azure.resourcemanager.synapse.models

Interface KustoPool

  • public interface KustoPool
    An immutable client-side representation of KustoPool.

    • Method Detail

      • 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 kusto pool.
        Returns:
        the sku value.

      • etag

        String etag()
        Gets the etag property: A unique read-only string that changes whenever the resource is updated.
        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.

      • state

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

      • provisioningState

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

      • uri

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

      • dataIngestionUri

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

      • stateReason

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

      • optimizedAutoscale

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

      • enableStreamingIngest

        Boolean enableStreamingIngest()
        Gets the enableStreamingIngest property: A boolean value that indicates if the streaming ingest is enabled.
        Returns:
        the enableStreamingIngest 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 Kusto Pool's language extensions.
        Returns:
        the languageExtensions value.

      • workspaceUid

        String workspaceUid()
        Gets the workspaceUid property: The workspace unique identifier.
        Returns:
        the workspaceUid 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.

      • innerModel

        KustoPoolInner innerModel()
        Gets the inner com.azure.resourcemanager.synapse.fluent.models.KustoPoolInner object.
        Returns:
        the inner object.

      • update

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

      • refresh

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

      • refresh

        KustoPool 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 pool.
        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 pool.
        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 pool.
        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 pool.
        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.

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

      • listFollowerDatabases

        com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases()
        Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
        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 Kusto Pool and were followed by another Kusto Pool.
        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 Kusto Pool.
        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 Kusto Pool.
        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.