sql_resources

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

Overview

Name	sql_resources
Type	Resource
Id	azure.cosmosdb.sql_resources

Fields

The following fields are returned by SELECT queries:

get_sql_stored_procedure

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_sql_user_defined_function

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_sql_trigger

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.SqlTriggerGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_sql_stored_procedures

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_client_encryption_key

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_client_encryption_keys

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_sql_role_definition

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
assignableScopes	array	A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions	array	The set of operations allowed through this Role Definition.
roleName	string	A user-friendly name for the Role Definition. Must be unique for the database account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_sql_role_assignment

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
principalId	string	The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
roleDefinitionId	string	The unique identifier for the associated Role Definition.
scope	string	The data plane resource path for which access is being granted through this Role Assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_sql_databases

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.SqlDatabaseGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.SqlDatabaseGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sql_stored_procedure	select	resource_group_name, account_name, database_name, container_name, stored_procedure_name, subscription_id		Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
get_sql_user_defined_function	select	resource_group_name, account_name, database_name, container_name, user_defined_function_name, subscription_id		Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
get_sql_trigger	select	resource_group_name, account_name, database_name, container_name, trigger_name, subscription_id		Gets the SQL trigger under an existing Azure Cosmos DB database account.
list_sql_stored_procedures	select	resource_group_name, account_name, database_name, container_name, subscription_id		Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
get_client_encryption_key	select	resource_group_name, account_name, database_name, client_encryption_key_name, subscription_id		Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
list_client_encryption_keys	select	resource_group_name, account_name, database_name, subscription_id		Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
get_sql_role_definition	select	role_definition_id, resource_group_name, account_name, subscription_id		Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
get_sql_role_assignment	select	role_assignment_id, resource_group_name, account_name, subscription_id		Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.
list_sql_databases	select	resource_group_name, account_name, subscription_id		Lists the SQL databases under an existing Azure Cosmos DB database account.
list_sql_containers	exec	resource_group_name, account_name, database_name, subscription_id		Lists the SQL container under an existing Azure Cosmos DB database account.
list_sql_user_defined_functions	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
list_sql_triggers	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Lists the SQL trigger under an existing Azure Cosmos DB database account.
list_sql_role_definitions	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
list_sql_role_assignments	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB SQL Role Assignments.
get_sql_database	exec	resource_group_name, account_name, database_name, subscription_id		Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
create_update_sql_database	exec	resource_group_name, account_name, database_name, subscription_id, properties		Create or update an Azure Cosmos DB SQL database.
delete_sql_database	exec	resource_group_name, account_name, database_name, subscription_id		Deletes an existing Azure Cosmos DB SQL database.
get_sql_database_throughput	exec	resource_group_name, account_name, database_name, subscription_id		Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.
update_sql_database_throughput	exec	resource_group_name, account_name, database_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB SQL database.
get_sql_container_throughput	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
update_sql_container_throughput	exec	resource_group_name, account_name, database_name, container_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB SQL container.
create_update_client_encryption_key	exec	resource_group_name, account_name, database_name, client_encryption_key_name, subscription_id, properties		Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
get_sql_container	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Gets the SQL container under an existing Azure Cosmos DB database account.
create_update_sql_container	exec	resource_group_name, account_name, database_name, container_name, subscription_id, properties		Create or update an Azure Cosmos DB SQL container.
delete_sql_container	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Deletes an existing Azure Cosmos DB SQL container.
create_update_sql_stored_procedure	exec	resource_group_name, account_name, database_name, container_name, stored_procedure_name, subscription_id, properties		Create or update an Azure Cosmos DB SQL storedProcedure.
delete_sql_stored_procedure	exec	resource_group_name, account_name, database_name, container_name, stored_procedure_name, subscription_id		Deletes an existing Azure Cosmos DB SQL storedProcedure.
create_update_sql_user_defined_function	exec	resource_group_name, account_name, database_name, container_name, user_defined_function_name, subscription_id, properties		Create or update an Azure Cosmos DB SQL userDefinedFunction.
delete_sql_user_defined_function	exec	resource_group_name, account_name, database_name, container_name, user_defined_function_name, subscription_id		Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
create_update_sql_trigger	exec	resource_group_name, account_name, database_name, container_name, trigger_name, subscription_id, properties		Create or update an Azure Cosmos DB SQL trigger.
delete_sql_trigger	exec	resource_group_name, account_name, database_name, container_name, trigger_name, subscription_id		Deletes an existing Azure Cosmos DB SQL trigger.
create_update_sql_role_definition	exec	role_definition_id, resource_group_name, account_name, subscription_id		Creates or updates an Azure Cosmos DB SQL Role Definition.
delete_sql_role_definition	exec	role_definition_id, resource_group_name, account_name, subscription_id		Deletes an existing Azure Cosmos DB SQL Role Definition.
create_update_sql_role_assignment	exec	role_assignment_id, resource_group_name, account_name, subscription_id		Creates or updates an Azure Cosmos DB SQL Role Assignment.
delete_sql_role_assignment	exec	role_assignment_id, resource_group_name, account_name, subscription_id		Deletes an existing Azure Cosmos DB SQL Role Assignment.
migrate_sql_database_to_autoscale	exec	resource_group_name, account_name, database_name, subscription_id		Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale.
migrate_sql_database_to_manual_throughput	exec	resource_group_name, account_name, database_name, subscription_id		Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput.
migrate_sql_container_to_autoscale	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale.
migrate_sql_container_to_manual_throughput	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput.
retrieve_continuous_backup_information	exec	resource_group_name, account_name, database_name, container_name, subscription_id		Retrieves continuous backup information for a container resource.

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
account_name	string	Cosmos DB database account name. Required.
client_encryption_key_name	string	Cosmos DB ClientEncryptionKey name. Required.
container_name	string	Cosmos DB container name. Required.
database_name	string	Cosmos DB database name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_assignment_id	string	The GUID for the Role Assignment. Required.
role_definition_id	string	The GUID for the Role Definition. Required.
stored_procedure_name	string	Cosmos DB storedProcedure name. Required.
subscription_id	string
trigger_name	string	Cosmos DB trigger name. Required.
user_defined_function_name	string	Cosmos DB userDefinedFunction name. Required.

SELECT examples

get_sql_stored_procedure

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

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND stored_procedure_name = '{{ stored_procedure_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_sql_user_defined_function

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

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND user_defined_function_name = '{{ user_defined_function_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_sql_trigger

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

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_sql_stored_procedures

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

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_client_encryption_key

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

SELECT
id,
name,
resource,
systemData,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND client_encryption_key_name = '{{ client_encryption_key_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_client_encryption_keys

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

SELECT
id,
name,
resource,
systemData,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_sql_role_definition

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

SELECT
id,
name,
assignableScopes,
permissions,
roleName,
systemData,
type
FROM azure.cosmosdb.sql_resources
WHERE role_definition_id = '{{ role_definition_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_sql_role_assignment

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

SELECT
id,
name,
principalId,
roleDefinitionId,
scope,
systemData,
type
FROM azure.cosmosdb.sql_resources
WHERE role_assignment_id = '{{ role_assignment_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_sql_databases

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

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.sql_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_sql_containers

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

EXEC azure.cosmosdb.sql_resources.list_sql_containers 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_sql_user_defined_functions

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

EXEC azure.cosmosdb.sql_resources.list_sql_user_defined_functions 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_sql_triggers

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

EXEC azure.cosmosdb.sql_resources.list_sql_triggers 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_sql_role_definitions

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

EXEC azure.cosmosdb.sql_resources.list_sql_role_definitions 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_sql_role_assignments

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

EXEC azure.cosmosdb.sql_resources.list_sql_role_assignments 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_sql_database

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

EXEC azure.cosmosdb.sql_resources.get_sql_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_database

