Databases interface
Interface representing a Databases.
Methods
| begin |
Creates a new database. |
| begin |
Creates a new database. |
| begin |
Deletes an existing database. |
| begin |
Deletes an existing database. |
| get(string, string, string, Databases |
Gets information about an existing database. |
| list |
Lists all databases in a server. |
Method Details
beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)
Creates a new database.
function beginCreate(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- databaseName
-
string
Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.
- parameters
- Database
Parameters required to create a new database.
- options
- DatabasesCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)
Creates a new database.
function beginCreateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- databaseName
-
string
Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.
- parameters
- Database
Parameters required to create a new database.
- options
- DatabasesCreateOptionalParams
The options parameters.
Returns
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
Deletes an existing database.
function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesDeleteHeaders>, DatabasesDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- databaseName
-
string
Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.
- options
- DatabasesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesDeleteHeaders>, DatabasesDeleteHeaders>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
Deletes an existing database.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<DatabasesDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- databaseName
-
string
Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.
- options
- DatabasesDeleteOptionalParams
The options parameters.
Returns
Promise<DatabasesDeleteHeaders>
get(string, string, string, DatabasesGetOptionalParams)
Gets information about an existing database.
function get(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- databaseName
-
string
Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.
- options
- DatabasesGetOptionalParams
The options parameters.
Returns
Promise<Database>
listByServer(string, string, DatabasesListByServerOptionalParams)
Lists all databases in a server.
function listByServer(resourceGroupName: string, serverName: string, options?: DatabasesListByServerOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
The options parameters.