SqlResources interface

Reference

Package:: @azure/arm-cosmosdb

Interface representing a SqlResources.

Methods

beginCreateUpdateClientEncryptionKey(string, string, string, string, ClientEncryptionKeyCreateUpdateParameters, SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams)	Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
beginCreateUpdateClientEncryptionKeyAndWait(string, string, string, string, ClientEncryptionKeyCreateUpdateParameters, SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams)	Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
beginCreateUpdateSqlContainer(string, string, string, string, SqlContainerCreateUpdateParameters, SqlResourcesCreateUpdateSqlContainerOptionalParams)	Create or update an Azure Cosmos DB SQL container
beginCreateUpdateSqlContainerAndWait(string, string, string, string, SqlContainerCreateUpdateParameters, SqlResourcesCreateUpdateSqlContainerOptionalParams)	Create or update an Azure Cosmos DB SQL container
beginCreateUpdateSqlDatabase(string, string, string, SqlDatabaseCreateUpdateParameters, SqlResourcesCreateUpdateSqlDatabaseOptionalParams)	Create or update an Azure Cosmos DB SQL database
beginCreateUpdateSqlDatabaseAndWait(string, string, string, SqlDatabaseCreateUpdateParameters, SqlResourcesCreateUpdateSqlDatabaseOptionalParams)	Create or update an Azure Cosmos DB SQL database
beginCreateUpdateSqlRoleAssignment(string, string, string, SqlRoleAssignmentCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams)	Creates or updates an Azure Cosmos DB SQL Role Assignment.
beginCreateUpdateSqlRoleAssignmentAndWait(string, string, string, SqlRoleAssignmentCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams)	Creates or updates an Azure Cosmos DB SQL Role Assignment.
beginCreateUpdateSqlRoleDefinition(string, string, string, SqlRoleDefinitionCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams)	Creates or updates an Azure Cosmos DB SQL Role Definition.
beginCreateUpdateSqlRoleDefinitionAndWait(string, string, string, SqlRoleDefinitionCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams)	Creates or updates an Azure Cosmos DB SQL Role Definition.
beginCreateUpdateSqlStoredProcedure(string, string, string, string, string, SqlStoredProcedureCreateUpdateParameters, SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams)	Create or update an Azure Cosmos DB SQL storedProcedure
beginCreateUpdateSqlStoredProcedureAndWait(string, string, string, string, string, SqlStoredProcedureCreateUpdateParameters, SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams)	Create or update an Azure Cosmos DB SQL storedProcedure
beginCreateUpdateSqlTrigger(string, string, string, string, string, SqlTriggerCreateUpdateParameters, SqlResourcesCreateUpdateSqlTriggerOptionalParams)	Create or update an Azure Cosmos DB SQL trigger
beginCreateUpdateSqlTriggerAndWait(string, string, string, string, string, SqlTriggerCreateUpdateParameters, SqlResourcesCreateUpdateSqlTriggerOptionalParams)	Create or update an Azure Cosmos DB SQL trigger
beginCreateUpdateSqlUserDefinedFunction(string, string, string, string, string, SqlUserDefinedFunctionCreateUpdateParameters, SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams)	Create or update an Azure Cosmos DB SQL userDefinedFunction
beginCreateUpdateSqlUserDefinedFunctionAndWait(string, string, string, string, string, SqlUserDefinedFunctionCreateUpdateParameters, SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams)	Create or update an Azure Cosmos DB SQL userDefinedFunction
beginDeleteSqlContainer(string, string, string, string, SqlResourcesDeleteSqlContainerOptionalParams)	Deletes an existing Azure Cosmos DB SQL container.
beginDeleteSqlContainerAndWait(string, string, string, string, SqlResourcesDeleteSqlContainerOptionalParams)	Deletes an existing Azure Cosmos DB SQL container.
beginDeleteSqlDatabase(string, string, string, SqlResourcesDeleteSqlDatabaseOptionalParams)	Deletes an existing Azure Cosmos DB SQL database.
beginDeleteSqlDatabaseAndWait(string, string, string, SqlResourcesDeleteSqlDatabaseOptionalParams)	Deletes an existing Azure Cosmos DB SQL database.
beginDeleteSqlRoleAssignment(string, string, string, SqlResourcesDeleteSqlRoleAssignmentOptionalParams)	Deletes an existing Azure Cosmos DB SQL Role Assignment.
beginDeleteSqlRoleAssignmentAndWait(string, string, string, SqlResourcesDeleteSqlRoleAssignmentOptionalParams)	Deletes an existing Azure Cosmos DB SQL Role Assignment.
beginDeleteSqlRoleDefinition(string, string, string, SqlResourcesDeleteSqlRoleDefinitionOptionalParams)	Deletes an existing Azure Cosmos DB SQL Role Definition.
beginDeleteSqlRoleDefinitionAndWait(string, string, string, SqlResourcesDeleteSqlRoleDefinitionOptionalParams)	Deletes an existing Azure Cosmos DB SQL Role Definition.
beginDeleteSqlStoredProcedure(string, string, string, string, string, SqlResourcesDeleteSqlStoredProcedureOptionalParams)	Deletes an existing Azure Cosmos DB SQL storedProcedure.
beginDeleteSqlStoredProcedureAndWait(string, string, string, string, string, SqlResourcesDeleteSqlStoredProcedureOptionalParams)	Deletes an existing Azure Cosmos DB SQL storedProcedure.
beginDeleteSqlTrigger(string, string, string, string, string, SqlResourcesDeleteSqlTriggerOptionalParams)	Deletes an existing Azure Cosmos DB SQL trigger.
beginDeleteSqlTriggerAndWait(string, string, string, string, string, SqlResourcesDeleteSqlTriggerOptionalParams)	Deletes an existing Azure Cosmos DB SQL trigger.
beginDeleteSqlUserDefinedFunction(string, string, string, string, string, SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams)	Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
beginDeleteSqlUserDefinedFunctionAndWait(string, string, string, string, string, SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams)	Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
beginListSqlContainerPartitionMerge(string, string, string, string, MergeParameters, SqlResourcesListSqlContainerPartitionMergeOptionalParams)	Merges the partitions of a SQL Container
beginListSqlContainerPartitionMergeAndWait(string, string, string, string, MergeParameters, SqlResourcesListSqlContainerPartitionMergeOptionalParams)	Merges the partitions of a SQL Container
beginMigrateSqlContainerToAutoscale(string, string, string, string, SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
beginMigrateSqlContainerToAutoscaleAndWait(string, string, string, string, SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
beginMigrateSqlContainerToManualThroughput(string, string, string, string, SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
beginMigrateSqlContainerToManualThroughputAndWait(string, string, string, string, SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
beginMigrateSqlDatabaseToAutoscale(string, string, string, SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
beginMigrateSqlDatabaseToAutoscaleAndWait(string, string, string, SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
beginMigrateSqlDatabaseToManualThroughput(string, string, string, SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
beginMigrateSqlDatabaseToManualThroughputAndWait(string, string, string, SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, SqlResourcesRetrieveContinuousBackupInformationOptionalParams)	Retrieves continuous backup information for a container resource.
beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, SqlResourcesRetrieveContinuousBackupInformationOptionalParams)	Retrieves continuous backup information for a container resource.
beginSqlContainerRedistributeThroughput(string, string, string, string, RedistributeThroughputParameters, SqlResourcesSqlContainerRedistributeThroughputOptionalParams)	Redistribute throughput for an Azure Cosmos DB SQL container
beginSqlContainerRedistributeThroughputAndWait(string, string, string, string, RedistributeThroughputParameters, SqlResourcesSqlContainerRedistributeThroughputOptionalParams)	Redistribute throughput for an Azure Cosmos DB SQL container
beginSqlContainerRetrieveThroughputDistribution(string, string, string, string, RetrieveThroughputParameters, SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams)	Retrieve throughput distribution for an Azure Cosmos DB SQL container
beginSqlContainerRetrieveThroughputDistributionAndWait(string, string, string, string, RetrieveThroughputParameters, SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams)	Retrieve throughput distribution for an Azure Cosmos DB SQL container
beginSqlDatabasePartitionMerge(string, string, string, MergeParameters, SqlResourcesSqlDatabasePartitionMergeOptionalParams)	Merges the partitions of a SQL database
beginSqlDatabasePartitionMergeAndWait(string, string, string, MergeParameters, SqlResourcesSqlDatabasePartitionMergeOptionalParams)	Merges the partitions of a SQL database
beginSqlDatabaseRedistributeThroughput(string, string, string, RedistributeThroughputParameters, SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams)	Redistribute throughput for an Azure Cosmos DB SQL database
beginSqlDatabaseRedistributeThroughputAndWait(string, string, string, RedistributeThroughputParameters, SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams)	Redistribute throughput for an Azure Cosmos DB SQL database
beginSqlDatabaseRetrieveThroughputDistribution(string, string, string, RetrieveThroughputParameters, SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams)	Retrieve throughput distribution for an Azure Cosmos DB SQL database
beginSqlDatabaseRetrieveThroughputDistributionAndWait(string, string, string, RetrieveThroughputParameters, SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams)	Retrieve throughput distribution for an Azure Cosmos DB SQL database
beginUpdateSqlContainerThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlContainerThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB SQL container
beginUpdateSqlContainerThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlContainerThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB SQL container
beginUpdateSqlDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlDatabaseThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB SQL database
beginUpdateSqlDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlDatabaseThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB SQL database
getClientEncryptionKey(string, string, string, string, SqlResourcesGetClientEncryptionKeyOptionalParams)	Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
getSqlContainer(string, string, string, string, SqlResourcesGetSqlContainerOptionalParams)	Gets the SQL container under an existing Azure Cosmos DB database account.
getSqlContainerThroughput(string, string, string, string, SqlResourcesGetSqlContainerThroughputOptionalParams)	Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
getSqlDatabase(string, string, string, SqlResourcesGetSqlDatabaseOptionalParams)	Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
getSqlDatabaseThroughput(string, string, string, SqlResourcesGetSqlDatabaseThroughputOptionalParams)	Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.
getSqlRoleAssignment(string, string, string, SqlResourcesGetSqlRoleAssignmentOptionalParams)	Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.
getSqlRoleDefinition(string, string, string, SqlResourcesGetSqlRoleDefinitionOptionalParams)	Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
getSqlStoredProcedure(string, string, string, string, string, SqlResourcesGetSqlStoredProcedureOptionalParams)	Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
getSqlTrigger(string, string, string, string, string, SqlResourcesGetSqlTriggerOptionalParams)	Gets the SQL trigger under an existing Azure Cosmos DB database account.
getSqlUserDefinedFunction(string, string, string, string, string, SqlResourcesGetSqlUserDefinedFunctionOptionalParams)	Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
listClientEncryptionKeys(string, string, string, SqlResourcesListClientEncryptionKeysOptionalParams)	Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
listSqlContainers(string, string, string, SqlResourcesListSqlContainersOptionalParams)	Lists the SQL container under an existing Azure Cosmos DB database account.
listSqlDatabases(string, string, SqlResourcesListSqlDatabasesOptionalParams)	Lists the SQL databases under an existing Azure Cosmos DB database account.
listSqlRoleAssignments(string, string, SqlResourcesListSqlRoleAssignmentsOptionalParams)	Retrieves the list of all Azure Cosmos DB SQL Role Assignments.
listSqlRoleDefinitions(string, string, SqlResourcesListSqlRoleDefinitionsOptionalParams)	Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
listSqlStoredProcedures(string, string, string, string, SqlResourcesListSqlStoredProceduresOptionalParams)	Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
listSqlTriggers(string, string, string, string, SqlResourcesListSqlTriggersOptionalParams)	Lists the SQL trigger under an existing Azure Cosmos DB database account.
listSqlUserDefinedFunctions(string, string, string, string, SqlResourcesListSqlUserDefinedFunctionsOptionalParams)	Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

Method Details

beginCreateUpdateClientEncryptionKey(string, string, string, string, ClientEncryptionKeyCreateUpdateParameters, SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams)

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

function beginCreateUpdateClientEncryptionKey(resourceGroupName: string, accountName: string, databaseName: string, clientEncryptionKeyName: string, createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters, options?: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams): Promise<SimplePollerLike<OperationState<ClientEncryptionKeyGetResults>, ClientEncryptionKeyGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

clientEncryptionKeyName: string

Cosmos DB ClientEncryptionKey name.

createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters

The parameters to provide for the client encryption key.

options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ClientEncryptionKeyGetResults>, ClientEncryptionKeyGetResults>>

beginCreateUpdateClientEncryptionKeyAndWait(string, string, string, string, ClientEncryptionKeyCreateUpdateParameters, SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams)

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

function beginCreateUpdateClientEncryptionKeyAndWait(resourceGroupName: string, accountName: string, databaseName: string, clientEncryptionKeyName: string, createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters, options?: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams): Promise<ClientEncryptionKeyGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

clientEncryptionKeyName: string

Cosmos DB ClientEncryptionKey name.

createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters

The parameters to provide for the client encryption key.

options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<ClientEncryptionKeyGetResults>

beginCreateUpdateSqlContainer(string, string, string, string, SqlContainerCreateUpdateParameters, SqlResourcesCreateUpdateSqlContainerOptionalParams)

Create or update an Azure Cosmos DB SQL container

function beginCreateUpdateSqlContainer(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlContainerOptionalParams): Promise<SimplePollerLike<OperationState<SqlContainerGetResults>, SqlContainerGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters

The parameters to provide for the current SQL container.

options: SqlResourcesCreateUpdateSqlContainerOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlContainerGetResults>, SqlContainerGetResults>>

beginCreateUpdateSqlContainerAndWait(string, string, string, string, SqlContainerCreateUpdateParameters, SqlResourcesCreateUpdateSqlContainerOptionalParams)

Create or update an Azure Cosmos DB SQL container

function beginCreateUpdateSqlContainerAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlContainerOptionalParams): Promise<SqlContainerGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters

The parameters to provide for the current SQL container.

options: SqlResourcesCreateUpdateSqlContainerOptionalParams

The options parameters.

Returns

Promise<SqlContainerGetResults>

beginCreateUpdateSqlDatabase(string, string, string, SqlDatabaseCreateUpdateParameters, SqlResourcesCreateUpdateSqlDatabaseOptionalParams)

Create or update an Azure Cosmos DB SQL database

function beginCreateUpdateSqlDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<SqlDatabaseGetResults>, SqlDatabaseGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters

The parameters to provide for the current SQL database.

options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlDatabaseGetResults>, SqlDatabaseGetResults>>

beginCreateUpdateSqlDatabaseAndWait(string, string, string, SqlDatabaseCreateUpdateParameters, SqlResourcesCreateUpdateSqlDatabaseOptionalParams)

Create or update an Azure Cosmos DB SQL database

function beginCreateUpdateSqlDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlDatabaseOptionalParams): Promise<SqlDatabaseGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters

The parameters to provide for the current SQL database.

options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams

The options parameters.

Returns

Promise<SqlDatabaseGetResults>

beginCreateUpdateSqlRoleAssignment(string, string, string, SqlRoleAssignmentCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams)

Creates or updates an Azure Cosmos DB SQL Role Assignment.

function beginCreateUpdateSqlRoleAssignment(roleAssignmentId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams): Promise<SimplePollerLike<OperationState<SqlRoleAssignmentGetResults>, SqlRoleAssignmentGetResults>>

Parameters

roleAssignmentId: string

The GUID for the Role Assignment.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters

The properties required to create or update a Role Assignment.

options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlRoleAssignmentGetResults>, SqlRoleAssignmentGetResults>>

beginCreateUpdateSqlRoleAssignmentAndWait(string, string, string, SqlRoleAssignmentCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams)

Creates or updates an Azure Cosmos DB SQL Role Assignment.

function beginCreateUpdateSqlRoleAssignmentAndWait(roleAssignmentId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams): Promise<SqlRoleAssignmentGetResults>

Parameters

roleAssignmentId: string

The GUID for the Role Assignment.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters

The properties required to create or update a Role Assignment.

options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams

The options parameters.

Returns

Promise<SqlRoleAssignmentGetResults>

beginCreateUpdateSqlRoleDefinition(string, string, string, SqlRoleDefinitionCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB SQL Role Definition.

function beginCreateUpdateSqlRoleDefinition(roleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<SqlRoleDefinitionGetResults>, SqlRoleDefinitionGetResults>>

Parameters

roleDefinitionId: string

The GUID for the Role Definition.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters

The properties required to create or update a Role Definition.

options: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlRoleDefinitionGetResults>, SqlRoleDefinitionGetResults>>

beginCreateUpdateSqlRoleDefinitionAndWait(string, string, string, SqlRoleDefinitionCreateUpdateParameters, SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB SQL Role Definition.

function beginCreateUpdateSqlRoleDefinitionAndWait(roleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams): Promise<SqlRoleDefinitionGetResults>

Parameters

roleDefinitionId: string

The GUID for the Role Definition.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters

The properties required to create or update a Role Definition.

options: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams

The options parameters.

Returns

Promise<SqlRoleDefinitionGetResults>

beginCreateUpdateSqlStoredProcedure(string, string, string, string, string, SqlStoredProcedureCreateUpdateParameters, SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams)

Create or update an Azure Cosmos DB SQL storedProcedure

function beginCreateUpdateSqlStoredProcedure(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, createUpdateSqlStoredProcedureParameters: SqlStoredProcedureCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams): Promise<SimplePollerLike<OperationState<SqlStoredProcedureGetResults>, SqlStoredProcedureGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

storedProcedureName: string

Cosmos DB storedProcedure name.

createUpdateSqlStoredProcedureParameters: SqlStoredProcedureCreateUpdateParameters

The parameters to provide for the current SQL storedProcedure.

options: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlStoredProcedureGetResults>, SqlStoredProcedureGetResults>>

beginCreateUpdateSqlStoredProcedureAndWait(string, string, string, string, string, SqlStoredProcedureCreateUpdateParameters, SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams)

Create or update an Azure Cosmos DB SQL storedProcedure

function beginCreateUpdateSqlStoredProcedureAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, createUpdateSqlStoredProcedureParameters: SqlStoredProcedureCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams): Promise<SqlStoredProcedureGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

storedProcedureName: string

Cosmos DB storedProcedure name.

createUpdateSqlStoredProcedureParameters: SqlStoredProcedureCreateUpdateParameters

The parameters to provide for the current SQL storedProcedure.

options: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams

The options parameters.

Returns

Promise<SqlStoredProcedureGetResults>

beginCreateUpdateSqlTrigger(string, string, string, string, string, SqlTriggerCreateUpdateParameters, SqlResourcesCreateUpdateSqlTriggerOptionalParams)

Create or update an Azure Cosmos DB SQL trigger

function beginCreateUpdateSqlTrigger(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, createUpdateSqlTriggerParameters: SqlTriggerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlTriggerOptionalParams): Promise<SimplePollerLike<OperationState<SqlTriggerGetResults>, SqlTriggerGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

triggerName: string

Cosmos DB trigger name.

createUpdateSqlTriggerParameters: SqlTriggerCreateUpdateParameters

The parameters to provide for the current SQL trigger.

options: SqlResourcesCreateUpdateSqlTriggerOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlTriggerGetResults>, SqlTriggerGetResults>>

beginCreateUpdateSqlTriggerAndWait(string, string, string, string, string, SqlTriggerCreateUpdateParameters, SqlResourcesCreateUpdateSqlTriggerOptionalParams)

Create or update an Azure Cosmos DB SQL trigger

function beginCreateUpdateSqlTriggerAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, createUpdateSqlTriggerParameters: SqlTriggerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlTriggerOptionalParams): Promise<SqlTriggerGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

triggerName: string

Cosmos DB trigger name.

createUpdateSqlTriggerParameters: SqlTriggerCreateUpdateParameters

The parameters to provide for the current SQL trigger.

options: SqlResourcesCreateUpdateSqlTriggerOptionalParams

The options parameters.

Returns

Promise<SqlTriggerGetResults>

beginCreateUpdateSqlUserDefinedFunction(string, string, string, string, string, SqlUserDefinedFunctionCreateUpdateParameters, SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams)

Create or update an Azure Cosmos DB SQL userDefinedFunction

function beginCreateUpdateSqlUserDefinedFunction(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, createUpdateSqlUserDefinedFunctionParameters: SqlUserDefinedFunctionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams): Promise<SimplePollerLike<OperationState<SqlUserDefinedFunctionGetResults>, SqlUserDefinedFunctionGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

userDefinedFunctionName: string

Cosmos DB userDefinedFunction name.

createUpdateSqlUserDefinedFunctionParameters: SqlUserDefinedFunctionCreateUpdateParameters

The parameters to provide for the current SQL userDefinedFunction.

options: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlUserDefinedFunctionGetResults>, SqlUserDefinedFunctionGetResults>>

beginCreateUpdateSqlUserDefinedFunctionAndWait(string, string, string, string, string, SqlUserDefinedFunctionCreateUpdateParameters, SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams)

Create or update an Azure Cosmos DB SQL userDefinedFunction

function beginCreateUpdateSqlUserDefinedFunctionAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, createUpdateSqlUserDefinedFunctionParameters: SqlUserDefinedFunctionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams): Promise<SqlUserDefinedFunctionGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

userDefinedFunctionName: string

Cosmos DB userDefinedFunction name.

createUpdateSqlUserDefinedFunctionParameters: SqlUserDefinedFunctionCreateUpdateParameters

The parameters to provide for the current SQL userDefinedFunction.

options: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams

The options parameters.

Returns

Promise<SqlUserDefinedFunctionGetResults>

beginDeleteSqlContainer(string, string, string, string, SqlResourcesDeleteSqlContainerOptionalParams)

Deletes an existing Azure Cosmos DB SQL container.

function beginDeleteSqlContainer(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesDeleteSqlContainerOptionalParams): Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlContainerHeaders>, SqlResourcesDeleteSqlContainerHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesDeleteSqlContainerOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlContainerHeaders>, SqlResourcesDeleteSqlContainerHeaders>>

beginDeleteSqlContainerAndWait(string, string, string, string, SqlResourcesDeleteSqlContainerOptionalParams)

Deletes an existing Azure Cosmos DB SQL container.

function beginDeleteSqlContainerAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesDeleteSqlContainerOptionalParams): Promise<SqlResourcesDeleteSqlContainerHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesDeleteSqlContainerOptionalParams

The options parameters.

Returns

Promise<SqlResourcesDeleteSqlContainerHeaders>

beginDeleteSqlDatabase(string, string, string, SqlResourcesDeleteSqlDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB SQL database.

function beginDeleteSqlDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesDeleteSqlDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlDatabaseHeaders>, SqlResourcesDeleteSqlDatabaseHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesDeleteSqlDatabaseOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlDatabaseHeaders>, SqlResourcesDeleteSqlDatabaseHeaders>>

beginDeleteSqlDatabaseAndWait(string, string, string, SqlResourcesDeleteSqlDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB SQL database.

function beginDeleteSqlDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesDeleteSqlDatabaseOptionalParams): Promise<SqlResourcesDeleteSqlDatabaseHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesDeleteSqlDatabaseOptionalParams

The options parameters.

Returns

Promise<SqlResourcesDeleteSqlDatabaseHeaders>

beginDeleteSqlRoleAssignment(string, string, string, SqlResourcesDeleteSqlRoleAssignmentOptionalParams)

Deletes an existing Azure Cosmos DB SQL Role Assignment.

function beginDeleteSqlRoleAssignment(roleAssignmentId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleAssignmentOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleAssignmentId: string

The GUID for the Role Assignment.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesDeleteSqlRoleAssignmentOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteSqlRoleAssignmentAndWait(string, string, string, SqlResourcesDeleteSqlRoleAssignmentOptionalParams)

Deletes an existing Azure Cosmos DB SQL Role Assignment.

function beginDeleteSqlRoleAssignmentAndWait(roleAssignmentId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleAssignmentOptionalParams): Promise<void>

Parameters

roleAssignmentId: string

The GUID for the Role Assignment.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesDeleteSqlRoleAssignmentOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteSqlRoleDefinition(string, string, string, SqlResourcesDeleteSqlRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB SQL Role Definition.

function beginDeleteSqlRoleDefinition(roleDefinitionId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleDefinitionId: string

The GUID for the Role Definition.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesDeleteSqlRoleDefinitionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteSqlRoleDefinitionAndWait(string, string, string, SqlResourcesDeleteSqlRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB SQL Role Definition.

function beginDeleteSqlRoleDefinitionAndWait(roleDefinitionId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleDefinitionOptionalParams): Promise<void>

Parameters

roleDefinitionId: string

The GUID for the Role Definition.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesDeleteSqlRoleDefinitionOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteSqlStoredProcedure(string, string, string, string, string, SqlResourcesDeleteSqlStoredProcedureOptionalParams)

Deletes an existing Azure Cosmos DB SQL storedProcedure.

function beginDeleteSqlStoredProcedure(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, options?: SqlResourcesDeleteSqlStoredProcedureOptionalParams): Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlStoredProcedureHeaders>, SqlResourcesDeleteSqlStoredProcedureHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

storedProcedureName: string

Cosmos DB storedProcedure name.

options: SqlResourcesDeleteSqlStoredProcedureOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlStoredProcedureHeaders>, SqlResourcesDeleteSqlStoredProcedureHeaders>>

beginDeleteSqlStoredProcedureAndWait(string, string, string, string, string, SqlResourcesDeleteSqlStoredProcedureOptionalParams)

Deletes an existing Azure Cosmos DB SQL storedProcedure.

function beginDeleteSqlStoredProcedureAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, options?: SqlResourcesDeleteSqlStoredProcedureOptionalParams): Promise<SqlResourcesDeleteSqlStoredProcedureHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

storedProcedureName: string

Cosmos DB storedProcedure name.

options: SqlResourcesDeleteSqlStoredProcedureOptionalParams

The options parameters.

Returns

Promise<SqlResourcesDeleteSqlStoredProcedureHeaders>

beginDeleteSqlTrigger(string, string, string, string, string, SqlResourcesDeleteSqlTriggerOptionalParams)

Deletes an existing Azure Cosmos DB SQL trigger.

function beginDeleteSqlTrigger(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, options?: SqlResourcesDeleteSqlTriggerOptionalParams): Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlTriggerHeaders>, SqlResourcesDeleteSqlTriggerHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

triggerName: string

Cosmos DB trigger name.

options: SqlResourcesDeleteSqlTriggerOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlTriggerHeaders>, SqlResourcesDeleteSqlTriggerHeaders>>

beginDeleteSqlTriggerAndWait(string, string, string, string, string, SqlResourcesDeleteSqlTriggerOptionalParams)

Deletes an existing Azure Cosmos DB SQL trigger.

function beginDeleteSqlTriggerAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, options?: SqlResourcesDeleteSqlTriggerOptionalParams): Promise<SqlResourcesDeleteSqlTriggerHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

triggerName: string

Cosmos DB trigger name.

options: SqlResourcesDeleteSqlTriggerOptionalParams

The options parameters.

Returns

Promise<SqlResourcesDeleteSqlTriggerHeaders>

beginDeleteSqlUserDefinedFunction(string, string, string, string, string, SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams)

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

function beginDeleteSqlUserDefinedFunction(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, options?: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams): Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlUserDefinedFunctionHeaders>, SqlResourcesDeleteSqlUserDefinedFunctionHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

userDefinedFunctionName: string

Cosmos DB userDefinedFunction name.

options: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<SqlResourcesDeleteSqlUserDefinedFunctionHeaders>, SqlResourcesDeleteSqlUserDefinedFunctionHeaders>>

beginDeleteSqlUserDefinedFunctionAndWait(string, string, string, string, string, SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams)

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

function beginDeleteSqlUserDefinedFunctionAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, options?: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams): Promise<SqlResourcesDeleteSqlUserDefinedFunctionHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

userDefinedFunctionName: string

Cosmos DB userDefinedFunction name.

options: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams

The options parameters.

Returns

Promise<SqlResourcesDeleteSqlUserDefinedFunctionHeaders>

beginListSqlContainerPartitionMerge(string, string, string, string, MergeParameters, SqlResourcesListSqlContainerPartitionMergeOptionalParams)

Merges the partitions of a SQL Container

function beginListSqlContainerPartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, mergeParameters: MergeParameters, options?: SqlResourcesListSqlContainerPartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

mergeParameters: MergeParameters

The parameters for the merge operation.

options: SqlResourcesListSqlContainerPartitionMergeOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>

beginListSqlContainerPartitionMergeAndWait(string, string, string, string, MergeParameters, SqlResourcesListSqlContainerPartitionMergeOptionalParams)

Merges the partitions of a SQL Container

function beginListSqlContainerPartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, mergeParameters: MergeParameters, options?: SqlResourcesListSqlContainerPartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

mergeParameters: MergeParameters

The parameters for the merge operation.

options: SqlResourcesListSqlContainerPartitionMergeOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionStorageInfoCollection>

beginMigrateSqlContainerToAutoscale(string, string, string, string, SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale

function beginMigrateSqlContainerToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateSqlContainerToAutoscaleAndWait(string, string, string, string, SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale

function beginMigrateSqlContainerToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateSqlContainerToManualThroughput(string, string, string, string, SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput

function beginMigrateSqlContainerToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateSqlContainerToManualThroughputAndWait(string, string, string, string, SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput

function beginMigrateSqlContainerToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateSqlDatabaseToAutoscale(string, string, string, SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale

function beginMigrateSqlDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateSqlDatabaseToAutoscaleAndWait(string, string, string, SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale

function beginMigrateSqlDatabaseToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateSqlDatabaseToManualThroughput(string, string, string, SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput

function beginMigrateSqlDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateSqlDatabaseToManualThroughputAndWait(string, string, string, SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput

function beginMigrateSqlDatabaseToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, SqlResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a container resource.

function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, location: ContinuousBackupRestoreLocation, options?: SqlResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

location: ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

options: SqlResourcesRetrieveContinuousBackupInformationOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, SqlResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a container resource.

function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, location: ContinuousBackupRestoreLocation, options?: SqlResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

location: ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

options: SqlResourcesRetrieveContinuousBackupInformationOptionalParams

The options parameters.

Returns

Promise<BackupInformation>

beginSqlContainerRedistributeThroughput(string, string, string, string, RedistributeThroughputParameters, SqlResourcesSqlContainerRedistributeThroughputOptionalParams)

Redistribute throughput for an Azure Cosmos DB SQL container

function beginSqlContainerRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: SqlResourcesSqlContainerRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

redistributeThroughputParameters: RedistributeThroughputParameters

The parameters to provide for redistributing throughput for the current SQL container.

options: SqlResourcesSqlContainerRedistributeThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

beginSqlContainerRedistributeThroughputAndWait(string, string, string, string, RedistributeThroughputParameters, SqlResourcesSqlContainerRedistributeThroughputOptionalParams)

Redistribute throughput for an Azure Cosmos DB SQL container

function beginSqlContainerRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: SqlResourcesSqlContainerRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

redistributeThroughputParameters: RedistributeThroughputParameters

The parameters to provide for redistributing throughput for the current SQL container.

options: SqlResourcesSqlContainerRedistributeThroughputOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionThroughputInfoResult>

beginSqlContainerRetrieveThroughputDistribution(string, string, string, string, RetrieveThroughputParameters, SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams)

Retrieve throughput distribution for an Azure Cosmos DB SQL container

function beginSqlContainerRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

retrieveThroughputParameters: RetrieveThroughputParameters

The parameters to provide for retrieving throughput distribution for the current SQL container.

options: SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

beginSqlContainerRetrieveThroughputDistributionAndWait(string, string, string, string, RetrieveThroughputParameters, SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams)

Retrieve throughput distribution for an Azure Cosmos DB SQL container

function beginSqlContainerRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

retrieveThroughputParameters: RetrieveThroughputParameters

The parameters to provide for retrieving throughput distribution for the current SQL container.

options: SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionThroughputInfoResult>

beginSqlDatabasePartitionMerge(string, string, string, MergeParameters, SqlResourcesSqlDatabasePartitionMergeOptionalParams)

Merges the partitions of a SQL database

function beginSqlDatabasePartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: SqlResourcesSqlDatabasePartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

mergeParameters: MergeParameters

The parameters for the merge operation.

options: SqlResourcesSqlDatabasePartitionMergeOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>

beginSqlDatabasePartitionMergeAndWait(string, string, string, MergeParameters, SqlResourcesSqlDatabasePartitionMergeOptionalParams)

Merges the partitions of a SQL database

function beginSqlDatabasePartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: SqlResourcesSqlDatabasePartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

mergeParameters: MergeParameters

The parameters for the merge operation.

options: SqlResourcesSqlDatabasePartitionMergeOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionStorageInfoCollection>

beginSqlDatabaseRedistributeThroughput(string, string, string, RedistributeThroughputParameters, SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams)

Redistribute throughput for an Azure Cosmos DB SQL database

function beginSqlDatabaseRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

redistributeThroughputParameters: RedistributeThroughputParameters

The parameters to provide for redistributing throughput for the current SQL database.

options: SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

beginSqlDatabaseRedistributeThroughputAndWait(string, string, string, RedistributeThroughputParameters, SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams)

Redistribute throughput for an Azure Cosmos DB SQL database

function beginSqlDatabaseRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

redistributeThroughputParameters: RedistributeThroughputParameters

The parameters to provide for redistributing throughput for the current SQL database.

options: SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionThroughputInfoResult>

beginSqlDatabaseRetrieveThroughputDistribution(string, string, string, RetrieveThroughputParameters, SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams)

Retrieve throughput distribution for an Azure Cosmos DB SQL database

function beginSqlDatabaseRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

retrieveThroughputParameters: RetrieveThroughputParameters

The parameters to provide for retrieving throughput distribution for the current SQL database.

options: SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>

beginSqlDatabaseRetrieveThroughputDistributionAndWait(string, string, string, RetrieveThroughputParameters, SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams)

Retrieve throughput distribution for an Azure Cosmos DB SQL database

function beginSqlDatabaseRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

retrieveThroughputParameters: RetrieveThroughputParameters

The parameters to provide for retrieving throughput distribution for the current SQL database.

options: SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams

The options parameters.

Returns

Promise<PhysicalPartitionThroughputInfoResult>

beginUpdateSqlContainerThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlContainerThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB SQL container

function beginUpdateSqlContainerThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlContainerThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

updateThroughputParameters: ThroughputSettingsUpdateParameters

The parameters to provide for the RUs per second of the current SQL container.

options: SqlResourcesUpdateSqlContainerThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateSqlContainerThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlContainerThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB SQL container

function beginUpdateSqlContainerThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlContainerThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

updateThroughputParameters: ThroughputSettingsUpdateParameters

The parameters to provide for the RUs per second of the current SQL container.

options: SqlResourcesUpdateSqlContainerThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginUpdateSqlDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlDatabaseThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB SQL database

function beginUpdateSqlDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

updateThroughputParameters: ThroughputSettingsUpdateParameters

The parameters to provide for the RUs per second of the current SQL database.

options: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateSqlDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, SqlResourcesUpdateSqlDatabaseThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB SQL database

function beginUpdateSqlDatabaseThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

updateThroughputParameters: ThroughputSettingsUpdateParameters

The parameters to provide for the RUs per second of the current SQL database.

options: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

getClientEncryptionKey(string, string, string, string, SqlResourcesGetClientEncryptionKeyOptionalParams)

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

function getClientEncryptionKey(resourceGroupName: string, accountName: string, databaseName: string, clientEncryptionKeyName: string, options?: SqlResourcesGetClientEncryptionKeyOptionalParams): Promise<ClientEncryptionKeyGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

clientEncryptionKeyName: string

Cosmos DB ClientEncryptionKey name.

options: SqlResourcesGetClientEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<ClientEncryptionKeyGetResults>

getSqlContainer(string, string, string, string, SqlResourcesGetSqlContainerOptionalParams)

Gets the SQL container under an existing Azure Cosmos DB database account.

function getSqlContainer(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesGetSqlContainerOptionalParams): Promise<SqlContainerGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesGetSqlContainerOptionalParams

The options parameters.

Returns

Promise<SqlContainerGetResults>

getSqlContainerThroughput(string, string, string, string, SqlResourcesGetSqlContainerThroughputOptionalParams)

Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.

function getSqlContainerThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesGetSqlContainerThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesGetSqlContainerThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

getSqlDatabase(string, string, string, SqlResourcesGetSqlDatabaseOptionalParams)

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

function getSqlDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesGetSqlDatabaseOptionalParams): Promise<SqlDatabaseGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesGetSqlDatabaseOptionalParams

The options parameters.

Returns

Promise<SqlDatabaseGetResults>

getSqlDatabaseThroughput(string, string, string, SqlResourcesGetSqlDatabaseThroughputOptionalParams)

Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.

function getSqlDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesGetSqlDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesGetSqlDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

getSqlRoleAssignment(string, string, string, SqlResourcesGetSqlRoleAssignmentOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.

function getSqlRoleAssignment(roleAssignmentId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesGetSqlRoleAssignmentOptionalParams): Promise<SqlRoleAssignmentGetResults>

Parameters

roleAssignmentId: string

The GUID for the Role Assignment.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesGetSqlRoleAssignmentOptionalParams

The options parameters.

Returns

Promise<SqlRoleAssignmentGetResults>

getSqlRoleDefinition(string, string, string, SqlResourcesGetSqlRoleDefinitionOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.

function getSqlRoleDefinition(roleDefinitionId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesGetSqlRoleDefinitionOptionalParams): Promise<SqlRoleDefinitionGetResults>

Parameters

roleDefinitionId: string

The GUID for the Role Definition.

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesGetSqlRoleDefinitionOptionalParams

The options parameters.

Returns

Promise<SqlRoleDefinitionGetResults>

getSqlStoredProcedure(string, string, string, string, string, SqlResourcesGetSqlStoredProcedureOptionalParams)

Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.

function getSqlStoredProcedure(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, options?: SqlResourcesGetSqlStoredProcedureOptionalParams): Promise<SqlStoredProcedureGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

storedProcedureName: string

Cosmos DB storedProcedure name.

options: SqlResourcesGetSqlStoredProcedureOptionalParams

The options parameters.

Returns

Promise<SqlStoredProcedureGetResults>

getSqlTrigger(string, string, string, string, string, SqlResourcesGetSqlTriggerOptionalParams)

Gets the SQL trigger under an existing Azure Cosmos DB database account.

function getSqlTrigger(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, options?: SqlResourcesGetSqlTriggerOptionalParams): Promise<SqlTriggerGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

triggerName: string

Cosmos DB trigger name.

options: SqlResourcesGetSqlTriggerOptionalParams

The options parameters.

Returns

Promise<SqlTriggerGetResults>

getSqlUserDefinedFunction(string, string, string, string, string, SqlResourcesGetSqlUserDefinedFunctionOptionalParams)

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

function getSqlUserDefinedFunction(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, options?: SqlResourcesGetSqlUserDefinedFunctionOptionalParams): Promise<SqlUserDefinedFunctionGetResults>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

userDefinedFunctionName: string

Cosmos DB userDefinedFunction name.

options: SqlResourcesGetSqlUserDefinedFunctionOptionalParams

The options parameters.

Returns

Promise<SqlUserDefinedFunctionGetResults>

listClientEncryptionKeys(string, string, string, SqlResourcesListClientEncryptionKeysOptionalParams)

Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

function listClientEncryptionKeys(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesListClientEncryptionKeysOptionalParams): PagedAsyncIterableIterator<ClientEncryptionKeyGetResults, ClientEncryptionKeyGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesListClientEncryptionKeysOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClientEncryptionKeyGetResults, ClientEncryptionKeyGetResults[], PageSettings>

listSqlContainers(string, string, string, SqlResourcesListSqlContainersOptionalParams)

Lists the SQL container under an existing Azure Cosmos DB database account.

function listSqlContainers(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesListSqlContainersOptionalParams): PagedAsyncIterableIterator<SqlContainerGetResults, SqlContainerGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

options: SqlResourcesListSqlContainersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlContainerGetResults, SqlContainerGetResults[], PageSettings>

listSqlDatabases(string, string, SqlResourcesListSqlDatabasesOptionalParams)

Lists the SQL databases under an existing Azure Cosmos DB database account.

function listSqlDatabases(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlDatabasesOptionalParams): PagedAsyncIterableIterator<SqlDatabaseGetResults, SqlDatabaseGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesListSqlDatabasesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlDatabaseGetResults, SqlDatabaseGetResults[], PageSettings>

listSqlRoleAssignments(string, string, SqlResourcesListSqlRoleAssignmentsOptionalParams)

Retrieves the list of all Azure Cosmos DB SQL Role Assignments.

function listSqlRoleAssignments(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlRoleAssignmentsOptionalParams): PagedAsyncIterableIterator<SqlRoleAssignmentGetResults, SqlRoleAssignmentGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesListSqlRoleAssignmentsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlRoleAssignmentGetResults, SqlRoleAssignmentGetResults[], PageSettings>

listSqlRoleDefinitions(string, string, SqlResourcesListSqlRoleDefinitionsOptionalParams)

Retrieves the list of all Azure Cosmos DB SQL Role Definitions.

function listSqlRoleDefinitions(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<SqlRoleDefinitionGetResults, SqlRoleDefinitionGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

options: SqlResourcesListSqlRoleDefinitionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlRoleDefinitionGetResults, SqlRoleDefinitionGetResults[], PageSettings>

listSqlStoredProcedures(string, string, string, string, SqlResourcesListSqlStoredProceduresOptionalParams)

Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.

function listSqlStoredProcedures(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesListSqlStoredProceduresOptionalParams): PagedAsyncIterableIterator<SqlStoredProcedureGetResults, SqlStoredProcedureGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesListSqlStoredProceduresOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlStoredProcedureGetResults, SqlStoredProcedureGetResults[], PageSettings>

listSqlTriggers(string, string, string, string, SqlResourcesListSqlTriggersOptionalParams)

Lists the SQL trigger under an existing Azure Cosmos DB database account.

function listSqlTriggers(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesListSqlTriggersOptionalParams): PagedAsyncIterableIterator<SqlTriggerGetResults, SqlTriggerGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesListSqlTriggersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlTriggerGetResults, SqlTriggerGetResults[], PageSettings>

listSqlUserDefinedFunctions(string, string, string, string, SqlResourcesListSqlUserDefinedFunctionsOptionalParams)

Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

function listSqlUserDefinedFunctions(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesListSqlUserDefinedFunctionsOptionalParams): PagedAsyncIterableIterator<SqlUserDefinedFunctionGetResults, SqlUserDefinedFunctionGetResults[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

Cosmos DB database account name.

databaseName: string

Cosmos DB database name.

containerName: string

Cosmos DB container name.

options: SqlResourcesListSqlUserDefinedFunctionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlUserDefinedFunctionGetResults, SqlUserDefinedFunctionGetResults[], PageSettings>