CosmosDBAccountData Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountData.cs

A class representing the CosmosDBAccount data model. An Azure Cosmos DB database account.

public class CosmosDBAccountData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>

type CosmosDBAccountData = class
    inherit TrackedResourceData
    interface IJsonModel<CosmosDBAccountData>
    interface IPersistableModel<CosmosDBAccountData>

Public Class CosmosDBAccountData
Inherits TrackedResourceData
Implements IJsonModel(Of CosmosDBAccountData), IPersistableModel(Of CosmosDBAccountData)

Inheritance

Object

ResourceData

TrackedResourceData

CosmosDBAccountData

Implements

IJsonModel<CosmosDBAccountData> IPersistableModel<CosmosDBAccountData> IPersistableModel<T>

Constructors

CosmosDBAccountData(AzureLocation)

Initializes a new instance of CosmosDBAccountData.

Properties

AnalyticalStorageSchemaType	Describes the types of schema for analytical storage.
ApiServerVersion	Describes the version of the MongoDB account.
BackupPolicy	The object representing the policy for taking backups on an account. Please note CosmosDBAccountBackupPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ContinuousModeBackupPolicy and PeriodicModeBackupPolicy.
Capabilities	List of Cosmos DB capabilities for the account.
CapacityTotalThroughputLimit	The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
ConnectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy	The consistency policy for the Cosmos DB database account.
Cors	The CORS policy for the Cosmos DB database account.
CreateMode	Enum to indicate the mode of account creation.
DatabaseAccountOfferType	The offer type for the Cosmos DB database account. Default value: Standard.
DefaultIdentity	The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DisableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys.
DisableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
DocumentEndpoint	The connection endpoint for the Cosmos DB database account.
EnableAutomaticFailover	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account.
EnableMultipleWriteLocations	Enables the account to write in multiple locations.
EnablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account.
FailoverPolicies	An array that contains the regions ordered by their failover priorities.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData)
Identity	Identity for the resource.
InstanceId	A unique identifier assigned to the database account.
IPRules	List of IpRules.
IsAnalyticalStorageEnabled	Flag to indicate whether to enable storage analytics.
IsFreeTierEnabled	Flag to indicate whether Free Tier is enabled.
IsVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.
KeysMetadata	The object that represents the metadata for the Account Keys of the Cosmos DB account.
KeyVaultKeyUri	The URI of the key vault.
Kind	Indicates the type of database account. This can only be set at database account creation.
Location	The geo-location where the resource lives. (Inherited from TrackedResourceData)
Locations	An array that contains all of the locations enabled for the Cosmos DB account.
MinimalTlsVersion	Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.
Name	The name of the resource. (Inherited from ResourceData)
NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
NetworkAclBypassResourceIds	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
PrivateEndpointConnections	List of Private Endpoint Connections configured for the Cosmos DB account.
ProvisioningState	The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
PublicNetworkAccess	Whether requests from Public Network are allowed.
ReadLocations	An array that contains of the read locations enabled for the Cosmos DB account.
ResourceType	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData)
RestoreParameters	Parameters to indicate the information about the restore.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData)
Tags	Resource tags. (Inherited from TrackedResourceData)
VirtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.
WriteLocations	An array that contains the write location for the Cosmos DB account.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

(Inherited from TrackedResourceData)

Explicit Interface Implementations

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.