Create or update an Azure Cosmos DB SQL database.

EXEC azure.cosmosdb.sql_resources.create_update_sql_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_sql_database

Deletes an existing Azure Cosmos DB SQL database.

EXEC azure.cosmosdb.sql_resources.delete_sql_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_sql_database_throughput

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

EXEC azure.cosmosdb.sql_resources.get_sql_database_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_sql_database_throughput

Update RUs per second of an Azure Cosmos DB SQL database.

EXEC azure.cosmosdb.sql_resources.update_sql_database_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

get_sql_container_throughput

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

EXEC azure.cosmosdb.sql_resources.get_sql_container_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_sql_container_throughput

Update RUs per second of an Azure Cosmos DB SQL container.

EXEC azure.cosmosdb.sql_resources.update_sql_container_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

create_update_client_encryption_key

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

EXEC azure.cosmosdb.sql_resources.create_update_client_encryption_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@client_encryption_key_name='{{ client_encryption_key_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

get_sql_container

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

EXEC azure.cosmosdb.sql_resources.get_sql_container 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_container

Create or update an Azure Cosmos DB SQL container.

EXEC azure.cosmosdb.sql_resources.create_update_sql_container 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_sql_container

Deletes an existing Azure Cosmos DB SQL container.

EXEC azure.cosmosdb.sql_resources.delete_sql_container 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_stored_procedure

Create or update an Azure Cosmos DB SQL storedProcedure.

EXEC azure.cosmosdb.sql_resources.create_update_sql_stored_procedure 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@stored_procedure_name='{{ stored_procedure_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_sql_stored_procedure

Deletes an existing Azure Cosmos DB SQL storedProcedure.

EXEC azure.cosmosdb.sql_resources.delete_sql_stored_procedure 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@stored_procedure_name='{{ stored_procedure_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_user_defined_function

Create or update an Azure Cosmos DB SQL userDefinedFunction.

EXEC azure.cosmosdb.sql_resources.create_update_sql_user_defined_function 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@user_defined_function_name='{{ user_defined_function_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_sql_user_defined_function

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

EXEC azure.cosmosdb.sql_resources.delete_sql_user_defined_function 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@user_defined_function_name='{{ user_defined_function_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_trigger

Create or update an Azure Cosmos DB SQL trigger.

EXEC azure.cosmosdb.sql_resources.create_update_sql_trigger 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_sql_trigger

Deletes an existing Azure Cosmos DB SQL trigger.

EXEC azure.cosmosdb.sql_resources.delete_sql_trigger 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_role_definition

Creates or updates an Azure Cosmos DB SQL Role Definition.

EXEC azure.cosmosdb.sql_resources.create_update_sql_role_definition 
@role_definition_id='{{ role_definition_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_sql_role_definition

Deletes an existing Azure Cosmos DB SQL Role Definition.

EXEC azure.cosmosdb.sql_resources.delete_sql_role_definition 
@role_definition_id='{{ role_definition_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_sql_role_assignment

Creates or updates an Azure Cosmos DB SQL Role Assignment.

EXEC azure.cosmosdb.sql_resources.create_update_sql_role_assignment 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_sql_role_assignment

Deletes an existing Azure Cosmos DB SQL Role Assignment.

EXEC azure.cosmosdb.sql_resources.delete_sql_role_assignment 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_sql_database_to_autoscale

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

EXEC azure.cosmosdb.sql_resources.migrate_sql_database_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_sql_database_to_manual_throughput

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

EXEC azure.cosmosdb.sql_resources.migrate_sql_database_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_sql_container_to_autoscale

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

EXEC azure.cosmosdb.sql_resources.migrate_sql_container_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_sql_container_to_manual_throughput

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

EXEC azure.cosmosdb.sql_resources.migrate_sql_container_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

retrieve_continuous_backup_information

Retrieves continuous backup information for a container resource.

EXEC azure.cosmosdb.sql_resources.retrieve_continuous_backup_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;