DatabaseAccountGetResultsInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. core. management. Resource - com.
azure. resourcemanager. cosmos. models. ArmResourceProperties - com.
azure. resourcemanager. cosmos. fluent. models. DatabaseAccountGetResultsInner
- com.
- com.
- com.
- com.
public final class DatabaseAccountGetResultsInner
extends ArmResourceProperties
An Azure Cosmos DB database account.
Constructor Summary
Constructor | Description |
---|---|
DatabaseAccountGetResultsInner() |
Creates an instance of Database |
Method Summary
Modifier and Type | Method and Description |
---|---|
Analytical |
analyticalStorageConfiguration()
Get the analytical |
Api |
apiProperties()
Get the api |
Backup |
backupPolicy()
Get the backup |
List<Capability> |
capabilities()
Get the capabilities property: List of Cosmos DB capabilities for the account. |
Capacity |
capacity()
Get the capacity property: The object that represents all properties related to capacity enforcement on an account. |
Connector |
connectorOffer()
Get the connector |
Consistency |
consistencyPolicy()
Get the consistency |
List<Cors |
cors()
Get the cors property: The CORS policy for the Cosmos DB database account. |
Create |
createMode()
Get the create |
String |
customerManagedKeyStatus()
Get the customer |
Database |
databaseAccountOfferType()
Get the database |
String |
defaultIdentity()
Get the default |
Boolean |
disableKeyBasedMetadataWriteAccess()
Get the disable |
Boolean |
disableLocalAuth()
Get the disable |
String |
documentEndpoint()
Get the document |
Boolean |
enableAnalyticalStorage()
Get the enable |
Boolean |
enableAutomaticFailover()
Get the enable |
Boolean |
enableBurstCapacity()
Get the enable |
Boolean |
enableCassandraConnector()
Get the enable |
Boolean |
enableFreeTier()
Get the enable |
Boolean |
enableMultipleWriteLocations()
Get the enable |
Boolean |
enablePartitionMerge()
Get the enable |
Boolean |
enablePerRegionPerPartitionAutoscale()
Get the enable |
List<Failover |
failoverPolicies()
Get the failover |
static
Database |
fromJson(JsonReader jsonReader)
Reads an instance of Database |
String |
id()
Get the id property: Fully qualified resource Id for the resource. |
Managed |
identity()
Get the identity property: Identity for the resource. |
String |
instanceId()
Get the instance |
List<Ip |
ipRules()
Get the ip |
Boolean |
isVirtualNetworkFilterEnabled()
Get the is |
String |
keyVaultKeyUri()
Get the key |
Database |
keysMetadata()
Get the keys |
Database |
kind()
Get the kind property: Indicates the type of database account. |
List<Location> |
locations()
Get the locations property: An array that contains all of the locations enabled for the Cosmos DB account. |
Minimal |
minimalTlsVersion()
Get the minimal |
String |
name()
Get the name property: The name of the resource. |
Network |
networkAclBypass()
Get the network |
List<String> |
networkAclBypassResourceIds()
Get the network |
List<Private |
privateEndpointConnections()
Get the private |
String |
provisioningState()
Get the provisioning |
Public |
publicNetworkAccess()
Get the public |
List<Location> |
readLocations()
Get the read |
Restore |
restoreParameters()
Get the restore |
System |
systemData()
Get the system |
Json |
toJson(JsonWriter jsonWriter) |
String |
type()
Get the type property: The type of the resource. |
void |
validate()
Validates the instance. |
List<Virtual |
virtualNetworkRules()
Get the virtual |
Database |
withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration)
Set the analytical |
Database |
withApiProperties(ApiProperties apiProperties)
Set the api |
Database |
withBackupPolicy(BackupPolicy backupPolicy)
Set the backup |
Database |
withCapabilities(List<Capability> capabilities)
Set the capabilities property: List of Cosmos DB capabilities for the account. |
Database |
withCapacity(Capacity capacity)
Set the capacity property: The object that represents all properties related to capacity enforcement on an account. |
Database |
withConnectorOffer(ConnectorOffer connectorOffer)
Set the connector |
Database |
withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
Set the consistency |
Database |
withCors(List<CorsPolicy> cors)
Set the cors property: The CORS policy for the Cosmos DB database account. |
Database |
withCreateMode(CreateMode createMode)
Set the create |
Database |
withCustomerManagedKeyStatus(String customerManagedKeyStatus)
Set the customer |
Database |
withDefaultIdentity(String defaultIdentity)
Set the default |
Database |
withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)
Set the disable |
Database |
withDisableLocalAuth(Boolean disableLocalAuth)
Set the disable |
Database |
withEnableAnalyticalStorage(Boolean enableAnalyticalStorage)
Set the enable |
Database |
withEnableAutomaticFailover(Boolean enableAutomaticFailover)
Set the enable |
Database |
withEnableBurstCapacity(Boolean enableBurstCapacity)
Set the enable |
Database |
withEnableCassandraConnector(Boolean enableCassandraConnector)
Set the enable |
Database |
withEnableFreeTier(Boolean enableFreeTier)
Set the enable |
Database |
withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
Set the enable |
Database |
withEnablePartitionMerge(Boolean enablePartitionMerge)
Set the enable |
Database |
withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale)
Set the enable |
Database |
withIdentity(ManagedServiceIdentity identity)
Set the identity property: Identity for the resource. |
Database |
withIpRules(List<IpAddressOrRange> ipRules)
Set the ip |
Database |
withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
Set the is |
Database |
withKeyVaultKeyUri(String keyVaultKeyUri)
Set the key |
Database |
withKind(DatabaseAccountKind kind)
Set the kind property: Indicates the type of database account. |
Database |
withLocation(String location) |
Database |
withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion)
Set the minimal |
Database |
withNetworkAclBypass(NetworkAclBypass networkAclBypass)
Set the network |
Database |
withNetworkAclBypassResourceIds(List<String> networkAclBypassResourceIds)
Set the network |
Database |
withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the public |
Database |
withRestoreParameters(RestoreParameters restoreParameters)
Set the restore |
Database |
withTags(Map<String,String> tags) |
Database |
withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)
Set the virtual |
List<Location> |
writeLocations()
Get the write |
Methods inherited from Resource
Methods inherited from ArmResourceProperties
Methods inherited from java.lang.Object
Constructor Details
DatabaseAccountGetResultsInner
public DatabaseAccountGetResultsInner()
Creates an instance of DatabaseAccountGetResultsInner class.
Method Details
analyticalStorageConfiguration
public AnalyticalStorageConfiguration analyticalStorageConfiguration()
Get the analyticalStorageConfiguration property: Analytical storage specific properties.
Returns:
apiProperties
public ApiProperties apiProperties()
Get the apiProperties property: API specific properties.
Returns:
backupPolicy
public BackupPolicy backupPolicy()
Get the backupPolicy property: The object representing the policy for taking backups on an account.
Returns:
capabilities
public List
Get the capabilities property: List of Cosmos DB capabilities for the account.
Returns:
capacity
public Capacity capacity()
Get the capacity property: The object that represents all properties related to capacity enforcement on an account.
Returns:
connectorOffer
public ConnectorOffer connectorOffer()
Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
Returns:
consistencyPolicy
public ConsistencyPolicy consistencyPolicy()
Get the consistencyPolicy property: The consistency policy for the Cosmos DB database account.
Returns:
cors
public List
Get the cors property: The CORS policy for the Cosmos DB database account.
Returns:
createMode
public CreateMode createMode()
Get the createMode property: Enum to indicate the mode of account creation.
Returns:
customerManagedKeyStatus
public String customerManagedKeyStatus()
Get the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
Returns:
databaseAccountOfferType
public DatabaseAccountOfferType databaseAccountOfferType()
Get the databaseAccountOfferType property: The offer type for the Cosmos DB database account. Default value: Standard.
Returns:
defaultIdentity
public String defaultIdentity()
Get the defaultIdentity property: 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.
Returns:
disableKeyBasedMetadataWriteAccess
public Boolean disableKeyBasedMetadataWriteAccess()
Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Returns:
disableLocalAuth
public Boolean disableLocalAuth()
Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
Returns:
documentEndpoint
public String documentEndpoint()
Get the documentEndpoint property: The connection endpoint for the Cosmos DB database account.
Returns:
enableAnalyticalStorage
public Boolean enableAnalyticalStorage()
Get the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
Returns:
enableAutomaticFailover
public Boolean enableAutomaticFailover()
Get the enableAutomaticFailover property: 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.
Returns:
enableBurstCapacity
public Boolean enableBurstCapacity()
Get the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
Returns:
enableCassandraConnector
public Boolean enableCassandraConnector()
Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Returns:
enableFreeTier
public Boolean enableFreeTier()
Get the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
Returns:
enableMultipleWriteLocations
public Boolean enableMultipleWriteLocations()
Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
Returns:
enablePartitionMerge
public Boolean enablePartitionMerge()
Get the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
Returns:
enablePerRegionPerPartitionAutoscale
public Boolean enablePerRegionPerPartitionAutoscale()
Get the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
Returns:
failoverPolicies
public List
Get the failoverPolicies property: An array that contains the regions ordered by their failover priorities.
Returns:
fromJson
public static DatabaseAccountGetResultsInner fromJson(JsonReader jsonReader)
Reads an instance of DatabaseAccountGetResultsInner from the JsonReader.
Parameters:
Returns:
Throws:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
DatabaseAccountGetResultsInner.id()Returns:
identity
public ManagedServiceIdentity identity()
Get the identity property: Identity for the resource.
Returns:
instanceId
public String instanceId()
Get the instanceId property: A unique identifier assigned to the database account.
Returns:
ipRules
public List
Get the ipRules property: List of IpRules.
Returns:
isVirtualNetworkFilterEnabled
public Boolean isVirtualNetworkFilterEnabled()
Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
Returns:
keyVaultKeyUri
public String keyVaultKeyUri()
Get the keyVaultKeyUri property: The URI of the key vault.
Returns:
keysMetadata
public DatabaseAccountKeysMetadata keysMetadata()
Get the keysMetadata property: The object that represents the metadata for the Account Keys of the Cosmos DB account.
Returns:
kind
public DatabaseAccountKind kind()
Get the kind property: Indicates the type of database account. This can only be set at database account creation.
Returns:
locations
public List
Get the locations property: An array that contains all of the locations enabled for the Cosmos DB account.
Returns:
minimalTlsVersion
public MinimalTlsVersion minimalTlsVersion()
Get the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
Returns:
name
public String name()
Get the name property: The name of the resource.
Overrides:
DatabaseAccountGetResultsInner.name()Returns:
networkAclBypass
public NetworkAclBypass networkAclBypass()
Get the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
Returns:
networkAclBypassResourceIds
public List
Get the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
Returns:
privateEndpointConnections
public List
Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the Cosmos DB account.
Returns:
provisioningState
public String provisioningState()
Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' \u2013 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' \u2013 the Cosmos DB account is active for use. 'Updating' \u2013 the Cosmos DB account is being updated. 'Deleting' \u2013 the Cosmos DB account is being deleted. 'Failed' \u2013 the Cosmos DB account failed creation. 'DeletionFailed' \u2013 the Cosmos DB account deletion failed.
Returns:
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
Returns:
readLocations
public List
Get the readLocations property: An array that contains of the read locations enabled for the Cosmos DB account.
Returns:
restoreParameters
public RestoreParameters restoreParameters()
Get the restoreParameters property: Parameters to indicate the information about the restore.
Returns:
systemData
public SystemData systemData()
Get the systemData property: The system meta data relating to this resource.
Returns:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
DatabaseAccountGetResultsInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
DatabaseAccountGetResultsInner.type()Returns:
validate
public void validate()
Validates the instance.
Overrides:
DatabaseAccountGetResultsInner.validate()virtualNetworkRules
public List
Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
Returns:
withAnalyticalStorageConfiguration
public DatabaseAccountGetResultsInner withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration)
Set the analyticalStorageConfiguration property: Analytical storage specific properties.
Parameters:
Returns:
withApiProperties
public DatabaseAccountGetResultsInner withApiProperties(ApiProperties apiProperties)
Set the apiProperties property: API specific properties.
Parameters:
Returns:
withBackupPolicy
public DatabaseAccountGetResultsInner withBackupPolicy(BackupPolicy backupPolicy)
Set the backupPolicy property: The object representing the policy for taking backups on an account.
Parameters:
Returns:
withCapabilities
public DatabaseAccountGetResultsInner withCapabilities(List
Set the capabilities property: List of Cosmos DB capabilities for the account.
Parameters:
Returns:
withCapacity
public DatabaseAccountGetResultsInner withCapacity(Capacity capacity)
Set the capacity property: The object that represents all properties related to capacity enforcement on an account.
Parameters:
Returns:
withConnectorOffer
public DatabaseAccountGetResultsInner withConnectorOffer(ConnectorOffer connectorOffer)
Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
Parameters:
Returns:
withConsistencyPolicy
public DatabaseAccountGetResultsInner withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
Set the consistencyPolicy property: The consistency policy for the Cosmos DB database account.
Parameters:
Returns:
withCors
public DatabaseAccountGetResultsInner withCors(List
Set the cors property: The CORS policy for the Cosmos DB database account.
Parameters:
Returns:
withCreateMode
public DatabaseAccountGetResultsInner withCreateMode(CreateMode createMode)
Set the createMode property: Enum to indicate the mode of account creation.
Parameters:
Returns:
withCustomerManagedKeyStatus
public DatabaseAccountGetResultsInner withCustomerManagedKeyStatus(String customerManagedKeyStatus)
Set the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
Parameters:
Returns:
withDefaultIdentity
public DatabaseAccountGetResultsInner withDefaultIdentity(String defaultIdentity)
Set the defaultIdentity property: 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.
Parameters:
Returns:
withDisableKeyBasedMetadataWriteAccess
public DatabaseAccountGetResultsInner withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)
Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Parameters:
Returns:
withDisableLocalAuth
public DatabaseAccountGetResultsInner withDisableLocalAuth(Boolean disableLocalAuth)
Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
Parameters:
Returns:
withEnableAnalyticalStorage
public DatabaseAccountGetResultsInner withEnableAnalyticalStorage(Boolean enableAnalyticalStorage)
Set the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
Parameters:
Returns:
withEnableAutomaticFailover
public DatabaseAccountGetResultsInner withEnableAutomaticFailover(Boolean enableAutomaticFailover)
Set the enableAutomaticFailover property: 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.
Parameters:
Returns:
withEnableBurstCapacity
public DatabaseAccountGetResultsInner withEnableBurstCapacity(Boolean enableBurstCapacity)
Set the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
Parameters:
Returns:
withEnableCassandraConnector
public DatabaseAccountGetResultsInner withEnableCassandraConnector(Boolean enableCassandraConnector)
Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Parameters:
Returns:
withEnableFreeTier
public DatabaseAccountGetResultsInner withEnableFreeTier(Boolean enableFreeTier)
Set the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
Parameters:
Returns:
withEnableMultipleWriteLocations
public DatabaseAccountGetResultsInner withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
Parameters:
Returns:
withEnablePartitionMerge
public DatabaseAccountGetResultsInner withEnablePartitionMerge(Boolean enablePartitionMerge)
Set the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
Parameters:
Returns:
withEnablePerRegionPerPartitionAutoscale
public DatabaseAccountGetResultsInner withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale)
Set the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
Parameters:
Returns:
withIdentity
public DatabaseAccountGetResultsInner withIdentity(ManagedServiceIdentity identity)
Set the identity property: Identity for the resource.
Parameters:
Returns:
withIpRules
public DatabaseAccountGetResultsInner withIpRules(List
Set the ipRules property: List of IpRules.
Parameters:
Returns:
withIsVirtualNetworkFilterEnabled
public DatabaseAccountGetResultsInner withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
Parameters:
Returns:
withKeyVaultKeyUri
public DatabaseAccountGetResultsInner withKeyVaultKeyUri(String keyVaultKeyUri)
Set the keyVaultKeyUri property: The URI of the key vault.
Parameters:
Returns:
withKind
public DatabaseAccountGetResultsInner withKind(DatabaseAccountKind kind)
Set the kind property: Indicates the type of database account. This can only be set at database account creation.
Parameters:
Returns:
withLocation
public DatabaseAccountGetResultsInner withLocation(String location)
Overrides:
DatabaseAccountGetResultsInner.withLocation(String location)Parameters:
withMinimalTlsVersion
public DatabaseAccountGetResultsInner withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion)
Set the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
Parameters:
Returns:
withNetworkAclBypass
public DatabaseAccountGetResultsInner withNetworkAclBypass(NetworkAclBypass networkAclBypass)
Set the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
Parameters:
Returns:
withNetworkAclBypassResourceIds
public DatabaseAccountGetResultsInner withNetworkAclBypassResourceIds(List
Set the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
Parameters:
Returns:
withPublicNetworkAccess
public DatabaseAccountGetResultsInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
Parameters:
Returns:
withRestoreParameters
public DatabaseAccountGetResultsInner withRestoreParameters(RestoreParameters restoreParameters)
Set the restoreParameters property: Parameters to indicate the information about the restore.
Parameters:
Returns:
withTags
public DatabaseAccountGetResultsInner withTags(Map
Overrides:
DatabaseAccountGetResultsInner.withTags(Map<String,String> tags)Parameters:
withVirtualNetworkRules
public DatabaseAccountGetResultsInner withVirtualNetworkRules(List
Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
Parameters:
Returns:
writeLocations
public List
Get the writeLocations property: An array that contains the write location for the Cosmos DB account.
Returns:
Applies to
Azure SDK for Java