CosmosDBExtensions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class to add extension methods to Azure.ResourceManager.CosmosDB.
public static class CosmosDBExtensionstype CosmosDBExtensions = classPublic Module CosmosDBExtensions- Inheritance
-
CosmosDBExtensions
Methods
| CheckNameExistsDatabaseAccount(TenantResource, String, CancellationToken) |
Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.
|
| CheckNameExistsDatabaseAccountAsync(TenantResource, String, CancellationToken) |
Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.
|
| GetCassandraCluster(ResourceGroupResource, String, CancellationToken) |
Get the properties of a managed Cassandra cluster.
|
| GetCassandraClusterAsync(ResourceGroupResource, String, CancellationToken) |
Get the properties of a managed Cassandra cluster.
|
| GetCassandraClusterResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraClusterResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a CassandraClusterResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraClusterResource(ResourceIdentifier) instead. |
| GetCassandraClusters(ResourceGroupResource) |
Gets a collection of CassandraClusterResources in the ResourceGroupResource. MockingTo mock this method, please mock GetCassandraClusters() instead. |
| GetCassandraClusters(SubscriptionResource, CancellationToken) |
List all managed Cassandra clusters in this subscription.
|
| GetCassandraClustersAsync(SubscriptionResource, CancellationToken) |
List all managed Cassandra clusters in this subscription.
|
| GetCassandraDataCenterResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraDataCenterResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CassandraDataCenterResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraDataCenterResource(ResourceIdentifier) instead. |
| GetCassandraKeyspaceResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraKeyspaceResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CassandraKeyspaceResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraKeyspaceResource(ResourceIdentifier) instead. |
| GetCassandraKeyspaceThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraKeyspaceThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CassandraKeyspaceThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraKeyspaceThroughputSettingResource(ResourceIdentifier) instead. |
| GetCassandraTableResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraTableResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraTableResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraTableResource(ResourceIdentifier) instead. |
| GetCassandraTableThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraTableThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraTableThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraTableThroughputSettingResource(ResourceIdentifier) instead. |
| GetCassandraViewGetResultResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraViewGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraViewGetResultResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraViewGetResultResource(ResourceIdentifier) instead. |
| GetCassandraViewThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CassandraViewThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraViewThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCassandraViewThroughputSettingResource(ResourceIdentifier) instead. |
| GetCosmosDBAccount(ResourceGroupResource, String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB database account.
|
| GetCosmosDBAccountAsync(ResourceGroupResource, String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB database account.
|
| GetCosmosDBAccountResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBAccountResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a CosmosDBAccountResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBAccountResource(ResourceIdentifier) instead. |
| GetCosmosDBAccounts(ResourceGroupResource) |
Gets a collection of CosmosDBAccountResources in the ResourceGroupResource. MockingTo mock this method, please mock GetCosmosDBAccounts() instead. |
| GetCosmosDBAccounts(SubscriptionResource, CancellationToken) |
Lists all the Azure Cosmos DB database accounts available under the subscription.
|
| GetCosmosDBAccountsAsync(SubscriptionResource, CancellationToken) |
Lists all the Azure Cosmos DB database accounts available under the subscription.
|
| GetCosmosDBFirewallRuleResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBFirewallRuleResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBFirewallRuleResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBFirewallRuleResource(ResourceIdentifier) instead. |
| GetCosmosDBLocation(SubscriptionResource, AzureLocation, CancellationToken) |
Get the properties of an existing Cosmos DB location
|
| GetCosmosDBLocationAsync(SubscriptionResource, AzureLocation, CancellationToken) |
Get the properties of an existing Cosmos DB location
|
| GetCosmosDBLocationResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBLocationResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, AzureLocation) to create a CosmosDBLocationResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBLocationResource(ResourceIdentifier) instead. |
| GetCosmosDBLocations(SubscriptionResource) |
Gets a collection of CosmosDBLocationResources in the SubscriptionResource. MockingTo mock this method, please mock GetCosmosDBLocations() instead. |
| GetCosmosDBPrivateEndpointConnectionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBPrivateEndpointConnectionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBPrivateEndpointConnectionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBPrivateEndpointConnectionResource(ResourceIdentifier) instead. |
| GetCosmosDBPrivateLinkResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBPrivateLinkResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBPrivateLinkResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBPrivateLinkResource(ResourceIdentifier) instead. |
| GetCosmosDBServiceResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBServiceResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBServiceResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBServiceResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlClientEncryptionKeyResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlClientEncryptionKeyResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CosmosDBSqlClientEncryptionKeyResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlClientEncryptionKeyResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlContainerResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlContainerResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CosmosDBSqlContainerResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlContainerResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlContainerThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlContainerThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CosmosDBSqlContainerThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlContainerThroughputSettingResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlDatabaseResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlDatabaseResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBSqlDatabaseResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlDatabaseResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlDatabaseThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBSqlDatabaseThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlDatabaseThroughputSettingResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlRoleAssignmentResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlRoleAssignmentResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBSqlRoleAssignmentResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlRoleAssignmentResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlRoleDefinitionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlRoleDefinitionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBSqlRoleDefinitionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlRoleDefinitionResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlStoredProcedureResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlStoredProcedureResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String, String) to create a CosmosDBSqlStoredProcedureResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlStoredProcedureResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlTriggerResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlTriggerResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String, String) to create a CosmosDBSqlTriggerResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlTriggerResource(ResourceIdentifier) instead. |
| GetCosmosDBSqlUserDefinedFunctionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBSqlUserDefinedFunctionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String, String) to create a CosmosDBSqlUserDefinedFunctionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBSqlUserDefinedFunctionResource(ResourceIdentifier) instead. |
| GetCosmosDBTableResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosDBTableResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBTableResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosDBTableResource(ResourceIdentifier) instead. |
| GetCosmosTableThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a CosmosTableThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosTableThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetCosmosTableThroughputSettingResource(ResourceIdentifier) instead. |
| GetDataTransferJobGetResultResource(ArmClient, ResourceIdentifier) |
Gets an object representing a DataTransferJobGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a DataTransferJobGetResultResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetDataTransferJobGetResultResource(ResourceIdentifier) instead. |
| GetGraphResourceGetResultResource(ArmClient, ResourceIdentifier) |
Gets an object representing a GraphResourceGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a GraphResourceGetResultResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetGraphResourceGetResultResource(ResourceIdentifier) instead. |
| GetGremlinDatabaseResource(ArmClient, ResourceIdentifier) |
Gets an object representing a GremlinDatabaseResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a GremlinDatabaseResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetGremlinDatabaseResource(ResourceIdentifier) instead. |
| GetGremlinDatabaseThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a GremlinDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a GremlinDatabaseThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetGremlinDatabaseThroughputSettingResource(ResourceIdentifier) instead. |
| GetGremlinGraphResource(ArmClient, ResourceIdentifier) |
Gets an object representing a GremlinGraphResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a GremlinGraphResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetGremlinGraphResource(ResourceIdentifier) instead. |
| GetGremlinGraphThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a GremlinGraphThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a GremlinGraphThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetGremlinGraphThroughputSettingResource(ResourceIdentifier) instead. |
| GetMongoCluster(ResourceGroupResource, String, CancellationToken) |
Gets information about a mongo cluster.
|
| GetMongoClusterAsync(ResourceGroupResource, String, CancellationToken) |
Gets information about a mongo cluster.
|
| GetMongoClusterResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoClusterResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a MongoClusterResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoClusterResource(ResourceIdentifier) instead. |
| GetMongoClusters(ResourceGroupResource) |
Gets a collection of MongoClusterResources in the ResourceGroupResource. MockingTo mock this method, please mock GetMongoClusters() instead. |
| GetMongoClusters(SubscriptionResource, CancellationToken) |
List all the mongo clusters in a given subscription.
|
| GetMongoClustersAsync(SubscriptionResource, CancellationToken) |
List all the mongo clusters in a given subscription.
|
| GetMongoDBCollectionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBCollectionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a MongoDBCollectionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBCollectionResource(ResourceIdentifier) instead. |
| GetMongoDBCollectionThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBCollectionThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a MongoDBCollectionThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBCollectionThroughputSettingResource(ResourceIdentifier) instead. |
| GetMongoDBDatabaseResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBDatabaseResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a MongoDBDatabaseResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBDatabaseResource(ResourceIdentifier) instead. |
| GetMongoDBDatabaseThroughputSettingResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a MongoDBDatabaseThroughputSettingResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBDatabaseThroughputSettingResource(ResourceIdentifier) instead. |
| GetMongoDBRoleDefinitionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBRoleDefinitionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a MongoDBRoleDefinitionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBRoleDefinitionResource(ResourceIdentifier) instead. |
| GetMongoDBUserDefinitionResource(ArmClient, ResourceIdentifier) |
Gets an object representing a MongoDBUserDefinitionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a MongoDBUserDefinitionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetMongoDBUserDefinitionResource(ResourceIdentifier) instead. |
| GetRestorableCosmosDBAccountResource(ArmClient, ResourceIdentifier) |
Gets an object representing a RestorableCosmosDBAccountResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, AzureLocation, Guid) to create a RestorableCosmosDBAccountResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetRestorableCosmosDBAccountResource(ResourceIdentifier) instead. |
| GetRestorableCosmosDBAccounts(SubscriptionResource, CancellationToken) |
Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
|
| GetRestorableCosmosDBAccountsAsync(SubscriptionResource, CancellationToken) |
Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
|
| GetThroughputPoolAccountResource(ArmClient, ResourceIdentifier) |
Gets an object representing a ThroughputPoolAccountResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a ThroughputPoolAccountResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetThroughputPoolAccountResource(ResourceIdentifier) instead. |
| GetThroughputPoolResource(ArmClient, ResourceIdentifier) |
Gets an object representing a ThroughputPoolResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a ThroughputPoolResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetThroughputPoolResource(ResourceIdentifier) instead. |
| GetThroughputPoolResource(ResourceGroupResource, String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
|
| GetThroughputPoolResourceAsync(ResourceGroupResource, String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
|
| GetThroughputPoolResources(ResourceGroupResource) |
Gets a collection of ThroughputPoolResources in the ResourceGroupResource. MockingTo mock this method, please mock GetThroughputPoolResources() instead. |
| GetThroughputPoolResources(SubscriptionResource, CancellationToken) |
Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
|
| GetThroughputPoolResourcesAsync(SubscriptionResource, CancellationToken) |
Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
|
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for