azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.s...

818 строки
72 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties"
name: "DatabaseProperties"
nameWithType: "DatabaseProperties"
summary: "The database's properties."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **DatabaseProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.DatabaseProperties()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.DatabaseProperties()"
name: "DatabaseProperties()"
nameWithType: "DatabaseProperties.DatabaseProperties()"
summary: "Creates an instance of Database<wbr>Properties class."
syntax: "public DatabaseProperties()"
desc: "Creates an instance of DatabaseProperties class."
methods:
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.autoPauseDelay()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.autoPauseDelay()"
name: "autoPauseDelay()"
nameWithType: "DatabaseProperties.autoPauseDelay()"
summary: "Get the auto<wbr>Pause<wbr>Delay property: Time in minutes after which database is automatically paused."
syntax: "public Integer autoPauseDelay()"
desc: "Get the autoPauseDelay property: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled."
returns:
description: "the autoPauseDelay value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.catalogCollation()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.catalogCollation()"
name: "catalogCollation()"
nameWithType: "DatabaseProperties.catalogCollation()"
summary: "Get the catalog<wbr>Collation property: Collation of the metadata catalog."
syntax: "public CatalogCollationType catalogCollation()"
desc: "Get the catalogCollation property: Collation of the metadata catalog."
returns:
description: "the catalogCollation value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.CatalogCollationType?alt=com.azure.resourcemanager.sql.models.CatalogCollationType&text=CatalogCollationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.collation()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.collation()"
name: "collation()"
nameWithType: "DatabaseProperties.collation()"
summary: "Get the collation property: The collation of the database."
syntax: "public String collation()"
desc: "Get the collation property: The collation of the database."
returns:
description: "the collation value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.createMode()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.createMode()"
name: "createMode()"
nameWithType: "DatabaseProperties.createMode()"
summary: "Get the create<wbr>Mode property: Specifies the mode of database creation."
syntax: "public CreateMode createMode()"
desc: "Get the createMode property: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition."
returns:
description: "the createMode value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.CreateMode?alt=com.azure.resourcemanager.sql.models.CreateMode&text=CreateMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.creationDate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.creationDate()"
name: "creationDate()"
nameWithType: "DatabaseProperties.creationDate()"
summary: "Get the creation<wbr>Date property: The creation date of the database (ISO8601 format)."
syntax: "public OffsetDateTime creationDate()"
desc: "Get the creationDate property: The creation date of the database (ISO8601 format)."
returns:
description: "the creationDate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentBackupStorageRedundancy()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentBackupStorageRedundancy()"
name: "currentBackupStorageRedundancy()"
nameWithType: "DatabaseProperties.currentBackupStorageRedundancy()"
summary: "Get the current<wbr>Backup<wbr>Storage<wbr>Redundancy property: The storage account type used to store backups for this database."
syntax: "public BackupStorageRedundancy currentBackupStorageRedundancy()"
desc: "Get the currentBackupStorageRedundancy property: The storage account type used to store backups for this database."
returns:
description: "the currentBackupStorageRedundancy value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.BackupStorageRedundancy?alt=com.azure.resourcemanager.sql.models.BackupStorageRedundancy&text=BackupStorageRedundancy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentServiceObjectiveName()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentServiceObjectiveName()"
name: "currentServiceObjectiveName()"
nameWithType: "DatabaseProperties.currentServiceObjectiveName()"
summary: "Get the current<wbr>Service<wbr>Objective<wbr>Name property: The current service level objective name of the database."
syntax: "public String currentServiceObjectiveName()"
desc: "Get the currentServiceObjectiveName property: The current service level objective name of the database."
returns:
description: "the currentServiceObjectiveName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentSku()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.currentSku()"
name: "currentSku()"
nameWithType: "DatabaseProperties.currentSku()"
summary: "Get the current<wbr>Sku property: The name and tier of the SKU."
syntax: "public Sku currentSku()"
desc: "Get the currentSku property: The name and tier of the SKU."
returns:
description: "the currentSku value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.Sku?alt=com.azure.resourcemanager.sql.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.databaseId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.databaseId()"
name: "databaseId()"
nameWithType: "DatabaseProperties.databaseId()"
summary: "Get the database<wbr>Id property: The ID of the database."
syntax: "public UUID databaseId()"
desc: "Get the databaseId property: The ID of the database."
returns:
description: "the databaseId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.defaultSecondaryLocation()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.defaultSecondaryLocation()"
name: "defaultSecondaryLocation()"
nameWithType: "DatabaseProperties.defaultSecondaryLocation()"
summary: "Get the default<wbr>Secondary<wbr>Location property: The default secondary region for this database."
syntax: "public String defaultSecondaryLocation()"
desc: "Get the defaultSecondaryLocation property: The default secondary region for this database."
returns:
description: "the defaultSecondaryLocation value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.earliestRestoreDate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.earliestRestoreDate()"
name: "earliestRestoreDate()"
nameWithType: "DatabaseProperties.earliestRestoreDate()"
summary: "Get the earliest<wbr>Restore<wbr>Date property: This records the earliest start date and time that restore is available for this database (ISO8601 format)."
syntax: "public OffsetDateTime earliestRestoreDate()"
desc: "Get the earliestRestoreDate property: This records the earliest start date and time that restore is available for this database (ISO8601 format)."
returns:
description: "the earliestRestoreDate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.elasticPoolId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.elasticPoolId()"
name: "elasticPoolId()"
nameWithType: "DatabaseProperties.elasticPoolId()"
summary: "Get the elastic<wbr>Pool<wbr>Id property: The resource identifier of the elastic pool containing this database."
syntax: "public String elasticPoolId()"
desc: "Get the elasticPoolId property: The resource identifier of the elastic pool containing this database."
returns:
description: "the elasticPoolId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.failoverGroupId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.failoverGroupId()"
name: "failoverGroupId()"
nameWithType: "DatabaseProperties.failoverGroupId()"
summary: "Get the failover<wbr>Group<wbr>Id property: Failover Group resource identifier that this database belongs to."
syntax: "public String failoverGroupId()"
desc: "Get the failoverGroupId property: Failover Group resource identifier that this database belongs to."
returns:
description: "the failoverGroupId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.federatedClientId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.federatedClientId()"
name: "federatedClientId()"
nameWithType: "DatabaseProperties.federatedClientId()"
summary: "Get the federated<wbr>Client<wbr>Id property: The Client id used for cross tenant per database CMK scenario."
syntax: "public UUID federatedClientId()"
desc: "Get the federatedClientId property: The Client id used for cross tenant per database CMK scenario."
returns:
description: "the federatedClientId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "DatabaseProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Database<wbr>Properties from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static DatabaseProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the DatabaseProperties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of DatabaseProperties from the JsonReader."
returns:
description: "An instance of DatabaseProperties if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.highAvailabilityReplicaCount()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.highAvailabilityReplicaCount()"
name: "highAvailabilityReplicaCount()"
nameWithType: "DatabaseProperties.highAvailabilityReplicaCount()"
summary: "Get the high<wbr>Availability<wbr>Replica<wbr>Count property: The number of secondary replicas associated with the database that are used to provide high availability."
syntax: "public Integer highAvailabilityReplicaCount()"
desc: "Get the highAvailabilityReplicaCount property: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool."
returns:
description: "the highAvailabilityReplicaCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.isInfraEncryptionEnabled()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.isInfraEncryptionEnabled()"
name: "isInfraEncryptionEnabled()"
nameWithType: "DatabaseProperties.isInfraEncryptionEnabled()"
summary: "Get the is<wbr>Infra<wbr>Encryption<wbr>Enabled property: Infra encryption is enabled for this database."
syntax: "public Boolean isInfraEncryptionEnabled()"
desc: "Get the isInfraEncryptionEnabled property: Infra encryption is enabled for this database."
returns:
description: "the isInfraEncryptionEnabled value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.isLedgerOn()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.isLedgerOn()"
name: "isLedgerOn()"
nameWithType: "DatabaseProperties.isLedgerOn()"
summary: "Get the is<wbr>Ledger<wbr>On property: Whether or not this database is a ledger database, which means all tables in the database are ledger tables."
syntax: "public Boolean isLedgerOn()"
desc: "Get the isLedgerOn property: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created."
returns:
description: "the isLedgerOn value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.licenseType()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.licenseType()"
name: "licenseType()"
nameWithType: "DatabaseProperties.licenseType()"
summary: "Get the license<wbr>Type property: The license type to apply for this database."
syntax: "public DatabaseLicenseType licenseType()"
desc: "Get the licenseType property: The license type to apply for this database. \\`LicenseIncluded\\` if you need a license, or \\`BasePrice\\` if you have a license and are eligible for the Azure Hybrid Benefit."
returns:
description: "the licenseType value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.DatabaseLicenseType?alt=com.azure.resourcemanager.sql.models.DatabaseLicenseType&text=DatabaseLicenseType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.longTermRetentionBackupResourceId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.longTermRetentionBackupResourceId()"
name: "longTermRetentionBackupResourceId()"
nameWithType: "DatabaseProperties.longTermRetentionBackupResourceId()"
summary: "Get the long<wbr>Term<wbr>Retention<wbr>Backup<wbr>Resource<wbr>Id property: The resource identifier of the long term retention backup associated with create operation of this database."
syntax: "public String longTermRetentionBackupResourceId()"
desc: "Get the longTermRetentionBackupResourceId property: The resource identifier of the long term retention backup associated with create operation of this database."
returns:
description: "the longTermRetentionBackupResourceId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maintenanceConfigurationId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maintenanceConfigurationId()"
name: "maintenanceConfigurationId()"
nameWithType: "DatabaseProperties.maintenanceConfigurationId()"
summary: "Get the maintenance<wbr>Configuration<wbr>Id property: Maintenance configuration id assigned to the database."
syntax: "public String maintenanceConfigurationId()"
desc: "Get the maintenanceConfigurationId property: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur."
returns:
description: "the maintenanceConfigurationId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maxLogSizeBytes()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maxLogSizeBytes()"
name: "maxLogSizeBytes()"
nameWithType: "DatabaseProperties.maxLogSizeBytes()"
summary: "Get the max<wbr>Log<wbr>Size<wbr>Bytes property: The max log size for this database."
syntax: "public Long maxLogSizeBytes()"
desc: "Get the maxLogSizeBytes property: The max log size for this database."
returns:
description: "the maxLogSizeBytes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maxSizeBytes()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.maxSizeBytes()"
name: "maxSizeBytes()"
nameWithType: "DatabaseProperties.maxSizeBytes()"
summary: "Get the max<wbr>Size<wbr>Bytes property: The max size of the database expressed in bytes."
syntax: "public Long maxSizeBytes()"
desc: "Get the maxSizeBytes property: The max size of the database expressed in bytes."
returns:
description: "the maxSizeBytes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.minCapacity()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.minCapacity()"
name: "minCapacity()"
nameWithType: "DatabaseProperties.minCapacity()"
summary: "Get the min<wbr>Capacity property: Minimal capacity that database will always have allocated, if not paused."
syntax: "public Double minCapacity()"
desc: "Get the minCapacity property: Minimal capacity that database will always have allocated, if not paused."
returns:
description: "the minCapacity value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.pausedDate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.pausedDate()"
name: "pausedDate()"
nameWithType: "DatabaseProperties.pausedDate()"
summary: "Get the paused<wbr>Date property: The date when database was paused by user configuration or action(ISO8601 format)."
syntax: "public OffsetDateTime pausedDate()"
desc: "Get the pausedDate property: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready."
returns:
description: "the pausedDate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.readScale()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.readScale()"
name: "readScale()"
nameWithType: "DatabaseProperties.readScale()"
summary: "Get the read<wbr>Scale property: The state of read-only routing."
syntax: "public DatabaseReadScale readScale()"
desc: "Get the readScale property: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool."
returns:
description: "the readScale value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.DatabaseReadScale?alt=com.azure.resourcemanager.sql.models.DatabaseReadScale&text=DatabaseReadScale\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.recoverableDatabaseId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.recoverableDatabaseId()"
name: "recoverableDatabaseId()"
nameWithType: "DatabaseProperties.recoverableDatabaseId()"
summary: "Get the recoverable<wbr>Database<wbr>Id property: The resource identifier of the recoverable database associated with create operation of this database."
syntax: "public String recoverableDatabaseId()"
desc: "Get the recoverableDatabaseId property: The resource identifier of the recoverable database associated with create operation of this database."
returns:
description: "the recoverableDatabaseId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.recoveryServicesRecoveryPointId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.recoveryServicesRecoveryPointId()"
name: "recoveryServicesRecoveryPointId()"
nameWithType: "DatabaseProperties.recoveryServicesRecoveryPointId()"
summary: "Get the recovery<wbr>Services<wbr>Recovery<wbr>Point<wbr>Id property: The resource identifier of the recovery point associated with create operation of this database."
syntax: "public String recoveryServicesRecoveryPointId()"
desc: "Get the recoveryServicesRecoveryPointId property: The resource identifier of the recovery point associated with create operation of this database."
returns:
description: "the recoveryServicesRecoveryPointId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.requestedBackupStorageRedundancy()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.requestedBackupStorageRedundancy()"
name: "requestedBackupStorageRedundancy()"
nameWithType: "DatabaseProperties.requestedBackupStorageRedundancy()"
summary: "Get the requested<wbr>Backup<wbr>Storage<wbr>Redundancy property: The storage account type to be used to store backups for this database."
syntax: "public BackupStorageRedundancy requestedBackupStorageRedundancy()"
desc: "Get the requestedBackupStorageRedundancy property: The storage account type to be used to store backups for this database."
returns:
description: "the requestedBackupStorageRedundancy value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.BackupStorageRedundancy?alt=com.azure.resourcemanager.sql.models.BackupStorageRedundancy&text=BackupStorageRedundancy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.requestedServiceObjectiveName()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.requestedServiceObjectiveName()"
name: "requestedServiceObjectiveName()"
nameWithType: "DatabaseProperties.requestedServiceObjectiveName()"
summary: "Get the requested<wbr>Service<wbr>Objective<wbr>Name property: The requested service level objective name of the database."
syntax: "public String requestedServiceObjectiveName()"
desc: "Get the requestedServiceObjectiveName property: The requested service level objective name of the database."
returns:
description: "the requestedServiceObjectiveName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.restorableDroppedDatabaseId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.restorableDroppedDatabaseId()"
name: "restorableDroppedDatabaseId()"
nameWithType: "DatabaseProperties.restorableDroppedDatabaseId()"
summary: "Get the restorable<wbr>Dropped<wbr>Database<wbr>Id property: The resource identifier of the restorable dropped database associated with create operation of this database."
syntax: "public String restorableDroppedDatabaseId()"
desc: "Get the restorableDroppedDatabaseId property: The resource identifier of the restorable dropped database associated with create operation of this database."
returns:
description: "the restorableDroppedDatabaseId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.restorePointInTime()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.restorePointInTime()"
name: "restorePointInTime()"
nameWithType: "DatabaseProperties.restorePointInTime()"
summary: "Get the restore<wbr>Point<wbr>InTime property: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database."
syntax: "public OffsetDateTime restorePointInTime()"
desc: "Get the restorePointInTime property: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database."
returns:
description: "the restorePointInTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.resumedDate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.resumedDate()"
name: "resumedDate()"
nameWithType: "DatabaseProperties.resumedDate()"
summary: "Get the resumed<wbr>Date property: The date when database was resumed by user action or database login (ISO8601 format)."
syntax: "public OffsetDateTime resumedDate()"
desc: "Get the resumedDate property: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused."
returns:
description: "the resumedDate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sampleName()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sampleName()"
name: "sampleName()"
nameWithType: "DatabaseProperties.sampleName()"
summary: "Get the sample<wbr>Name property: The name of the sample schema to apply when creating this database."
syntax: "public SampleName sampleName()"
desc: "Get the sampleName property: The name of the sample schema to apply when creating this database."
returns:
description: "the sampleName value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.SampleName?alt=com.azure.resourcemanager.sql.models.SampleName&text=SampleName\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.secondaryType()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.secondaryType()"
name: "secondaryType()"
nameWithType: "DatabaseProperties.secondaryType()"
summary: "Get the secondary<wbr>Type property: The secondary type of the database if it is a secondary."
syntax: "public SecondaryType secondaryType()"
desc: "Get the secondaryType property: The secondary type of the database if it is a secondary. Valid values are Geo and Named."
returns:
description: "the secondaryType value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.SecondaryType?alt=com.azure.resourcemanager.sql.models.SecondaryType&text=SecondaryType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceDatabaseDeletionDate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceDatabaseDeletionDate()"
name: "sourceDatabaseDeletionDate()"
nameWithType: "DatabaseProperties.sourceDatabaseDeletionDate()"
summary: "Get the source<wbr>Database<wbr>Deletion<wbr>Date property: Specifies the time that the database was deleted."
syntax: "public OffsetDateTime sourceDatabaseDeletionDate()"
desc: "Get the sourceDatabaseDeletionDate property: Specifies the time that the database was deleted."
returns:
description: "the sourceDatabaseDeletionDate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceDatabaseId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceDatabaseId()"
name: "sourceDatabaseId()"
nameWithType: "DatabaseProperties.sourceDatabaseId()"
summary: "Get the source<wbr>Database<wbr>Id property: The resource identifier of the source database associated with create operation of this database."
syntax: "public String sourceDatabaseId()"
desc: "Get the sourceDatabaseId property: The resource identifier of the source database associated with create operation of this database."
returns:
description: "the sourceDatabaseId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceResourceId()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.sourceResourceId()"
name: "sourceResourceId()"
nameWithType: "DatabaseProperties.sourceResourceId()"
summary: "Get the source<wbr>Resource<wbr>Id property: The resource identifier of the source associated with the create operation of this database."
syntax: "public String sourceResourceId()"
desc: "Get the sourceResourceId property: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, \\\\u201cx-ms-authorization-auxiliary\\\\u201d header must contain authentication token for the source tenant. For more details about \\\\u201cx-ms-authorization-auxiliary\\\\u201d header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant."
returns:
description: "the sourceResourceId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.status()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.status()"
name: "status()"
nameWithType: "DatabaseProperties.status()"
summary: "Get the status property: The status of the database."
syntax: "public DatabaseStatus status()"
desc: "Get the status property: The status of the database."
returns:
description: "the status value."
type: "<xref href=\"com.azure.resourcemanager.sql.models.DatabaseStatus?alt=com.azure.resourcemanager.sql.models.DatabaseStatus&text=DatabaseStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "DatabaseProperties.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.validate()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.validate()"
name: "validate()"
nameWithType: "DatabaseProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withAutoPauseDelay(java.lang.Integer)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withAutoPauseDelay(Integer autoPauseDelay)"
name: "withAutoPauseDelay(Integer autoPauseDelay)"
nameWithType: "DatabaseProperties.withAutoPauseDelay(Integer autoPauseDelay)"
summary: "Set the auto<wbr>Pause<wbr>Delay property: Time in minutes after which database is automatically paused."
parameters:
- description: "the autoPauseDelay value to set."
name: "autoPauseDelay"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DatabaseProperties withAutoPauseDelay(Integer autoPauseDelay)"
desc: "Set the autoPauseDelay property: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCatalogCollation(com.azure.resourcemanager.sql.models.CatalogCollationType)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCatalogCollation(CatalogCollationType catalogCollation)"
name: "withCatalogCollation(CatalogCollationType catalogCollation)"
nameWithType: "DatabaseProperties.withCatalogCollation(CatalogCollationType catalogCollation)"
summary: "Set the catalog<wbr>Collation property: Collation of the metadata catalog."
parameters:
- description: "the catalogCollation value to set."
name: "catalogCollation"
type: "<xref href=\"com.azure.resourcemanager.sql.models.CatalogCollationType?alt=com.azure.resourcemanager.sql.models.CatalogCollationType&text=CatalogCollationType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withCatalogCollation(CatalogCollationType catalogCollation)"
desc: "Set the catalogCollation property: Collation of the metadata catalog."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCollation(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCollation(String collation)"
name: "withCollation(String collation)"
nameWithType: "DatabaseProperties.withCollation(String collation)"
summary: "Set the collation property: The collation of the database."
parameters:
- description: "the collation value to set."
name: "collation"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withCollation(String collation)"
desc: "Set the collation property: The collation of the database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCreateMode(com.azure.resourcemanager.sql.models.CreateMode)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withCreateMode(CreateMode createMode)"
name: "withCreateMode(CreateMode createMode)"
nameWithType: "DatabaseProperties.withCreateMode(CreateMode createMode)"
summary: "Set the create<wbr>Mode property: Specifies the mode of database creation."
parameters:
- description: "the createMode value to set."
name: "createMode"
type: "<xref href=\"com.azure.resourcemanager.sql.models.CreateMode?alt=com.azure.resourcemanager.sql.models.CreateMode&text=CreateMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withCreateMode(CreateMode createMode)"
desc: "Set the createMode property: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withElasticPoolId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withElasticPoolId(String elasticPoolId)"
name: "withElasticPoolId(String elasticPoolId)"
nameWithType: "DatabaseProperties.withElasticPoolId(String elasticPoolId)"
summary: "Set the elastic<wbr>Pool<wbr>Id property: The resource identifier of the elastic pool containing this database."
parameters:
- description: "the elasticPoolId value to set."
name: "elasticPoolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withElasticPoolId(String elasticPoolId)"
desc: "Set the elasticPoolId property: The resource identifier of the elastic pool containing this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withFederatedClientId(java.util.UUID)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withFederatedClientId(UUID federatedClientId)"
name: "withFederatedClientId(UUID federatedClientId)"
nameWithType: "DatabaseProperties.withFederatedClientId(UUID federatedClientId)"
summary: "Set the federated<wbr>Client<wbr>Id property: The Client id used for cross tenant per database CMK scenario."
parameters:
- description: "the federatedClientId value to set."
name: "federatedClientId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
syntax: "public DatabaseProperties withFederatedClientId(UUID federatedClientId)"
desc: "Set the federatedClientId property: The Client id used for cross tenant per database CMK scenario."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withHighAvailabilityReplicaCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)"
name: "withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)"
nameWithType: "DatabaseProperties.withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)"
summary: "Set the high<wbr>Availability<wbr>Replica<wbr>Count property: The number of secondary replicas associated with the database that are used to provide high availability."
parameters:
- description: "the highAvailabilityReplicaCount value to set."
name: "highAvailabilityReplicaCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DatabaseProperties withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)"
desc: "Set the highAvailabilityReplicaCount property: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withIsLedgerOn(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withIsLedgerOn(Boolean isLedgerOn)"
name: "withIsLedgerOn(Boolean isLedgerOn)"
nameWithType: "DatabaseProperties.withIsLedgerOn(Boolean isLedgerOn)"
summary: "Set the is<wbr>Ledger<wbr>On property: Whether or not this database is a ledger database, which means all tables in the database are ledger tables."
parameters:
- description: "the isLedgerOn value to set."
name: "isLedgerOn"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DatabaseProperties withIsLedgerOn(Boolean isLedgerOn)"
desc: "Set the isLedgerOn property: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withLicenseType(com.azure.resourcemanager.sql.models.DatabaseLicenseType)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withLicenseType(DatabaseLicenseType licenseType)"
name: "withLicenseType(DatabaseLicenseType licenseType)"
nameWithType: "DatabaseProperties.withLicenseType(DatabaseLicenseType licenseType)"
summary: "Set the license<wbr>Type property: The license type to apply for this database."
parameters:
- description: "the licenseType value to set."
name: "licenseType"
type: "<xref href=\"com.azure.resourcemanager.sql.models.DatabaseLicenseType?alt=com.azure.resourcemanager.sql.models.DatabaseLicenseType&text=DatabaseLicenseType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withLicenseType(DatabaseLicenseType licenseType)"
desc: "Set the licenseType property: The license type to apply for this database. \\`LicenseIncluded\\` if you need a license, or \\`BasePrice\\` if you have a license and are eligible for the Azure Hybrid Benefit."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withLongTermRetentionBackupResourceId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)"
name: "withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)"
nameWithType: "DatabaseProperties.withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)"
summary: "Set the long<wbr>Term<wbr>Retention<wbr>Backup<wbr>Resource<wbr>Id property: The resource identifier of the long term retention backup associated with create operation of this database."
parameters:
- description: "the longTermRetentionBackupResourceId value to set."
name: "longTermRetentionBackupResourceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)"
desc: "Set the longTermRetentionBackupResourceId property: The resource identifier of the long term retention backup associated with create operation of this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMaintenanceConfigurationId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMaintenanceConfigurationId(String maintenanceConfigurationId)"
name: "withMaintenanceConfigurationId(String maintenanceConfigurationId)"
nameWithType: "DatabaseProperties.withMaintenanceConfigurationId(String maintenanceConfigurationId)"
summary: "Set the maintenance<wbr>Configuration<wbr>Id property: Maintenance configuration id assigned to the database."
parameters:
- description: "the maintenanceConfigurationId value to set."
name: "maintenanceConfigurationId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withMaintenanceConfigurationId(String maintenanceConfigurationId)"
desc: "Set the maintenanceConfigurationId property: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMaxSizeBytes(java.lang.Long)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMaxSizeBytes(Long maxSizeBytes)"
name: "withMaxSizeBytes(Long maxSizeBytes)"
nameWithType: "DatabaseProperties.withMaxSizeBytes(Long maxSizeBytes)"
summary: "Set the max<wbr>Size<wbr>Bytes property: The max size of the database expressed in bytes."
parameters:
- description: "the maxSizeBytes value to set."
name: "maxSizeBytes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public DatabaseProperties withMaxSizeBytes(Long maxSizeBytes)"
desc: "Set the maxSizeBytes property: The max size of the database expressed in bytes."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMinCapacity(java.lang.Double)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withMinCapacity(Double minCapacity)"
name: "withMinCapacity(Double minCapacity)"
nameWithType: "DatabaseProperties.withMinCapacity(Double minCapacity)"
summary: "Set the min<wbr>Capacity property: Minimal capacity that database will always have allocated, if not paused."
parameters:
- description: "the minCapacity value to set."
name: "minCapacity"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
syntax: "public DatabaseProperties withMinCapacity(Double minCapacity)"
desc: "Set the minCapacity property: Minimal capacity that database will always have allocated, if not paused."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withReadScale(com.azure.resourcemanager.sql.models.DatabaseReadScale)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withReadScale(DatabaseReadScale readScale)"
name: "withReadScale(DatabaseReadScale readScale)"
nameWithType: "DatabaseProperties.withReadScale(DatabaseReadScale readScale)"
summary: "Set the read<wbr>Scale property: The state of read-only routing."
parameters:
- description: "the readScale value to set."
name: "readScale"
type: "<xref href=\"com.azure.resourcemanager.sql.models.DatabaseReadScale?alt=com.azure.resourcemanager.sql.models.DatabaseReadScale&text=DatabaseReadScale\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withReadScale(DatabaseReadScale readScale)"
desc: "Set the readScale property: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRecoverableDatabaseId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRecoverableDatabaseId(String recoverableDatabaseId)"
name: "withRecoverableDatabaseId(String recoverableDatabaseId)"
nameWithType: "DatabaseProperties.withRecoverableDatabaseId(String recoverableDatabaseId)"
summary: "Set the recoverable<wbr>Database<wbr>Id property: The resource identifier of the recoverable database associated with create operation of this database."
parameters:
- description: "the recoverableDatabaseId value to set."
name: "recoverableDatabaseId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withRecoverableDatabaseId(String recoverableDatabaseId)"
desc: "Set the recoverableDatabaseId property: The resource identifier of the recoverable database associated with create operation of this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRecoveryServicesRecoveryPointId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)"
name: "withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)"
nameWithType: "DatabaseProperties.withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)"
summary: "Set the recovery<wbr>Services<wbr>Recovery<wbr>Point<wbr>Id property: The resource identifier of the recovery point associated with create operation of this database."
parameters:
- description: "the recoveryServicesRecoveryPointId value to set."
name: "recoveryServicesRecoveryPointId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)"
desc: "Set the recoveryServicesRecoveryPointId property: The resource identifier of the recovery point associated with create operation of this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRequestedBackupStorageRedundancy(com.azure.resourcemanager.sql.models.BackupStorageRedundancy)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)"
name: "withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)"
nameWithType: "DatabaseProperties.withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)"
summary: "Set the requested<wbr>Backup<wbr>Storage<wbr>Redundancy property: The storage account type to be used to store backups for this database."
parameters:
- description: "the requestedBackupStorageRedundancy value to set."
name: "requestedBackupStorageRedundancy"
type: "<xref href=\"com.azure.resourcemanager.sql.models.BackupStorageRedundancy?alt=com.azure.resourcemanager.sql.models.BackupStorageRedundancy&text=BackupStorageRedundancy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)"
desc: "Set the requestedBackupStorageRedundancy property: The storage account type to be used to store backups for this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRestorableDroppedDatabaseId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)"
name: "withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)"
nameWithType: "DatabaseProperties.withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)"
summary: "Set the restorable<wbr>Dropped<wbr>Database<wbr>Id property: The resource identifier of the restorable dropped database associated with create operation of this database."
parameters:
- description: "the restorableDroppedDatabaseId value to set."
name: "restorableDroppedDatabaseId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)"
desc: "Set the restorableDroppedDatabaseId property: The resource identifier of the restorable dropped database associated with create operation of this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRestorePointInTime(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withRestorePointInTime(OffsetDateTime restorePointInTime)"
name: "withRestorePointInTime(OffsetDateTime restorePointInTime)"
nameWithType: "DatabaseProperties.withRestorePointInTime(OffsetDateTime restorePointInTime)"
summary: "Set the restore<wbr>Point<wbr>InTime property: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database."
parameters:
- description: "the restorePointInTime value to set."
name: "restorePointInTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public DatabaseProperties withRestorePointInTime(OffsetDateTime restorePointInTime)"
desc: "Set the restorePointInTime property: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSampleName(com.azure.resourcemanager.sql.models.SampleName)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSampleName(SampleName sampleName)"
name: "withSampleName(SampleName sampleName)"
nameWithType: "DatabaseProperties.withSampleName(SampleName sampleName)"
summary: "Set the sample<wbr>Name property: The name of the sample schema to apply when creating this database."
parameters:
- description: "the sampleName value to set."
name: "sampleName"
type: "<xref href=\"com.azure.resourcemanager.sql.models.SampleName?alt=com.azure.resourcemanager.sql.models.SampleName&text=SampleName\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withSampleName(SampleName sampleName)"
desc: "Set the sampleName property: The name of the sample schema to apply when creating this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSecondaryType(com.azure.resourcemanager.sql.models.SecondaryType)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSecondaryType(SecondaryType secondaryType)"
name: "withSecondaryType(SecondaryType secondaryType)"
nameWithType: "DatabaseProperties.withSecondaryType(SecondaryType secondaryType)"
summary: "Set the secondary<wbr>Type property: The secondary type of the database if it is a secondary."
parameters:
- description: "the secondaryType value to set."
name: "secondaryType"
type: "<xref href=\"com.azure.resourcemanager.sql.models.SecondaryType?alt=com.azure.resourcemanager.sql.models.SecondaryType&text=SecondaryType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseProperties withSecondaryType(SecondaryType secondaryType)"
desc: "Set the secondaryType property: The secondary type of the database if it is a secondary. Valid values are Geo and Named."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceDatabaseDeletionDate(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)"
name: "withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)"
nameWithType: "DatabaseProperties.withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)"
summary: "Set the source<wbr>Database<wbr>Deletion<wbr>Date property: Specifies the time that the database was deleted."
parameters:
- description: "the sourceDatabaseDeletionDate value to set."
name: "sourceDatabaseDeletionDate"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public DatabaseProperties withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)"
desc: "Set the sourceDatabaseDeletionDate property: Specifies the time that the database was deleted."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceDatabaseId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceDatabaseId(String sourceDatabaseId)"
name: "withSourceDatabaseId(String sourceDatabaseId)"
nameWithType: "DatabaseProperties.withSourceDatabaseId(String sourceDatabaseId)"
summary: "Set the source<wbr>Database<wbr>Id property: The resource identifier of the source database associated with create operation of this database."
parameters:
- description: "the sourceDatabaseId value to set."
name: "sourceDatabaseId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withSourceDatabaseId(String sourceDatabaseId)"
desc: "Set the sourceDatabaseId property: The resource identifier of the source database associated with create operation of this database."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceResourceId(java.lang.String)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withSourceResourceId(String sourceResourceId)"
name: "withSourceResourceId(String sourceResourceId)"
nameWithType: "DatabaseProperties.withSourceResourceId(String sourceResourceId)"
summary: "Set the source<wbr>Resource<wbr>Id property: The resource identifier of the source associated with the create operation of this database."
parameters:
- description: "the sourceResourceId value to set."
name: "sourceResourceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DatabaseProperties withSourceResourceId(String sourceResourceId)"
desc: "Set the sourceResourceId property: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, \\\\u201cx-ms-authorization-auxiliary\\\\u201d header must contain authentication token for the source tenant. For more details about \\\\u201cx-ms-authorization-auxiliary\\\\u201d header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withZoneRedundant(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.withZoneRedundant(Boolean zoneRedundant)"
name: "withZoneRedundant(Boolean zoneRedundant)"
nameWithType: "DatabaseProperties.withZoneRedundant(Boolean zoneRedundant)"
summary: "Set the zone<wbr>Redundant property: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones."
parameters:
- description: "the zoneRedundant value to set."
name: "zoneRedundant"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DatabaseProperties withZoneRedundant(Boolean zoneRedundant)"
desc: "Set the zoneRedundant property: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones."
returns:
description: "the DatabaseProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.zoneRedundant()"
fullName: "com.azure.resourcemanager.sql.fluent.models.DatabaseProperties.zoneRedundant()"
name: "zoneRedundant()"
nameWithType: "DatabaseProperties.zoneRedundant()"
summary: "Get the zone<wbr>Redundant property: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones."
syntax: "public Boolean zoneRedundant()"
desc: "Get the zoneRedundant property: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones."
returns:
description: "the zoneRedundant value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
type: "class"
desc: "The database's properties."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.sql.fluent.models.DatabaseProperties?alt=com.azure.resourcemanager.sql.fluent.models.DatabaseProperties&text=DatabaseProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.sql.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-sql:2.44.0