DatabaseAccountUpdateParameters Class

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.CosmosDB.Models
Assembly:
Microsoft.Azure.Management.CosmosDB.dll
Package:
Microsoft.Azure.Management.CosmosDB v3.3.0

Parameters for patching Azure Cosmos DB database account properties.

[Microsoft.Rest.Serialization.JsonTransformation]
public class DatabaseAccountUpdateParameters
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DatabaseAccountUpdateParameters = class
Public Class DatabaseAccountUpdateParameters
Inheritance
Object
DatabaseAccountUpdateParameters
Attributes
JsonTransformationAttribute

Constructors

DatabaseAccountUpdateParameters()

Initializes a new instance of the DatabaseAccountUpdateParameters class.
DatabaseAccountUpdateParameters(IDictionary<String,String>, String, ManagedServiceIdentity, ConsistencyPolicy, IList<Location>, IList<IpAddressOrRange>, Nullable<Boolean>, Nullable<Boolean>, IList<Capability>, IList<VirtualNetworkRule>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, String, String, String, Nullable<Boolean>, ApiProperties, Nullable<Boolean>, AnalyticalStorageConfiguration, BackupPolicy, IList<CorsPolicy>, Nullable<NetworkAclBypass>, IList<String>, Nullable<Boolean>, Capacity)

Initializes a new instance of the DatabaseAccountUpdateParameters class.

Properties

AnalyticalStorageConfiguration

Gets or sets analytical storage specific properties.
ApiProperties

Gets or sets API specific properties. Currently, supported only for MongoDB API.
BackupPolicy

Gets or sets the object representing the policy for taking backups on an account.
Capabilities

Gets or sets list of Cosmos DB capabilities for the account
Capacity

Gets or sets the object that represents all properties related to capacity enforcement on an account.
ConnectorOffer

Gets or sets the cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'
ConsistencyPolicy

Gets or sets the consistency policy for the Cosmos DB account.
Cors

Gets or sets the CORS policy for the Cosmos DB database account.
DefaultIdentity

Gets or sets 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

Gets or sets disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableLocalAuth

Gets or sets opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
EnableAnalyticalStorage

Gets or sets flag to indicate whether to enable storage analytics.
EnableAutomaticFailover

Gets or sets 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

Gets or sets enables the cassandra connector on the Cosmos DB C* account
EnableFreeTier

Gets or sets flag to indicate whether Free Tier is enabled.
EnableMultipleWriteLocations

Gets or sets enables the account to write in multiple locations
Identity
IpRules

Gets or sets list of IpRules.
IsVirtualNetworkFilterEnabled

Gets or sets flag to indicate whether to enable/disable Virtual Network ACL rules.
KeyVaultKeyUri

Gets or sets the URI of the key vault
Location

Gets or sets the location of the resource group to which the resource belongs.
Locations

Gets or sets an array that contains the georeplication locations enabled for the Cosmos DB account.
NetworkAclBypass

Gets or sets indicates what services are allowed to bypass firewall checks. Possible values include: 'None', 'AzureServices'
NetworkAclBypassResourceIds

Gets or sets an array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
PublicNetworkAccess

Gets or sets whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
Tags
VirtualNetworkRules

Gets or sets list of Virtual Network ACL rules configured for the Cosmos DB account.

Methods

Validate()

Validate the object.

Applies to