SqlResourcesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:sql_resources> attribute.

Inheritance
builtins.object
SqlResourcesOperations

Constructor

SqlResourcesOperations(*args, **kwargs)

Methods

begin_create_update_sql_container

Create or update an Azure Cosmos DB SQL container.

begin_create_update_sql_database

Create or update an Azure Cosmos DB SQL database.

begin_create_update_sql_role_assignment

Creates or updates an Azure Cosmos DB SQL Role Assignment.

begin_create_update_sql_role_definition

Creates or updates an Azure Cosmos DB SQL Role Definition.

begin_create_update_sql_stored_procedure

Create or update an Azure Cosmos DB SQL storedProcedure.

begin_create_update_sql_trigger

Create or update an Azure Cosmos DB SQL trigger.

begin_create_update_sql_user_defined_function

Create or update an Azure Cosmos DB SQL userDefinedFunction.

begin_delete_sql_container

Deletes an existing Azure Cosmos DB SQL container.

begin_delete_sql_database

Deletes an existing Azure Cosmos DB SQL database.

begin_delete_sql_role_assignment

Deletes an existing Azure Cosmos DB SQL Role Assignment.

begin_delete_sql_role_definition

Deletes an existing Azure Cosmos DB SQL Role Definition.

begin_delete_sql_stored_procedure

Deletes an existing Azure Cosmos DB SQL storedProcedure.

begin_delete_sql_trigger

Deletes an existing Azure Cosmos DB SQL trigger.

begin_delete_sql_user_defined_function

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

begin_migrate_sql_container_to_autoscale

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

begin_migrate_sql_container_to_manual_throughput

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

begin_migrate_sql_database_to_autoscale

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

begin_migrate_sql_database_to_manual_throughput

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

begin_retrieve_continuous_backup_information

Retrieves continuous backup information for a container resource.

begin_update_sql_container_throughput

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

begin_update_sql_database_throughput

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

get_sql_container

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

get_sql_container_throughput

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

get_sql_database

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

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.

get_sql_role_assignment

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

get_sql_role_definition

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

get_sql_stored_procedure

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

get_sql_trigger

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

get_sql_user_defined_function

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

list_sql_containers

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

list_sql_databases

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

list_sql_role_assignments

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

list_sql_role_definitions

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

list_sql_stored_procedures

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

list_sql_triggers

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

list_sql_user_defined_functions

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

begin_create_update_sql_container

Create or update an Azure Cosmos DB SQL container.

begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlContainerCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

create_update_sql_container_parameters
SqlContainerCreateUpdateParameters
Required

The parameters to provide for the current SQL container.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlContainerGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_database

Create or update an Azure Cosmos DB SQL database.

begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

create_update_sql_database_parameters
SqlDatabaseCreateUpdateParameters
Required

The parameters to provide for the current SQL database.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlDatabaseGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_role_assignment

Creates or updates an Azure Cosmos DB SQL Role Assignment.

begin_create_update_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, create_update_sql_role_assignment_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults]

Parameters

role_assignment_id
str
Required

The GUID for the Role Assignment.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

create_update_sql_role_assignment_parameters
SqlRoleAssignmentCreateUpdateParameters
Required

The properties required to create or update a Role Assignment.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_role_definition

Creates or updates an Azure Cosmos DB SQL Role Definition.

begin_create_update_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, create_update_sql_role_definition_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults]

Parameters

role_definition_id
str
Required

The GUID for the Role Definition.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

create_update_sql_role_definition_parameters
SqlRoleDefinitionCreateUpdateParameters
Required

The properties required to create or update a Role Definition.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_stored_procedure

Create or update an Azure Cosmos DB SQL storedProcedure.

begin_create_update_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, create_update_sql_stored_procedure_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

stored_procedure_name
str
Required

Cosmos DB storedProcedure name.

create_update_sql_stored_procedure_parameters
SqlStoredProcedureCreateUpdateParameters
Required

The parameters to provide for the current SQL storedProcedure.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlStoredProcedureGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_trigger

Create or update an Azure Cosmos DB SQL trigger.

begin_create_update_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, create_update_sql_trigger_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlTriggerCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

trigger_name
str
Required

Cosmos DB trigger name.

create_update_sql_trigger_parameters
SqlTriggerCreateUpdateParameters
Required

The parameters to provide for the current SQL trigger.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlTriggerGetResults or the result of cls(response)

Return type

Exceptions

begin_create_update_sql_user_defined_function

Create or update an Azure Cosmos DB SQL userDefinedFunction.

