KustoPoolDatabases.yml

### YamlMime:TSType
name: KustoPoolDatabases
uid: '@azure/arm-synapse.KustoPoolDatabases'
package: '@azure/arm-synapse'
summary: Interface representing a KustoPoolDatabases.
fullName: KustoPoolDatabases
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginCreateOrUpdate(string, string, string, string, DatabaseUnion,
      KustoPoolDatabasesCreateOrUpdateOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginCreateOrUpdate'
    package: '@azure/arm-synapse'
    summary: Creates or updates a database.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdate(resourceGroupName: string, workspaceName:
        string, kustoPoolName: string, databaseName: string, parameters:
        DatabaseUnion, options?:
        KustoPoolDatabasesCreateOrUpdateOptionalParams):
        Promise<PollerLike<PollOperationState<DatabaseUnion>, DatabaseUnion>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: parameters
          type: <xref uid="@azure/arm-synapse.DatabaseUnion" />
          description: The database parameters supplied to the CreateOrUpdate operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-synapse.DatabaseUnion" />&gt;, <xref
          uid="@azure/arm-synapse.DatabaseUnion" />&gt;&gt;
  - name: >-
      beginCreateOrUpdateAndWait(string, string, string, string, DatabaseUnion,
      KustoPoolDatabasesCreateOrUpdateOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginCreateOrUpdateAndWait'
    package: '@azure/arm-synapse'
    summary: Creates or updates a database.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdateAndWait(resourceGroupName: string,
        workspaceName: string, kustoPoolName: string, databaseName: string,
        parameters: DatabaseUnion, options?:
        KustoPoolDatabasesCreateOrUpdateOptionalParams): Promise<DatabaseUnion>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: parameters
          type: <xref uid="@azure/arm-synapse.DatabaseUnion" />
          description: The database parameters supplied to the CreateOrUpdate operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-synapse.DatabaseUnion" />&gt;
  - name: >-
      beginDelete(string, string, string, string,
      KustoPoolDatabasesDeleteOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginDelete'
    package: '@azure/arm-synapse'
    summary: Deletes the database with the given name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDelete(resourceGroupName: string, workspaceName: string,
        kustoPoolName: string, databaseName: string, options?:
        KustoPoolDatabasesDeleteOptionalParams):
        Promise<PollerLike<PollOperationState<void>, void>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesDeleteOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;void&gt;, void&gt;&gt;
  - name: >-
      beginDeleteAndWait(string, string, string, string,
      KustoPoolDatabasesDeleteOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginDeleteAndWait'
    package: '@azure/arm-synapse'
    summary: Deletes the database with the given name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDeleteAndWait(resourceGroupName: string, workspaceName:
        string, kustoPoolName: string, databaseName: string, options?:
        KustoPoolDatabasesDeleteOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesDeleteOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      beginUpdate(string, string, string, string, DatabaseUnion,
      KustoPoolDatabasesUpdateOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginUpdate'
    package: '@azure/arm-synapse'
    summary: Updates a database.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdate(resourceGroupName: string, workspaceName: string,
        kustoPoolName: string, databaseName: string, parameters: DatabaseUnion,
        options?: KustoPoolDatabasesUpdateOptionalParams):
        Promise<PollerLike<PollOperationState<DatabaseUnion>, DatabaseUnion>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: parameters
          type: <xref uid="@azure/arm-synapse.DatabaseUnion" />
          description: The database parameters supplied to the Update operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-synapse.DatabaseUnion" />&gt;, <xref
          uid="@azure/arm-synapse.DatabaseUnion" />&gt;&gt;
  - name: >-
      beginUpdateAndWait(string, string, string, string, DatabaseUnion,
      KustoPoolDatabasesUpdateOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.beginUpdateAndWait'
    package: '@azure/arm-synapse'
    summary: Updates a database.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdateAndWait(resourceGroupName: string, workspaceName:
        string, kustoPoolName: string, databaseName: string, parameters:
        DatabaseUnion, options?: KustoPoolDatabasesUpdateOptionalParams):
        Promise<DatabaseUnion>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: parameters
          type: <xref uid="@azure/arm-synapse.DatabaseUnion" />
          description: The database parameters supplied to the Update operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-synapse.DatabaseUnion" />&gt;
  - name: get(string, string, string, string, KustoPoolDatabasesGetOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.get'
    package: '@azure/arm-synapse'
    summary: Returns a database.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, workspaceName: string,
        kustoPoolName: string, databaseName: string, options?:
        KustoPoolDatabasesGetOptionalParams): Promise<DatabaseUnion>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: databaseName
          type: string
          description: The name of the database in the Kusto pool.
        - id: options
          type: >-
            <xref uid="@azure/arm-synapse.KustoPoolDatabasesGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-synapse.DatabaseUnion" />&gt;
  - name: >-
      listByKustoPool(string, string, string,
      KustoPoolDatabasesListByKustoPoolOptionalParams)
    uid: '@azure/arm-synapse.KustoPoolDatabases.listByKustoPool'
    package: '@azure/arm-synapse'
    summary: Returns the list of databases of the given Kusto pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByKustoPool(resourceGroupName: string, workspaceName:
        string, kustoPoolName: string, options?:
        KustoPoolDatabasesListByKustoPoolOptionalParams):
        PagedAsyncIterableIterator<DatabaseUnion, DatabaseUnion[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group. The name is case insensitive.
        - id: workspaceName
          type: string
          description: The name of the workspace.
        - id: kustoPoolName
          type: string
          description: The name of the Kusto pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-synapse.KustoPoolDatabasesListByKustoPoolOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-synapse.DatabaseUnion" />, <xref
          uid="@azure/arm-synapse.DatabaseUnion" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;