SqlPools interface
Interface representing a SqlPools.
Methods
Method Details
beginCreate(string, string, string, SqlPool, SqlPoolsCreateOptionalParams)
Create a SQL pool
function beginCreate(resourceGroupName: string, workspaceName: string, sqlPoolName: string, sqlPoolInfo: SqlPool, options?: SqlPoolsCreateOptionalParams): Promise<PollerLike<PollOperationState<SqlPool>, SqlPool>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- sqlPoolInfo
- SqlPool
The SQL pool to create
- options
- SqlPoolsCreateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SqlPool>, SqlPool>>
beginCreateAndWait(string, string, string, SqlPool, SqlPoolsCreateOptionalParams)
Create a SQL pool
function beginCreateAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, sqlPoolInfo: SqlPool, options?: SqlPoolsCreateOptionalParams): Promise<SqlPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- sqlPoolInfo
- SqlPool
The SQL pool to create
- options
- SqlPoolsCreateOptionalParams
The options parameters.
Returns
Promise<SqlPool>
beginDelete(string, string, string, SqlPoolsDeleteOptionalParams)
Delete a SQL pool
function beginDelete(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<SqlPoolsDeleteResponse>, SqlPoolsDeleteResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SqlPoolsDeleteResponse>, SqlPoolsDeleteResponse>>
beginDeleteAndWait(string, string, string, SqlPoolsDeleteOptionalParams)
Delete a SQL pool
function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsDeleteOptionalParams): Promise<SqlPoolsDeleteResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<SqlPoolsDeleteResponse>
beginPause(string, string, string, SqlPoolsPauseOptionalParams)
Pause a SQL pool
function beginPause(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsPauseOptionalParams): Promise<PollerLike<PollOperationState<SqlPoolsPauseResponse>, SqlPoolsPauseResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsPauseOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SqlPoolsPauseResponse>, SqlPoolsPauseResponse>>
beginPauseAndWait(string, string, string, SqlPoolsPauseOptionalParams)
Pause a SQL pool
function beginPauseAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsPauseOptionalParams): Promise<SqlPoolsPauseResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsPauseOptionalParams
The options parameters.
Returns
Promise<SqlPoolsPauseResponse>
beginResume(string, string, string, SqlPoolsResumeOptionalParams)
Resume a SQL pool
function beginResume(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsResumeOptionalParams): Promise<PollerLike<PollOperationState<SqlPoolsResumeResponse>, SqlPoolsResumeResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsResumeOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SqlPoolsResumeResponse>, SqlPoolsResumeResponse>>
beginResumeAndWait(string, string, string, SqlPoolsResumeOptionalParams)
Resume a SQL pool
function beginResumeAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsResumeOptionalParams): Promise<SqlPoolsResumeResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsResumeOptionalParams
The options parameters.
Returns
Promise<SqlPoolsResumeResponse>
get(string, string, string, SqlPoolsGetOptionalParams)
Get SQL pool properties
function get(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolsGetOptionalParams): Promise<SqlPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- options
- SqlPoolsGetOptionalParams
The options parameters.
Returns
Promise<SqlPool>
listByWorkspace(string, string, SqlPoolsListByWorkspaceOptionalParams)
List all SQL pools
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: SqlPoolsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<SqlPool, SqlPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
The options parameters.
Returns
rename(string, string, string, ResourceMoveDefinition, SqlPoolsRenameOptionalParams)
Rename a SQL pool.
function rename(resourceGroupName: string, workspaceName: string, sqlPoolName: string, parameters: ResourceMoveDefinition, options?: SqlPoolsRenameOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- parameters
- ResourceMoveDefinition
The resource move definition for renaming this Sql pool.
- options
- SqlPoolsRenameOptionalParams
The options parameters.
Returns
Promise<void>
update(string, string, string, SqlPoolPatchInfo, SqlPoolsUpdateOptionalParams)
Apply a partial update to a SQL pool
function update(resourceGroupName: string, workspaceName: string, sqlPoolName: string, sqlPoolInfo: SqlPoolPatchInfo, options?: SqlPoolsUpdateOptionalParams): Promise<SqlPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- sqlPoolName
-
string
SQL pool name
- sqlPoolInfo
- SqlPoolPatchInfo
The updated SQL pool properties
- options
- SqlPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<SqlPool>