sql_resources

Creates, updates, deletes, gets or lists a sql_resources resource.

Overview

Name	sql_resources
Type	Resource
Id	azure.cosmos_db.sql_resources

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
retrieve_continuous_backup_information	exec	subscriptionId, resourceGroupName, accountName, databaseName, containerName		Retrieves continuous backup information for a container resource.
migrate_sql_database_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
migrate_sql_database_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
sql_database_partition_merge	exec	subscriptionId, resourceGroupName, accountName, databaseName		Merges the partitions of a SQL database
migrate_sql_container_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName, containerName		Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
migrate_sql_container_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, containerName		Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
sql_database_retrieve_throughput_distribution	exec	subscriptionId, resourceGroupName, accountName, databaseName, properties		Retrieve throughput distribution for an Azure Cosmos DB SQL database
sql_database_redistribute_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, properties		Redistribute throughput for an Azure Cosmos DB SQL database
sql_container_retrieve_throughput_distribution	exec	subscriptionId, resourceGroupName, accountName, databaseName, containerName, properties		Retrieve throughput distribution for an Azure Cosmos DB SQL container
sql_container_redistribute_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, containerName, properties		Redistribute throughput for an Azure Cosmos DB SQL container

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
containerName	string	Cosmos DB container name.
databaseName	string	Cosmos DB database name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

Lifecycle Methods

retrieve_continuous_backup_information

Retrieves continuous backup information for a container resource.

EXEC azure.cosmos_db.sql_resources.retrieve_continuous_backup_information 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@containerName='{{ containerName }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;

migrate_sql_database_to_autoscale

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

EXEC azure.cosmos_db.sql_resources.migrate_sql_database_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

migrate_sql_database_to_manual_throughput

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

EXEC azure.cosmos_db.sql_resources.migrate_sql_database_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

sql_database_partition_merge

Merges the partitions of a SQL database

EXEC azure.cosmos_db.sql_resources.sql_database_partition_merge 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"isDryRun": {{ isDryRun }}
}'
;

migrate_sql_container_to_autoscale

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

EXEC azure.cosmos_db.sql_resources.migrate_sql_container_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@containerName='{{ containerName }}' --required
;

migrate_sql_container_to_manual_throughput

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

EXEC azure.cosmos_db.sql_resources.migrate_sql_container_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@containerName='{{ containerName }}' --required
;

sql_database_retrieve_throughput_distribution

Retrieve throughput distribution for an Azure Cosmos DB SQL database

EXEC azure.cosmos_db.sql_resources.sql_database_retrieve_throughput_distribution 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

sql_database_redistribute_throughput

Redistribute throughput for an Azure Cosmos DB SQL database

EXEC azure.cosmos_db.sql_resources.sql_database_redistribute_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

sql_container_retrieve_throughput_distribution

Retrieve throughput distribution for an Azure Cosmos DB SQL container

EXEC azure.cosmos_db.sql_resources.sql_container_retrieve_throughput_distribution 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@containerName='{{ containerName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

sql_container_redistribute_throughput

Redistribute throughput for an Azure Cosmos DB SQL container

EXEC azure.cosmos_db.sql_resources.sql_container_redistribute_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@containerName='{{ containerName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;