SqlResources | @azure/arm-cosmosdb

Interface representing a SqlResources.

Hierarchy

SqlResources

Implemented by

SqlResourcesImpl

Index

Methods

beginCreateUpdateClientEncryptionKey

beginCreateUpdateClientEncryptionKey(resourceGroupName: string, accountName: string, databaseName: string, clientEncryptionKeyName: string, createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters, options?: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateClientEncryptionKeyResponse>, SqlResourcesCreateUpdateClientEncryptionKeyResponse>>

- Defined in operationsInterfaces/sqlResources.ts:419
Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

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.
- Optional options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateClientEncryptionKeyResponse>, SqlResourcesCreateUpdateClientEncryptionKeyResponse>>

beginCreateUpdateClientEncryptionKeyAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:443
Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

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.
- Optional options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateClientEncryptionKeyResponse>

beginCreateUpdateSqlContainer

beginCreateUpdateSqlContainer(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlContainerOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlContainerResponse>, SqlResourcesCreateUpdateSqlContainerResponse>>

- Defined in operationsInterfaces/sqlResources.ts:475
Create or update an Azure Cosmos DB SQL container

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.
- Optional options: SqlResourcesCreateUpdateSqlContainerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlContainerResponse>, SqlResourcesCreateUpdateSqlContainerResponse>>

beginCreateUpdateSqlContainerAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:497
Create or update an Azure Cosmos DB SQL container

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.
- Optional options: SqlResourcesCreateUpdateSqlContainerOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlContainerResponse>

beginCreateUpdateSqlDatabase

beginCreateUpdateSqlDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlDatabaseOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlDatabaseResponse>, SqlResourcesCreateUpdateSqlDatabaseResponse>>

- Defined in operationsInterfaces/sqlResources.ts:225
Create or update an Azure Cosmos DB SQL database

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.
- Optional options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlDatabaseResponse>, SqlResourcesCreateUpdateSqlDatabaseResponse>>

beginCreateUpdateSqlDatabaseAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:245
Create or update an Azure Cosmos DB SQL database

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.
- Optional options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlDatabaseResponse>

beginCreateUpdateSqlRoleAssignment

beginCreateUpdateSqlRoleAssignment(roleAssignmentId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlRoleAssignmentResponse>, SqlResourcesCreateUpdateSqlRoleAssignmentResponse>>

- Defined in operationsInterfaces/sqlResources.ts:1049
Creates or updates an Azure Cosmos DB SQL Role Assignment.

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.
- Optional options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlRoleAssignmentResponse>, SqlResourcesCreateUpdateSqlRoleAssignmentResponse>>

beginCreateUpdateSqlRoleAssignmentAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:1070
Creates or updates an Azure Cosmos DB SQL Role Assignment.

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.
- Optional options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlRoleAssignmentResponse>

beginCreateUpdateSqlRoleDefinition

beginCreateUpdateSqlRoleDefinition(roleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlRoleDefinitionResponse>, SqlResourcesCreateUpdateSqlRoleDefinitionResponse>>

- Defined in operationsInterfaces/sqlResources.ts:973
Creates or updates an Azure Cosmos DB SQL Role Definition.

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.
- Optional options: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlRoleDefinitionResponse>, SqlResourcesCreateUpdateSqlRoleDefinitionResponse>>

beginCreateUpdateSqlRoleDefinitionAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:994
Creates or updates an Azure Cosmos DB SQL Role Definition.

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.
- Optional options: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlRoleDefinitionResponse>

beginCreateUpdateSqlStoredProcedure

beginCreateUpdateSqlStoredProcedure(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, createUpdateSqlStoredProcedureParameters: SqlStoredProcedureCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlStoredProcedureResponse>, SqlResourcesCreateUpdateSqlStoredProcedureResponse>>

- Defined in operationsInterfaces/sqlResources.ts:691
Create or update an Azure Cosmos DB SQL storedProcedure

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.
- Optional options: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlStoredProcedureResponse>, SqlResourcesCreateUpdateSqlStoredProcedureResponse>>

beginCreateUpdateSqlStoredProcedureAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:716
Create or update an Azure Cosmos DB SQL storedProcedure

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.
- Optional options: SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlStoredProcedureResponse>

beginCreateUpdateSqlTrigger

beginCreateUpdateSqlTrigger(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, createUpdateSqlTriggerParameters: SqlTriggerCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlTriggerOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlTriggerResponse>, SqlResourcesCreateUpdateSqlTriggerResponse>>

- Defined in operationsInterfaces/sqlResources.ts:884
Create or update an Azure Cosmos DB SQL trigger

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.
- Optional options: SqlResourcesCreateUpdateSqlTriggerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlTriggerResponse>, SqlResourcesCreateUpdateSqlTriggerResponse>>

beginCreateUpdateSqlTriggerAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:908
Create or update an Azure Cosmos DB SQL trigger

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.
- Optional options: SqlResourcesCreateUpdateSqlTriggerOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlTriggerResponse>

beginCreateUpdateSqlUserDefinedFunction

beginCreateUpdateSqlUserDefinedFunction(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, createUpdateSqlUserDefinedFunctionParameters: SqlUserDefinedFunctionCreateUpdateParameters, options?: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse>, SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse>>

- Defined in operationsInterfaces/sqlResources.ts:787
Create or update an Azure Cosmos DB SQL userDefinedFunction

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.
- Optional options: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse>, SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse>>

beginCreateUpdateSqlUserDefinedFunctionAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:814
Create or update an Azure Cosmos DB SQL userDefinedFunction

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.
- Optional options: SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse>

beginDeleteSqlContainer

beginDeleteSqlContainer(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesDeleteSqlContainerOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:513
Deletes an existing Azure Cosmos DB SQL container.

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.
- Optional options: SqlResourcesDeleteSqlContainerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlContainerAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:528
Deletes an existing Azure Cosmos DB SQL container.

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.
- Optional options: SqlResourcesDeleteSqlContainerOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlDatabase

beginDeleteSqlDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesDeleteSqlDatabaseOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:259
Deletes an existing Azure Cosmos DB SQL database.

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.
- Optional options: SqlResourcesDeleteSqlDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlDatabaseAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:272
Deletes an existing Azure Cosmos DB SQL database.

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.
- Optional options: SqlResourcesDeleteSqlDatabaseOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlRoleAssignment

beginDeleteSqlRoleAssignment(roleAssignmentId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleAssignmentOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:1084
Deletes an existing Azure Cosmos DB SQL Role Assignment.

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.
- Optional options: SqlResourcesDeleteSqlRoleAssignmentOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlRoleAssignmentAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:1097
Deletes an existing Azure Cosmos DB SQL Role Assignment.

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.
- Optional options: SqlResourcesDeleteSqlRoleAssignmentOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlRoleDefinition

beginDeleteSqlRoleDefinition(roleDefinitionId: string, resourceGroupName: string, accountName: string, options?: SqlResourcesDeleteSqlRoleDefinitionOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:1008
Deletes an existing Azure Cosmos DB SQL Role Definition.

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.
- Optional options: SqlResourcesDeleteSqlRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlRoleDefinitionAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:1021
Deletes an existing Azure Cosmos DB SQL Role Definition.

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.
- Optional options: SqlResourcesDeleteSqlRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlStoredProcedure

beginDeleteSqlStoredProcedure(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, storedProcedureName: string, options?: SqlResourcesDeleteSqlStoredProcedureOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:734
Deletes an existing Azure Cosmos DB SQL storedProcedure.

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.
- Optional options: SqlResourcesDeleteSqlStoredProcedureOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlStoredProcedureAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:751
Deletes an existing Azure Cosmos DB SQL storedProcedure.

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.
- Optional options: SqlResourcesDeleteSqlStoredProcedureOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlTrigger

beginDeleteSqlTrigger(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, triggerName: string, options?: SqlResourcesDeleteSqlTriggerOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:926
Deletes an existing Azure Cosmos DB SQL trigger.

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.
- Optional options: SqlResourcesDeleteSqlTriggerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlTriggerAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:943
Deletes an existing Azure Cosmos DB SQL trigger.

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.
- Optional options: SqlResourcesDeleteSqlTriggerOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteSqlUserDefinedFunction

beginDeleteSqlUserDefinedFunction(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, userDefinedFunctionName: string, options?: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/sqlResources.ts:832
Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

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.
- Optional options: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteSqlUserDefinedFunctionAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:849
Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

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.
- Optional options: SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams
  
  The options parameters.
Returns Promise<void>

beginMigrateSqlContainerToAutoscale

beginMigrateSqlContainerToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlContainerToAutoscaleResponse>, SqlResourcesMigrateSqlContainerToAutoscaleResponse>>

- Defined in operationsInterfaces/sqlResources.ts:599
Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale

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.
- Optional options: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlContainerToAutoscaleResponse>, SqlResourcesMigrateSqlContainerToAutoscaleResponse>>

beginMigrateSqlContainerToAutoscaleAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:619
Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale

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.
- Optional options: SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesMigrateSqlContainerToAutoscaleResponse>

beginMigrateSqlContainerToManualThroughput

beginMigrateSqlContainerToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, options?: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlContainerToManualThroughputResponse>, SqlResourcesMigrateSqlContainerToManualThroughputResponse>>

- Defined in operationsInterfaces/sqlResources.ts:634
Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput

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.
- Optional options: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlContainerToManualThroughputResponse>, SqlResourcesMigrateSqlContainerToManualThroughputResponse>>

beginMigrateSqlContainerToManualThroughputAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:656
Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput

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.
- Optional options: SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesMigrateSqlContainerToManualThroughputResponse>

beginMigrateSqlDatabaseToAutoscale

beginMigrateSqlDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlDatabaseToAutoscaleResponse>, SqlResourcesMigrateSqlDatabaseToAutoscaleResponse>>

- Defined in operationsInterfaces/sqlResources.ts:336
Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale

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.
- Optional options: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlDatabaseToAutoscaleResponse>, SqlResourcesMigrateSqlDatabaseToAutoscaleResponse>>

beginMigrateSqlDatabaseToAutoscaleAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:354
Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale

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.
- Optional options: SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesMigrateSqlDatabaseToAutoscaleResponse>

beginMigrateSqlDatabaseToManualThroughput

beginMigrateSqlDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlDatabaseToManualThroughputResponse>, SqlResourcesMigrateSqlDatabaseToManualThroughputResponse>>

- Defined in operationsInterfaces/sqlResources.ts:367
Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput

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.
- Optional options: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesMigrateSqlDatabaseToManualThroughputResponse>, SqlResourcesMigrateSqlDatabaseToManualThroughputResponse>>

beginMigrateSqlDatabaseToManualThroughputAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:387
Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput

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.
- Optional options: SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesMigrateSqlDatabaseToManualThroughputResponse>

beginRetrieveContinuousBackupInformation

beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, location: ContinuousBackupRestoreLocation, options?: SqlResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesRetrieveContinuousBackupInformationResponse>, SqlResourcesRetrieveContinuousBackupInformationResponse>>

- Defined in operationsInterfaces/sqlResources.ts:1112
Retrieves continuous backup information for a container resource.

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.
- Optional options: SqlResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesRetrieveContinuousBackupInformationResponse>, SqlResourcesRetrieveContinuousBackupInformationResponse>>

beginRetrieveContinuousBackupInformationAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:1136
Retrieves continuous backup information for a container resource.

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.
- Optional options: SqlResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesRetrieveContinuousBackupInformationResponse>

beginUpdateSqlContainerThroughput

beginUpdateSqlContainerThroughput(resourceGroupName: string, accountName: string, databaseName: string, containerName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlContainerThroughputOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesUpdateSqlContainerThroughputResponse>, SqlResourcesUpdateSqlContainerThroughputResponse>>

- Defined in operationsInterfaces/sqlResources.ts:560
Update RUs per second of an Azure Cosmos DB SQL container

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.
- Optional options: SqlResourcesUpdateSqlContainerThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesUpdateSqlContainerThroughputResponse>, SqlResourcesUpdateSqlContainerThroughputResponse>>

beginUpdateSqlContainerThroughputAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:583
Update RUs per second of an Azure Cosmos DB SQL container

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.
- Optional options: SqlResourcesUpdateSqlContainerThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesUpdateSqlContainerThroughputResponse>

beginUpdateSqlDatabaseThroughput

beginUpdateSqlDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams): Promise<PollerLike<PollOperationState<SqlResourcesUpdateSqlDatabaseThroughputResponse>, SqlResourcesUpdateSqlDatabaseThroughputResponse>>

- Defined in operationsInterfaces/sqlResources.ts:301
Update RUs per second of an Azure Cosmos DB SQL database

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.
- Optional options: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlResourcesUpdateSqlDatabaseThroughputResponse>, SqlResourcesUpdateSqlDatabaseThroughputResponse>>

beginUpdateSqlDatabaseThroughputAndWait

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

- Defined in operationsInterfaces/sqlResources.ts:322
Update RUs per second of an Azure Cosmos DB SQL database

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.
- Optional options: SqlResourcesUpdateSqlDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesUpdateSqlDatabaseThroughputResponse>

getClientEncryptionKey

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

- Defined in operationsInterfaces/sqlResources.ts:401
Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

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.
- Optional options: SqlResourcesGetClientEncryptionKeyOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetClientEncryptionKeyResponse>

getSqlContainer

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

- Defined in operationsInterfaces/sqlResources.ts:459
Gets the SQL container under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesGetSqlContainerOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlContainerResponse>

getSqlContainerThroughput

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

- Defined in operationsInterfaces/sqlResources.ts:543
Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesGetSqlContainerThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlContainerThroughputResponse>

getSqlDatabase

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

- Defined in operationsInterfaces/sqlResources.ts:211
Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: SqlResourcesGetSqlDatabaseOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlDatabaseResponse>

getSqlDatabaseThroughput

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

- Defined in operationsInterfaces/sqlResources.ts:286
Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: SqlResourcesGetSqlDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlDatabaseThroughputResponse>

getSqlRoleAssignment

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

- Defined in operationsInterfaces/sqlResources.ts:1034
Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.

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.
- Optional options: SqlResourcesGetSqlRoleAssignmentOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlRoleAssignmentResponse>

getSqlRoleDefinition

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

- Defined in operationsInterfaces/sqlResources.ts:958
Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.

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.
- Optional options: SqlResourcesGetSqlRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlRoleDefinitionResponse>

getSqlStoredProcedure

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

- Defined in operationsInterfaces/sqlResources.ts:672
Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesGetSqlStoredProcedureOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlStoredProcedureResponse>

getSqlTrigger

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

- Defined in operationsInterfaces/sqlResources.ts:866
Gets the SQL trigger under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesGetSqlTriggerOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlTriggerResponse>

getSqlUserDefinedFunction

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

- Defined in operationsInterfaces/sqlResources.ts:768
Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesGetSqlUserDefinedFunctionOptionalParams
  
  The options parameters.
Returns Promise<SqlResourcesGetSqlUserDefinedFunctionResponse>

listClientEncryptionKeys

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

- Defined in operationsInterfaces/sqlResources.ts:118
Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

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.
- Optional options: SqlResourcesListClientEncryptionKeysOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ClientEncryptionKeyGetResults>

listSqlContainers

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

- Defined in operationsInterfaces/sqlResources.ts:131
Lists the SQL container under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesListSqlContainersOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlContainerGetResults>

listSqlDatabases

listSqlDatabases(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlDatabasesOptionalParams): PagedAsyncIterableIterator<SqlDatabaseGetResults>

- Defined in operationsInterfaces/sqlResources.ts:106
Lists the SQL databases under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: SqlResourcesListSqlDatabasesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlDatabaseGetResults>

listSqlRoleAssignments

listSqlRoleAssignments(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlRoleAssignmentsOptionalParams): PagedAsyncIterableIterator<SqlRoleAssignmentGetResults>

- Defined in operationsInterfaces/sqlResources.ts:199
Retrieves the list of all Azure Cosmos DB SQL Role Assignments.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: SqlResourcesListSqlRoleAssignmentsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlRoleAssignmentGetResults>

listSqlRoleDefinitions

listSqlRoleDefinitions(resourceGroupName: string, accountName: string, options?: SqlResourcesListSqlRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<SqlRoleDefinitionGetResults>

- Defined in operationsInterfaces/sqlResources.ts:188
Retrieves the list of all Azure Cosmos DB SQL Role Definitions.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: SqlResourcesListSqlRoleDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlRoleDefinitionGetResults>

listSqlStoredProcedures

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

- Defined in operationsInterfaces/sqlResources.ts:145
Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesListSqlStoredProceduresOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlStoredProcedureGetResults>

listSqlTriggers

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

- Defined in operationsInterfaces/sqlResources.ts:175
Lists the SQL trigger under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesListSqlTriggersOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlTriggerGetResults>

listSqlUserDefinedFunctions

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

- Defined in operationsInterfaces/sqlResources.ts:160
Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

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.
- Optional options: SqlResourcesListSqlUserDefinedFunctionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SqlUserDefinedFunctionGetResults>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateUpdateClientEncryptionKey

Parameters

resourceGroupName: string

accountName: string

databaseName: string

clientEncryptionKeyName: string

createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams

Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateClientEncryptionKeyResponse>, SqlResourcesCreateUpdateClientEncryptionKeyResponse>>

beginCreateUpdateClientEncryptionKeyAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

clientEncryptionKeyName: string

createUpdateClientEncryptionKeyParameters: ClientEncryptionKeyCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams

Returns Promise<SqlResourcesCreateUpdateClientEncryptionKeyResponse>

beginCreateUpdateSqlContainer

Parameters

resourceGroupName: string

accountName: string

databaseName: string

containerName: string

createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlContainerOptionalParams

Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlContainerResponse>, SqlResourcesCreateUpdateSqlContainerResponse>>

beginCreateUpdateSqlContainerAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

containerName: string

createUpdateSqlContainerParameters: SqlContainerCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlContainerOptionalParams

Returns Promise<SqlResourcesCreateUpdateSqlContainerResponse>

beginCreateUpdateSqlDatabase

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams

Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlDatabaseResponse>, SqlResourcesCreateUpdateSqlDatabaseResponse>>

beginCreateUpdateSqlDatabaseAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateSqlDatabaseParameters: SqlDatabaseCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlDatabaseOptionalParams

Returns Promise<SqlResourcesCreateUpdateSqlDatabaseResponse>

beginCreateUpdateSqlRoleAssignment

Parameters

roleAssignmentId: string

resourceGroupName: string

accountName: string

createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams

Returns Promise<PollerLike<PollOperationState<SqlResourcesCreateUpdateSqlRoleAssignmentResponse>, SqlResourcesCreateUpdateSqlRoleAssignmentResponse>>

beginCreateUpdateSqlRoleAssignmentAndWait

Parameters

roleAssignmentId: string

resourceGroupName: string

accountName: string

createUpdateSqlRoleAssignmentParameters: SqlRoleAssignmentCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams

Returns Promise<SqlResourcesCreateUpdateSqlRoleAssignmentResponse>

beginCreateUpdateSqlRoleDefinition

Parameters

roleDefinitionId: string

resourceGroupName: string

accountName: string

createUpdateSqlRoleDefinitionParameters: SqlRoleDefinitionCreateUpdateParameters

Optional options: SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams