DatabaseAccountGetResults Class

Definition

An Azure Cosmos DB database account.

[Microsoft.Rest.Serialization.JsonTransformation]
public class DatabaseAccountGetResults : Microsoft.Azure.Management.CosmosDB.Models.ARMResourceProperties
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DatabaseAccountGetResults = class
    inherit ARMResourceProperties
Public Class DatabaseAccountGetResults
Inherits ARMResourceProperties
Inheritance
DatabaseAccountGetResults
Attributes

Constructors

DatabaseAccountGetResults()

Initializes a new instance of the DatabaseAccountGetResults class.

DatabaseAccountGetResults(String, String, String, String, IDictionary<String, String>, String, ManagedServiceIdentity, String, String, Nullable<DatabaseAccountOfferType>, IList<IpAddressOrRange>, Nullable<Boolean>, Nullable<Boolean>, ConsistencyPolicy, IList<Capability>, IList<Location>, IList<Location>, IList<Location>, IList<FailoverPolicy>, IList<VirtualNetworkRule>, IList<PrivateEndpointConnection>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, String, String, String, Nullable<Boolean>, ApiProperties, Nullable<Boolean>, AnalyticalStorageConfiguration, String, String, RestoreParameters, BackupPolicy, IList<CorsPolicy>, Nullable<NetworkAclBypass>, IList<String>, Nullable<Boolean>, Capacity, SystemData)

Initializes a new instance of the DatabaseAccountGetResults class.

Properties

AnalyticalStorageConfiguration

Gets or sets analytical storage specific properties.

ApiProperties

Gets or sets API specific properties.

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 database 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

Gets the offer type for the Cosmos DB database account. Default value: Standard. Possible values include: 'Standard'

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.

DocumentEndpoint

Gets the connection endpoint for the Cosmos DB database account.

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

FailoverPolicies

Gets an array that contains the regions ordered by their failover priorities.

Id

Gets the unique resource identifier of the ARM resource.

(Inherited from ARMResourceProperties)
Identity
InstanceId

Gets a unique identifier assigned to the database account

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 an array that contains all of the 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.

PrivateEndpointConnections

Gets list of Private Endpoint Connections configured for the Cosmos DB account.

ProvisioningState
PublicNetworkAccess

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

ReadLocations

Gets an array that contains of the read locations enabled for the Cosmos DB account.

RestoreParameters

Gets or sets parameters to indicate the information about the restore.

SystemData

Gets the system meta data relating to this resource.

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.

WriteLocations

Gets an array that contains the write location for the Cosmos DB account.

Methods

Validate()

Validate the object.

Applies to