CosmosDBAccountResource 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 representing a CosmosDBAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CosmosDBAccountResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCosmosDBAccounts method.
public class CosmosDBAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>
type CosmosDBAccountResource = class
inherit ArmResource
interface IJsonModel<CosmosDBAccountData>
interface IPersistableModel<CosmosDBAccountData>
Public Class CosmosDBAccountResource
Inherits ArmResource
Implements IJsonModel(Of CosmosDBAccountData), IPersistableModel(Of CosmosDBAccountData)
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| CosmosDBAccountResource() |
Initializes a new instance of CosmosDBAccountResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Deletes an existing Azure Cosmos DB database account.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes an existing Azure Cosmos DB database account.
|
| FailoverPriorityChange(WaitUntil, CosmosDBFailoverPolicies, CancellationToken) |
Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
|
| FailoverPriorityChangeAsync(WaitUntil, CosmosDBFailoverPolicies, CancellationToken) |
Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
|
| Get(CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB database account.
|
| GetAsync(CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB database account.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetCassandraKeyspace(String, CancellationToken) |
Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. |
| GetCassandraKeyspaceAsync(String, CancellationToken) |
Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. |
| GetCassandraKeyspaces() |
Gets a collection of CassandraKeyspaces in the CosmosDBAccountResource. |
| GetCassandraRoleAssignment(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id. |
| GetCassandraRoleAssignmentAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id. |
| GetCassandraRoleAssignments() |
Gets a collection of CassandraRoleAssignments in the CosmosDBAccountResource. |
| GetCassandraRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id. |
| GetCassandraRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id. |
| GetCassandraRoleDefinitions() |
Gets a collection of CassandraRoleDefinitions in the CosmosDBAccountResource. |
| GetConnectionStrings(CancellationToken) |
Lists the connection strings for the specified Azure Cosmos DB database account. |
| GetConnectionStringsAsync(CancellationToken) |
Lists the connection strings for the specified Azure Cosmos DB database account. |
| GetCosmosDBChaosFaultResource(String, CancellationToken) |
Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.
|
| GetCosmosDBChaosFaultResourceAsync(String, CancellationToken) |
Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.
|
| GetCosmosDBChaosFaultResources() |
Gets a collection of CosmosDBChaosFaultResources in the CosmosDBAccount. |
| GetCosmosDBPrivateEndpointConnection(String, CancellationToken) |
Gets a private endpoint connection. |
| GetCosmosDBPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets a private endpoint connection. |
| GetCosmosDBPrivateEndpointConnections() |
Gets a collection of CosmosDBPrivateEndpointConnections in the CosmosDBAccountResource. |
| GetCosmosDBPrivateLinkResource(String, CancellationToken) |
Gets the private link resources that need to be created for a Cosmos DB account. |
| GetCosmosDBPrivateLinkResourceAsync(String, CancellationToken) |
Gets the private link resources that need to be created for a Cosmos DB account. |
| GetCosmosDBPrivateLinkResources() |
Gets a collection of CosmosDBPrivateLinkResources in the CosmosDBAccountResource. |
| GetCosmosDBService(String, CancellationToken) |
Gets the status of service. |
| GetCosmosDBServiceAsync(String, CancellationToken) |
Gets the status of service. |
| GetCosmosDBServices() |
Gets a collection of CosmosDBServices in the CosmosDBAccountResource. |
| GetCosmosDBSqlDatabase(String, CancellationToken) |
Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. |
| GetCosmosDBSqlDatabaseAsync(String, CancellationToken) |
Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. |
| GetCosmosDBSqlDatabases() |
Gets a collection of CosmosDBSqlDatabases in the CosmosDBAccountResource. |
| GetCosmosDBSqlRoleAssignment(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id. |
| GetCosmosDBSqlRoleAssignmentAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id. |
| GetCosmosDBSqlRoleAssignments() |
Gets a collection of CosmosDBSqlRoleAssignments in the CosmosDBAccountResource. |
| GetCosmosDBSqlRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. |
| GetCosmosDBSqlRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. |
| GetCosmosDBSqlRoleDefinitions() |
Gets a collection of CosmosDBSqlRoleDefinitions in the CosmosDBAccountResource. |
| GetCosmosDBTable(String, CancellationToken) |
Gets the Tables under an existing Azure Cosmos DB database account with the provided name. |
| GetCosmosDBTableAsync(String, CancellationToken) |
Gets the Tables under an existing Azure Cosmos DB database account with the provided name. |
| GetCosmosDBTableRoleAssignment(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id. |
| GetCosmosDBTableRoleAssignmentAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id. |
| GetCosmosDBTableRoleAssignments() |
Gets a collection of CosmosDBTableRoleAssignments in the CosmosDBAccountResource. |
| GetCosmosDBTableRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id. |
| GetCosmosDBTableRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id. |
| GetCosmosDBTableRoleDefinitions() |
Gets a collection of CosmosDBTableRoleDefinitions in the CosmosDBAccountResource. |
| GetCosmosDBTables() |
Gets a collection of CosmosDBTables in the CosmosDBAccountResource. |
| GetDataTransferJobGetResult(String, CancellationToken) |
Get a Data Transfer Job.
|
| GetDataTransferJobGetResultAsync(String, CancellationToken) |
Get a Data Transfer Job.
|
| GetDataTransferJobGetResults() |
Gets a collection of DataTransferJobGetResultResources in the CosmosDBAccount. |
| GetGraphResourceGetResult(String, CancellationToken) |
Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.
|
| GetGraphResourceGetResultAsync(String, CancellationToken) |
Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.
|
| GetGraphResourceGetResults() |
Gets a collection of GraphResourceGetResultResources in the CosmosDBAccount. |
| GetGremlinDatabase(String, CancellationToken) |
Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. |
| GetGremlinDatabaseAsync(String, CancellationToken) |
Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. |
| GetGremlinDatabases() |
Gets a collection of GremlinDatabases in the CosmosDBAccountResource. |
| GetGremlinRoleAssignment(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id. |
| GetGremlinRoleAssignmentAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id. |
| GetGremlinRoleAssignments() |
Gets a collection of GremlinRoleAssignments in the CosmosDBAccountResource. |
| GetGremlinRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id. |
| GetGremlinRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id. |
| GetGremlinRoleDefinitions() |
Gets a collection of GremlinRoleDefinitions in the CosmosDBAccountResource. |
| GetKeys(CancellationToken) |
Lists the access keys for the specified Azure Cosmos DB database account.
|
| GetKeysAsync(CancellationToken) |
Lists the access keys for the specified Azure Cosmos DB database account.
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetMetricDefinitions(CancellationToken) |
Retrieves metric definitions for the given database account.
|
| GetMetricDefinitionsAsync(CancellationToken) |
Retrieves metric definitions for the given database account.
|
| GetMetricDefinitionsCollections(String, String, CancellationToken) |
Retrieves metric definitions for the given collection.
|
| GetMetricDefinitionsCollectionsAsync(String, String, CancellationToken) |
Retrieves metric definitions for the given collection.
|
| GetMetricDefinitionsDatabases(String, CancellationToken) |
Retrieves metric definitions for the given database.
|
| GetMetricDefinitionsDatabasesAsync(String, CancellationToken) |
Retrieves metric definitions for the given database.
|
| GetMetrics(String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account.
|
| GetMetricsAsync(String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account.
|
| GetMetricsCollectionPartitionRegions(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
|
| GetMetricsCollectionPartitionRegionsAsync(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
|
| GetMetricsCollectionPartitions(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given collection, split by partition.
|
| GetMetricsCollectionPartitionsAsync(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given collection, split by partition.
|
| GetMetricsCollectionRegions(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account, collection and region.
|
| GetMetricsCollectionRegionsAsync(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account, collection and region.
|
| GetMetricsCollections(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and collection.
|
| GetMetricsCollectionsAsync(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and collection.
|
| GetMetricsDatabaseAccountRegions(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and region.
|
| GetMetricsDatabaseAccountRegionsAsync(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and region.
|
| GetMetricsDatabases(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and database.
|
| GetMetricsDatabasesAsync(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account and database.
|
| GetMetricsPartitionKeyRangeIdRegions(String, String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given partition key range id and region.
|
| GetMetricsPartitionKeyRangeIdRegionsAsync(String, String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given partition key range id and region.
|
| GetMetricsPartitionKeyRangeIds(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given partition key range id.
|
| GetMetricsPartitionKeyRangeIdsAsync(String, String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given partition key range id.
|
| GetMetricsPercentiles(String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
|
| GetMetricsPercentilesAsync(String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
|
| GetMetricsPercentileSourceTargets(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data
|
| GetMetricsPercentileSourceTargetsAsync(String, String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data
|
| GetMetricsPercentileTargets(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
|
| GetMetricsPercentileTargetsAsync(String, String, CancellationToken) |
Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
|
| GetMongoDBDatabase(String, CancellationToken) |
Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. |
| GetMongoDBDatabaseAsync(String, CancellationToken) |
Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. |
| GetMongoDBDatabases() |
Gets a collection of MongoDBDatabases in the CosmosDBAccountResource. |
| GetMongoDBRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id. |
| GetMongoDBRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id. |
| GetMongoDBRoleDefinitions() |
Gets a collection of MongoDBRoleDefinitions in the CosmosDBAccountResource. |
| GetMongoDBUserDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. |
| GetMongoDBUserDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. |
| GetMongoDBUserDefinitions() |
Gets a collection of MongoDBUserDefinitions in the CosmosDBAccountResource. |
| GetMongoMIRoleAssignment(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Assignment with the given Id. |
| GetMongoMIRoleAssignmentAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Assignment with the given Id. |
| GetMongoMIRoleAssignments() |
Gets a collection of MongoMIRoleAssignments in the CosmosDBAccountResource. |
| GetMongoMIRoleDefinition(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Definition with the given Id. |
| GetMongoMIRoleDefinitionAsync(String, CancellationToken) |
Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Definition with the given Id. |
| GetMongoMIRoleDefinitions() |
Gets a collection of MongoMIRoleDefinitions in the CosmosDBAccountResource. |
| GetNetworkSecurityPerimeterConfiguration(String, CancellationToken) |
Gets effective Network Security Perimeter Configuration for association
|
| GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken) |
Gets effective Network Security Perimeter Configuration for association
|
| GetNetworkSecurityPerimeterConfigurations() |
Gets a collection of NetworkSecurityPerimeterConfigurationResources in the CosmosDBAccount. |
| GetNotebookWorkspace(NotebookWorkspaceName, CancellationToken) |
Gets the notebook workspace for a Cosmos DB account. |
| GetNotebookWorkspaceAsync(NotebookWorkspaceName, CancellationToken) |
Gets the notebook workspace for a Cosmos DB account. |
| GetNotebookWorkspaces() |
Gets a collection of NotebookWorkspaces in the CosmosDBAccountResource. |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetReadOnlyKeys(CancellationToken) |
Lists the read-only access keys for the specified Azure Cosmos DB database account.
|
| GetReadOnlyKeysAsync(CancellationToken) |
Lists the read-only access keys for the specified Azure Cosmos DB database account.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GetUsages(String, CancellationToken) |
Retrieves the usages (most recent data) for the given database account.
|
| GetUsagesAsync(String, CancellationToken) |
Retrieves the usages (most recent data) for the given database account.
|
| GetUsagesCollectionPartitions(String, String, String, CancellationToken) |
Retrieves the usages (most recent storage data) for the given collection, split by partition.
|
| GetUsagesCollectionPartitionsAsync(String, String, String, CancellationToken) |
Retrieves the usages (most recent storage data) for the given collection, split by partition.
|
| GetUsagesCollections(String, String, String, CancellationToken) |
Retrieves the usages (most recent storage data) for the given collection.
|
| GetUsagesCollectionsAsync(String, String, String, CancellationToken) |
Retrieves the usages (most recent storage data) for the given collection.
|
| GetUsagesDatabases(String, String, CancellationToken) |
Retrieves the usages (most recent data) for the given database.
|
| GetUsagesDatabasesAsync(String, String, CancellationToken) |
Retrieves the usages (most recent data) for the given database.
|
| OfflineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken) |
Offline the specified region for the specified Azure Cosmos DB database account.
|
| OfflineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken) |
Offline the specified region for the specified Azure Cosmos DB database account.
|
| OnlineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken) |
Online the specified region for the specified Azure Cosmos DB database account.
|
| OnlineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken) |
Online the specified region for the specified Azure Cosmos DB database account.
|
| RegenerateKey(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken) |
Regenerates an access key for the specified Azure Cosmos DB database account.
|
| RegenerateKeyAsync(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken) |
Regenerates an access key for the specified Azure Cosmos DB database account.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, CosmosDBAccountPatch, CancellationToken) |
Updates the properties of an existing Azure Cosmos DB database account.
|
| UpdateAsync(WaitUntil, CosmosDBAccountPatch, CancellationToken) |
Updates the properties of an existing Azure Cosmos DB database account.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<CosmosDBAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<CosmosDBAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<CosmosDBAccountData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<CosmosDBAccountData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<CosmosDBAccountData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |