SqlResources interface
Interface representing a SqlResources.
Methods
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
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.
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.
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.
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<BackupInformation>
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.
The options parameters.
Returns
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.
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.
The options parameters.
Returns
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.