begin_create_update_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, create_update_sql_user_defined_function_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

user_defined_function_name
str
Required

Cosmos DB userDefinedFunction name.

create_update_sql_user_defined_function_parameters
SqlUserDefinedFunctionCreateUpdateParameters
Required

The parameters to provide for the current SQL userDefinedFunction.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type

Exceptions

begin_delete_sql_container

Deletes an existing Azure Cosmos DB SQL container.

begin_delete_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_database

Deletes an existing Azure Cosmos DB SQL database.

begin_delete_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_role_assignment

Deletes an existing Azure Cosmos DB SQL Role Assignment.

begin_delete_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

role_assignment_id
str
Required

The GUID for the Role Assignment.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_role_definition

Deletes an existing Azure Cosmos DB SQL Role Definition.

begin_delete_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

role_definition_id
str
Required

The GUID for the Role Definition.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_stored_procedure

Deletes an existing Azure Cosmos DB SQL storedProcedure.

begin_delete_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

stored_procedure_name
str
Required

Cosmos DB storedProcedure name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_trigger

Deletes an existing Azure Cosmos DB SQL trigger.

begin_delete_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

trigger_name
str
Required

Cosmos DB trigger name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete_sql_user_defined_function

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

begin_delete_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

user_defined_function_name
str
Required

Cosmos DB userDefinedFunction name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_migrate_sql_container_to_autoscale

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

begin_migrate_sql_container_to_autoscale(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

begin_migrate_sql_container_to_manual_throughput

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

begin_migrate_sql_container_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

begin_migrate_sql_database_to_autoscale

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

begin_migrate_sql_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

begin_migrate_sql_database_to_manual_throughput

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

begin_migrate_sql_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

begin_retrieve_continuous_backup_information

Retrieves continuous backup information for a container resource.

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, container_name: str, location: azure.mgmt.cosmosdb.models._models_py3.ContinuousBackupRestoreLocation, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.BackupInformation]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

location
ContinuousBackupRestoreLocation
Required

The name of the continuous backup restore location.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type

Exceptions

begin_update_sql_container_throughput

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

begin_update_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

update_throughput_parameters
ThroughputSettingsUpdateParameters
Required

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

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

begin_update_sql_database_throughput

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

begin_update_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

update_throughput_parameters
ThroughputSettingsUpdateParameters
Required

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

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

Exceptions

get_sql_container

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

get_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlContainerGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_container_throughput

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

get_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_database

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

get_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlDatabaseGetResults, or the result of cls(response)

Return type

Exceptions

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.

get_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_role_assignment

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

get_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults

Parameters

role_assignment_id
str
Required

The GUID for the Role Assignment.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlRoleAssignmentGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_role_definition

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

get_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults

Parameters

role_definition_id
str
Required

The GUID for the Role Definition.

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlRoleDefinitionGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_stored_procedure

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

get_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

stored_procedure_name
str
Required

Cosmos DB storedProcedure name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlStoredProcedureGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_trigger

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

get_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

trigger_name
str
Required

Cosmos DB trigger name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlTriggerGetResults, or the result of cls(response)

Return type

Exceptions

get_sql_user_defined_function

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

get_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

user_defined_function_name
str
Required

Cosmos DB userDefinedFunction name.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlUserDefinedFunctionGetResults, or the result of cls(response)

Return type

Exceptions

list_sql_containers

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

list_sql_containers(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlContainerListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlContainerListResult or the result of cls(response)

Return type

Exceptions

list_sql_databases

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

list_sql_databases(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlDatabaseListResult or the result of cls(response)

Return type

Exceptions

list_sql_role_assignments

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

list_sql_role_assignments(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlRoleAssignmentListResult or the result of cls(response)

Return type

Exceptions

list_sql_role_definitions

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

list_sql_role_definitions(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlRoleDefinitionListResult or the result of cls(response)

Return type

Exceptions

list_sql_stored_procedures

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

list_sql_stored_procedures(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlStoredProcedureListResult or the result of cls(response)

Return type

Exceptions

list_sql_triggers

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

list_sql_triggers(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlTriggerListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlTriggerListResult or the result of cls(response)

Return type

Exceptions

list_sql_user_defined_functions

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

list_sql_user_defined_functions(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionListResult]

Parameters

resource_group_name
str
Required

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

account_name
str
Required

Cosmos DB database account name.

database_name
str
Required

Cosmos DB database name.

container_name
str
Required

Cosmos DB container name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlUserDefinedFunctionListResult or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>