DatabaseAccountGetResults Class

Reference

An Azure Cosmos DB database account.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

DatabaseAccountGetResults

Constructor

DatabaseAccountGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, kind: Optional[Union[str, _models.DatabaseAccountKind]] = None, identity: Optional[_models.ManagedServiceIdentity] = None, ip_rules: Optional[List[_models.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, consistency_policy: Optional[_models.ConsistencyPolicy] = None, capabilities: Optional[List[_models.Capability]] = None, virtual_network_rules: Optional[List[_models.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[Union[str, _models.ConnectorOffer]] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[_models.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[_models.AnalyticalStorageConfiguration] = None, create_mode: Optional[Union[str, _models.CreateMode]] = 'Default', restore_parameters: Optional[_models.RestoreParameters] = None, backup_policy: Optional[_models.BackupPolicy] = None, cors: Optional[List[_models.CorsPolicy]] = None, network_acl_bypass: Optional[Union[str, _models.NetworkAclBypass]] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, disable_local_auth: Optional[bool] = None, capacity: Optional[_models.Capacity] = None, **kwargs)

Variables

id: str

The unique resource identifier of the ARM resource.

name: str

The name of the ARM resource.

type: str

The type of Azure resource.

location: str

The location of the resource group to which the resource belongs.

tags: dict[str, str]

A set of 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".

kind: str or DatabaseAccountKind

Indicates the type of database account. This can only be set at database account creation. Known values are: "GlobalDocumentDB", "MongoDB", "Parse".

identity: ManagedServiceIdentity

Identity for the resource.

system_data: SystemData

The system meta data relating to this resource.

provisioning_state: str

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.

document_endpoint: str

The connection endpoint for the Cosmos DB database account.

database_account_offer_type: str

The offer type for the Cosmos DB database account. Default value: Standard. The only acceptable values to pass in are None and "Standard". The default value is None.

ip_rules: list[IpAddressOrRange]

List of IpRules.

is_virtual_network_filter_enabled: bool

Flag to indicate whether to enable/disable Virtual Network ACL rules.

enable_automatic_failover: bool

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.

consistency_policy: ConsistencyPolicy

The consistency policy for the Cosmos DB database account.

capabilities: list[Capability]

List of Cosmos DB capabilities for the account.

write_locations: list[Location]

An array that contains the write location for the Cosmos DB account.

read_locations: list[Location]

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

locations: list[Location]

An array that contains all of the locations enabled for the Cosmos DB account.

failover_policies: list[FailoverPolicy]

An array that contains the regions ordered by their failover priorities.

virtual_network_rules: list[VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.

private_endpoint_connections: list[PrivateEndpointConnection]

List of Private Endpoint Connections configured for the Cosmos DB account.

enable_multiple_write_locations: bool

Enables the account to write in multiple locations.

enable_cassandra_connector: bool

Enables the cassandra connector on the Cosmos DB C* account.

connector_offer: str or ConnectorOffer

The cassandra connector offer type for the Cosmos DB database C* account. Known values are: "Small".

disable_key_based_metadata_write_access: bool

Disable write operations on metadata resources (databases, containers, throughput) via account keys.

key_vault_key_uri: str

The URI of the key vault.

default_identity: str

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.

public_network_access: str or PublicNetworkAccess

Whether requests from Public Network are allowed. Known values are: "Enabled", "Disabled".

enable_free_tier: bool

Flag to indicate whether Free Tier is enabled.

api_properties: ApiProperties

API specific properties.

enable_analytical_storage: bool

Flag to indicate whether to enable storage analytics.

analytical_storage_configuration: AnalyticalStorageConfiguration

Analytical storage specific properties.

instance_id: str

A unique identifier assigned to the database account.

create_mode: str or CreateMode

Enum to indicate the mode of account creation. Known values are: "Default", "Restore". Default value: "Default".

restore_parameters: RestoreParameters

Parameters to indicate the information about the restore.

backup_policy: BackupPolicy

The object representing the policy for taking backups on an account.

cors: list[CorsPolicy]

The CORS policy for the Cosmos DB database account.

network_acl_bypass: str or NetworkAclBypass

Indicates what services are allowed to bypass firewall checks. Known values are: "None", "AzureServices".

network_acl_bypass_resource_ids: list[str]

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

disable_local_auth: bool

Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

capacity: Capacity

The object that represents all properties related to capacity enforcement on an account.

DatabaseAccountGetResults Class

Constructor

Variables

Feedback