Microsoft Azure SDK for Python
This is the Microsoft Azure Cosmos DB Management Client Library. This package has been tested with Python 3.9+. For a more complete view of Azure libraries, see the azure sdk python release.
Disclaimer
Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691
Getting started
Prerequisites
Python 3.9+ is required to use this package.
Install the package
pip install azure-mgmt-cosmosdb
pip install azure-identity
Authentication
By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.
AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.
In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.
With above configuration, client can be authenticated by following code:
from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = CosmosDBManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples
Code samples for this package can be found at:
Search Cosmos DB Management on docs.microsoft.com
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Indices and tables
Developer Documentation
- azure.mgmt.cosmosdb package
- Submodules
- azure.mgmt.cosmosdb.models module
ARMProxyResourceARMResourcePropertiesAccountKeyMetadataAnalyticalStorageConfigurationAnalyticalStorageSchemaTypeApiPropertiesApiTypeAuthenticationMethodAuthenticationMethodLdapPropertiesAutoUpgradePolicyResourceAutoscaleSettingsAutoscaleSettingsResourceAzureConnectionTypeBackupInformationBackupPolicyBackupPolicyMigrationStateBackupPolicyMigrationStatusBackupPolicyTypeBackupStorageRedundancyCapabilityCapacityCassandraClusterDataCenterNodeItemCassandraClusterPublicStatusCassandraClusterPublicStatusDataCentersItemCassandraErrorCassandraKeyspaceCreateUpdateParametersCassandraKeyspaceGetPropertiesOptionsCassandraKeyspaceGetPropertiesResourceCassandraKeyspaceGetResultsCassandraKeyspaceListResultCassandraKeyspaceResourceCassandraPartitionKeyCassandraSchemaCassandraTableCreateUpdateParametersCassandraTableGetPropertiesOptionsCassandraTableGetPropertiesResourceCassandraTableGetResultsCassandraTableListResultCassandraTableResourceCertificateClientEncryptionIncludedPathClientEncryptionKeyCreateUpdateParametersClientEncryptionKeyGetPropertiesResourceClientEncryptionKeyGetResultsClientEncryptionKeyResourceClientEncryptionKeysListResultClientEncryptionPolicyClusterKeyClusterResourceClusterResourcePropertiesColumnCommandOutputCommandPostBodyCompositePathCompositePathSortOrderComputedPropertyConflictResolutionModeConflictResolutionPolicyConnectionErrorConnectionStateConnectorOfferConsistencyPolicyContainerPartitionKeyContinuousBackupInformationContinuousBackupRestoreLocationContinuousModeBackupPolicyContinuousModePropertiesContinuousTierCorsPolicyCreateModeCreateUpdateOptionsCreatedByTypeDataCenterResourceDataCenterResourcePropertiesDataTransferRegionalServiceResourceDataTransferServiceResourceDataTransferServiceResourceCreateUpdatePropertiesDataTransferServiceResourcePropertiesDataTypeDatabaseAccountConnectionStringDatabaseAccountCreateUpdateParametersDatabaseAccountGetResultsDatabaseAccountKeysMetadataDatabaseAccountKindDatabaseAccountListConnectionStringsResultDatabaseAccountListKeysResultDatabaseAccountListReadOnlyKeysResultDatabaseAccountRegenerateKeyParametersDatabaseAccountUpdateParametersDatabaseAccountsListResultDatabaseRestoreResourceDedicatedGatewayTypeDefaultConsistencyLevelDistanceFunctionErrorAdditionalInfoErrorDetailErrorResponseErrorResponseAutoGeneratedExcludedPathExtendedResourcePropertiesFailoverPoliciesFailoverPolicyFullTextPathFullTextPolicyGraphAPIComputeRegionalServiceResourceGraphAPIComputeServiceResourceGraphAPIComputeServiceResourceCreateUpdatePropertiesGraphAPIComputeServiceResourcePropertiesGremlinDatabaseCreateUpdateParametersGremlinDatabaseGetPropertiesOptionsGremlinDatabaseGetPropertiesResourceGremlinDatabaseGetResultsGremlinDatabaseListResultGremlinDatabaseResourceGremlinDatabaseRestoreResourceGremlinGraphCreateUpdateParametersGremlinGraphGetPropertiesOptionsGremlinGraphGetPropertiesResourceGremlinGraphGetResultsGremlinGraphListResultGremlinGraphResourceIncludedPathIndexKindIndexesIndexingModeIndexingPolicyIpAddressOrRangeKeyKindKeyWrapMetadataKindListClustersListDataCentersLocationLocationGetResultLocationListResultLocationPropertiesManagedCassandraARMResourcePropertiesManagedCassandraManagedServiceIdentityManagedCassandraProvisioningStateManagedCassandraReaperStatusManagedCassandraResourceIdentityTypeManagedServiceIdentityManagedServiceIdentityUserAssignedIdentityMaterializedViewsBuilderRegionalServiceResourceMaterializedViewsBuilderServiceResourceMaterializedViewsBuilderServiceResourceCreateUpdatePropertiesMaterializedViewsBuilderServiceResourcePropertiesMetricMetricAvailabilityMetricDefinitionMetricDefinitionsListResultMetricListResultMetricNameMetricValueMinimalTlsVersionMongoDBCollectionCreateUpdateParametersMongoDBCollectionGetPropertiesOptionsMongoDBCollectionGetPropertiesResourceMongoDBCollectionGetResultsMongoDBCollectionListResultMongoDBCollectionResourceMongoDBDatabaseCreateUpdateParametersMongoDBDatabaseGetPropertiesOptionsMongoDBDatabaseGetPropertiesResourceMongoDBDatabaseGetResultsMongoDBDatabaseListResultMongoDBDatabaseResourceMongoIndexMongoIndexKeysMongoIndexOptionsMongoRoleDefinitionCreateUpdateParametersMongoRoleDefinitionGetResultsMongoRoleDefinitionListResultMongoRoleDefinitionTypeMongoUserDefinitionCreateUpdateParametersMongoUserDefinitionGetResultsMongoUserDefinitionListResultNetworkAclBypassNodeStateNodeStatusNotebookWorkspaceNotebookWorkspaceConnectionInfoResultNotebookWorkspaceCreateUpdateParametersNotebookWorkspaceListResultNotebookWorkspaceNameOperationOperationDisplayOperationListResultOperationTypeOptionsResourcePartitionKindPartitionMetricPartitionMetricListResultPartitionUsagePartitionUsagesResultPercentileMetricPercentileMetricListResultPercentileMetricValuePeriodicModeBackupPolicyPeriodicModePropertiesPermissionPrimaryAggregationTypePrivateEndpointConnectionPrivateEndpointConnectionListResultPrivateEndpointPropertyPrivateLinkResourcePrivateLinkResourceListResultPrivateLinkServiceConnectionStatePropertyPrivilegePrivilegeResourceProxyResourcePublicNetworkAccessRegionForOnlineOfflineRegionalServiceResourceResourceResourceIdentityTypeResourceRestoreParametersRestorableDatabaseAccountGetResultRestorableDatabaseAccountsListResultRestorableGremlinDatabaseGetResultRestorableGremlinDatabasePropertiesResourceRestorableGremlinDatabasesListResultRestorableGremlinGraphGetResultRestorableGremlinGraphPropertiesResourceRestorableGremlinGraphsListResultRestorableGremlinResourcesGetResultRestorableGremlinResourcesListResultRestorableLocationResourceRestorableMongodbCollectionGetResultRestorableMongodbCollectionPropertiesResourceRestorableMongodbCollectionsListResultRestorableMongodbDatabaseGetResultRestorableMongodbDatabasePropertiesResourceRestorableMongodbDatabasesListResultRestorableMongodbResourcesGetResultRestorableMongodbResourcesListResultRestorableSqlContainerGetResultRestorableSqlContainerPropertiesResourceRestorableSqlContainerPropertiesResourceContainerRestorableSqlContainersListResultRestorableSqlDatabaseGetResultRestorableSqlDatabasePropertiesResourceRestorableSqlDatabasePropertiesResourceDatabaseRestorableSqlDatabasesListResultRestorableSqlResourcesGetResultRestorableSqlResourcesListResultRestorableTableGetResultRestorableTablePropertiesResourceRestorableTableResourcesGetResultRestorableTableResourcesListResultRestorableTablesListResultRestoreModeRestoreParametersRestoreParametersBaseRoleRoleDefinitionTypeSeedNodeServerVersionServiceResourceServiceResourceCreateUpdateParametersServiceResourceCreateUpdatePropertiesServiceResourceListResultServiceResourcePropertiesServiceSizeServiceStatusServiceTypeSpatialSpecSpatialTypeSqlContainerCreateUpdateParametersSqlContainerGetPropertiesOptionsSqlContainerGetPropertiesResourceSqlContainerGetResultsSqlContainerListResultSqlContainerResourceSqlDatabaseCreateUpdateParametersSqlDatabaseGetPropertiesOptionsSqlDatabaseGetPropertiesResourceSqlDatabaseGetResultsSqlDatabaseListResultSqlDatabaseResourceSqlDedicatedGatewayRegionalServiceResourceSqlDedicatedGatewayServiceResourceSqlDedicatedGatewayServiceResourceCreateUpdatePropertiesSqlDedicatedGatewayServiceResourcePropertiesSqlRoleAssignmentCreateUpdateParametersSqlRoleAssignmentGetResultsSqlRoleAssignmentListResultSqlRoleDefinitionCreateUpdateParametersSqlRoleDefinitionGetResultsSqlRoleDefinitionListResultSqlStoredProcedureCreateUpdateParametersSqlStoredProcedureGetPropertiesResourceSqlStoredProcedureGetResultsSqlStoredProcedureListResultSqlStoredProcedureResourceSqlTriggerCreateUpdateParametersSqlTriggerGetPropertiesResourceSqlTriggerGetResultsSqlTriggerListResultSqlTriggerResourceSqlUserDefinedFunctionCreateUpdateParametersSqlUserDefinedFunctionGetPropertiesResourceSqlUserDefinedFunctionGetResultsSqlUserDefinedFunctionListResultSqlUserDefinedFunctionResourceStatusSystemDataTableCreateUpdateParametersTableGetPropertiesOptionsTableGetPropertiesResourceTableGetResultsTableListResultTableResourceThroughputPolicyResourceThroughputSettingsGetPropertiesResourceThroughputSettingsGetResultsThroughputSettingsResourceThroughputSettingsUpdateParametersTriggerOperationTriggerTypeTypeUniqueKeyUniqueKeyPolicyUnitTypeUsageUsagesResultVectorDataTypeVectorEmbeddingVectorEmbeddingPolicyVectorIndexVectorIndexTypeVirtualNetworkRule
- azure.mgmt.cosmosdb.operations module
CassandraClustersOperationsCassandraClustersOperations.begin_create_update()CassandraClustersOperations.begin_deallocate()CassandraClustersOperations.begin_delete()CassandraClustersOperations.begin_invoke_command()CassandraClustersOperations.begin_start()CassandraClustersOperations.begin_update()CassandraClustersOperations.get()CassandraClustersOperations.list_by_resource_group()CassandraClustersOperations.list_by_subscription()CassandraClustersOperations.status()CassandraClustersOperations.models
CassandraDataCentersOperationsCassandraResourcesOperationsCassandraResourcesOperations.begin_create_update_cassandra_keyspace()CassandraResourcesOperations.begin_create_update_cassandra_table()CassandraResourcesOperations.begin_delete_cassandra_keyspace()CassandraResourcesOperations.begin_delete_cassandra_table()CassandraResourcesOperations.begin_migrate_cassandra_keyspace_to_autoscale()CassandraResourcesOperations.begin_migrate_cassandra_keyspace_to_manual_throughput()CassandraResourcesOperations.begin_migrate_cassandra_table_to_autoscale()CassandraResourcesOperations.begin_migrate_cassandra_table_to_manual_throughput()CassandraResourcesOperations.begin_update_cassandra_keyspace_throughput()CassandraResourcesOperations.begin_update_cassandra_table_throughput()CassandraResourcesOperations.get_cassandra_keyspace()CassandraResourcesOperations.get_cassandra_keyspace_throughput()CassandraResourcesOperations.get_cassandra_table()CassandraResourcesOperations.get_cassandra_table_throughput()CassandraResourcesOperations.list_cassandra_keyspaces()CassandraResourcesOperations.list_cassandra_tables()CassandraResourcesOperations.models
CollectionOperationsCollectionPartitionOperationsCollectionPartitionRegionOperationsCollectionRegionOperationsDatabaseAccountRegionOperationsDatabaseAccountsOperationsDatabaseAccountsOperations.begin_create_or_update()DatabaseAccountsOperations.begin_delete()DatabaseAccountsOperations.begin_failover_priority_change()DatabaseAccountsOperations.begin_offline_region()DatabaseAccountsOperations.begin_online_region()DatabaseAccountsOperations.begin_regenerate_key()DatabaseAccountsOperations.begin_update()DatabaseAccountsOperations.check_name_exists()DatabaseAccountsOperations.get()DatabaseAccountsOperations.get_read_only_keys()DatabaseAccountsOperations.list()DatabaseAccountsOperations.list_by_resource_group()DatabaseAccountsOperations.list_connection_strings()DatabaseAccountsOperations.list_keys()DatabaseAccountsOperations.list_metric_definitions()DatabaseAccountsOperations.list_metrics()DatabaseAccountsOperations.list_read_only_keys()DatabaseAccountsOperations.list_usages()DatabaseAccountsOperations.models
DatabaseOperationsGremlinResourcesOperationsGremlinResourcesOperations.begin_create_update_gremlin_database()GremlinResourcesOperations.begin_create_update_gremlin_graph()GremlinResourcesOperations.begin_delete_gremlin_database()GremlinResourcesOperations.begin_delete_gremlin_graph()GremlinResourcesOperations.begin_migrate_gremlin_database_to_autoscale()GremlinResourcesOperations.begin_migrate_gremlin_database_to_manual_throughput()GremlinResourcesOperations.begin_migrate_gremlin_graph_to_autoscale()GremlinResourcesOperations.begin_migrate_gremlin_graph_to_manual_throughput()GremlinResourcesOperations.begin_retrieve_continuous_backup_information()GremlinResourcesOperations.begin_update_gremlin_database_throughput()GremlinResourcesOperations.begin_update_gremlin_graph_throughput()GremlinResourcesOperations.get_gremlin_database()GremlinResourcesOperations.get_gremlin_database_throughput()GremlinResourcesOperations.get_gremlin_graph()GremlinResourcesOperations.get_gremlin_graph_throughput()GremlinResourcesOperations.list_gremlin_databases()GremlinResourcesOperations.list_gremlin_graphs()GremlinResourcesOperations.models
LocationsOperationsMongoDBResourcesOperationsMongoDBResourcesOperations.begin_create_update_mongo_db_collection()MongoDBResourcesOperations.begin_create_update_mongo_db_database()MongoDBResourcesOperations.begin_create_update_mongo_role_definition()MongoDBResourcesOperations.begin_create_update_mongo_user_definition()MongoDBResourcesOperations.begin_delete_mongo_db_collection()MongoDBResourcesOperations.begin_delete_mongo_db_database()MongoDBResourcesOperations.begin_delete_mongo_role_definition()MongoDBResourcesOperations.begin_delete_mongo_user_definition()MongoDBResourcesOperations.begin_migrate_mongo_db_collection_to_autoscale()MongoDBResourcesOperations.begin_migrate_mongo_db_collection_to_manual_throughput()MongoDBResourcesOperations.begin_migrate_mongo_db_database_to_autoscale()MongoDBResourcesOperations.begin_migrate_mongo_db_database_to_manual_throughput()MongoDBResourcesOperations.begin_retrieve_continuous_backup_information()MongoDBResourcesOperations.begin_update_mongo_db_collection_throughput()MongoDBResourcesOperations.begin_update_mongo_db_database_throughput()MongoDBResourcesOperations.get_mongo_db_collection()MongoDBResourcesOperations.get_mongo_db_collection_throughput()MongoDBResourcesOperations.get_mongo_db_database()MongoDBResourcesOperations.get_mongo_db_database_throughput()MongoDBResourcesOperations.get_mongo_role_definition()MongoDBResourcesOperations.get_mongo_user_definition()MongoDBResourcesOperations.list_mongo_db_collections()MongoDBResourcesOperations.list_mongo_db_databases()MongoDBResourcesOperations.list_mongo_role_definitions()MongoDBResourcesOperations.list_mongo_user_definitions()MongoDBResourcesOperations.models
NotebookWorkspacesOperationsNotebookWorkspacesOperations.begin_create_or_update()NotebookWorkspacesOperations.begin_delete()NotebookWorkspacesOperations.begin_regenerate_auth_token()NotebookWorkspacesOperations.begin_start()NotebookWorkspacesOperations.get()NotebookWorkspacesOperations.list_by_database_account()NotebookWorkspacesOperations.list_connection_info()NotebookWorkspacesOperations.models
OperationsPartitionKeyRangeIdOperationsPartitionKeyRangeIdRegionOperationsPercentileOperationsPercentileSourceTargetOperationsPercentileTargetOperationsPrivateEndpointConnectionsOperationsPrivateLinkResourcesOperationsRestorableDatabaseAccountsOperationsRestorableGremlinDatabasesOperationsRestorableGremlinGraphsOperationsRestorableGremlinResourcesOperationsRestorableMongodbCollectionsOperationsRestorableMongodbDatabasesOperationsRestorableMongodbResourcesOperationsRestorableSqlContainersOperationsRestorableSqlDatabasesOperationsRestorableSqlResourcesOperationsRestorableTableResourcesOperationsRestorableTablesOperationsServiceOperationsSqlResourcesOperationsSqlResourcesOperations.begin_create_update_client_encryption_key()SqlResourcesOperations.begin_create_update_sql_container()SqlResourcesOperations.begin_create_update_sql_database()SqlResourcesOperations.begin_create_update_sql_role_assignment()SqlResourcesOperations.begin_create_update_sql_role_definition()SqlResourcesOperations.begin_create_update_sql_stored_procedure()SqlResourcesOperations.begin_create_update_sql_trigger()SqlResourcesOperations.begin_create_update_sql_user_defined_function()SqlResourcesOperations.begin_delete_sql_container()SqlResourcesOperations.begin_delete_sql_database()SqlResourcesOperations.begin_delete_sql_role_assignment()SqlResourcesOperations.begin_delete_sql_role_definition()SqlResourcesOperations.begin_delete_sql_stored_procedure()SqlResourcesOperations.begin_delete_sql_trigger()SqlResourcesOperations.begin_delete_sql_user_defined_function()SqlResourcesOperations.begin_migrate_sql_container_to_autoscale()SqlResourcesOperations.begin_migrate_sql_container_to_manual_throughput()SqlResourcesOperations.begin_migrate_sql_database_to_autoscale()SqlResourcesOperations.begin_migrate_sql_database_to_manual_throughput()SqlResourcesOperations.begin_retrieve_continuous_backup_information()SqlResourcesOperations.begin_update_sql_container_throughput()SqlResourcesOperations.begin_update_sql_database_throughput()SqlResourcesOperations.get_client_encryption_key()SqlResourcesOperations.get_sql_container()SqlResourcesOperations.get_sql_container_throughput()SqlResourcesOperations.get_sql_database()SqlResourcesOperations.get_sql_database_throughput()SqlResourcesOperations.get_sql_role_assignment()SqlResourcesOperations.get_sql_role_definition()SqlResourcesOperations.get_sql_stored_procedure()SqlResourcesOperations.get_sql_trigger()SqlResourcesOperations.get_sql_user_defined_function()SqlResourcesOperations.list_client_encryption_keys()SqlResourcesOperations.list_sql_containers()SqlResourcesOperations.list_sql_databases()SqlResourcesOperations.list_sql_role_assignments()SqlResourcesOperations.list_sql_role_definitions()SqlResourcesOperations.list_sql_stored_procedures()SqlResourcesOperations.list_sql_triggers()SqlResourcesOperations.list_sql_user_defined_functions()SqlResourcesOperations.models
TableResourcesOperationsTableResourcesOperations.begin_create_update_table()TableResourcesOperations.begin_delete_table()TableResourcesOperations.begin_migrate_table_to_autoscale()TableResourcesOperations.begin_migrate_table_to_manual_throughput()TableResourcesOperations.begin_retrieve_continuous_backup_information()TableResourcesOperations.begin_update_table_throughput()TableResourcesOperations.get_table()TableResourcesOperations.get_table_throughput()TableResourcesOperations.list_tables()TableResourcesOperations.models
- azure.mgmt.cosmosdb.models module
- Module contents
- Submodules