CosmosDBAccountPatch Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB.Models

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountPatch.cs

Parameters for patching Azure Cosmos DB database account properties.

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

type CosmosDBAccountPatch = class
    interface IJsonModel<CosmosDBAccountPatch>
    interface IPersistableModel<CosmosDBAccountPatch>

Public Class CosmosDBAccountPatch
Implements IJsonModel(Of CosmosDBAccountPatch), IPersistableModel(Of CosmosDBAccountPatch)

Inheritance

Object

CosmosDBAccountPatch

Implements

IJsonModel<CosmosDBAccountPatch> IPersistableModel<CosmosDBAccountPatch> IPersistableModel<T>

Constructors

CosmosDBAccountPatch()

Initializes a new instance of CosmosDBAccountPatch.

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 account.
Cors	The CORS policy for the Cosmos DB database account.
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.
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.
Identity	Identity for the resource.
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	This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.
KeyVaultKeyUri	The URI of the key vault.
Location	The location of the resource group to which the resource belongs.
Locations	An array that contains the georeplication 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.
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.
PublicNetworkAccess	Whether requests from Public Network are allowed.
Tags	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
VirtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.

Explicit Interface Implementations

IJsonModel<CosmosDBAccountPatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBAccountPatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CosmosDBAccountPatch>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBAccountPatch>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBAccountPatch>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.