DatabaseAccountCreateUpdateParameters 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.
Parameters to create and update Cosmos DB database accounts.
[Microsoft.Rest.Serialization.JsonTransformation]
public class DatabaseAccountCreateUpdateParameters : Microsoft.Azure.Management.CosmosDB.Models.ARMResourceProperties
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DatabaseAccountCreateUpdateParameters = class
inherit ARMResourceProperties
Public Class DatabaseAccountCreateUpdateParameters
Inherits ARMResourceProperties
- Inheritance
- Attributes
Constructors
DatabaseAccountCreateUpdateParameters() |
Initializes a new instance of the DatabaseAccountCreateUpdateParameters class. |
DatabaseAccountCreateUpdateParameters(IList<Location>, String, String, String, String, IDictionary<String,String>, String, ManagedServiceIdentity, ConsistencyPolicy, 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, String, BackupPolicy, IList<CorsPolicy>, Nullable<NetworkAclBypass>, IList<String>, Nullable<Boolean>, RestoreParameters, Capacity) |
Initializes a new instance of the DatabaseAccountCreateUpdateParameters 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. |
CreateMode |
Gets or sets enum to indicate the mode of account creation. Possible values include: 'Default', 'Restore' |
DatabaseAccountOfferType |
The offer type for the database |
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 |
Id |
Gets the unique resource identifier of the ARM resource. (Inherited from ARMResourceProperties) |
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 |
Kind |
Gets or sets indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse' |
Location |
Gets or sets the location of the resource group to which the resource belongs. (Inherited from ARMResourceProperties) |
Locations |
Gets or sets an array that contains the georeplication locations enabled for the Cosmos DB account. |
Name |
Gets the name of the ARM resource. (Inherited from ARMResourceProperties) |
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' |
RestoreParameters |
Gets or sets parameters to indicate the information about the restore. |
Tags | (Inherited from ARMResourceProperties) |
Type |
Gets the type of Azure resource. (Inherited from ARMResourceProperties) |
VirtualNetworkRules |
Gets or sets list of Virtual Network ACL rules configured for the Cosmos DB account. |
Methods
Validate() |
Validate the object. |