Watch Aspire live streamsDocsTry Aspire

SqlDatabaseProxy

Handle
📦 Aspire.Hosting.Azure.Provisioning.Sql v13.6.0-preview.1.26478.8
interface SqlDatabaseProxy {
autoPauseDelay: BicepValueProxy | number;
availabilityZone: BicepValueProxy | SqlAvailabilityZoneType;
catalogCollation: BicepValueProxy | CatalogCollationType;
collation: BicepValueProxy | string;
readonly createdOn: BicepValueProxy | datetimeoffset;
createMode: BicepValueProxy | SqlDatabaseCreateMode;
readonly currentBackupStorageRedundancy: BicepValueProxy | SqlBackupStorageRedundancy;
readonly currentServiceObjectiveName: BicepValueProxy | string;
readonly currentSku: SqlSkuProxy;
readonly databaseId: BicepValueProxy | guid;
readonly defaultSecondaryLocation: BicepValueProxy;
readonly earliestRestoreOn: BicepValueProxy | datetimeoffset;
elasticPoolId: BicepValueProxy;
encryptionProtector: BicepValueProxy | string;
encryptionProtectorAutoRotation: BicepValueProxy | boolean;
readonly failoverGroupId: BicepValueProxy;
federatedClientId: BicepValueProxy | guid;
freeLimitExhaustionBehavior: BicepValueProxy | FreeLimitExhaustionBehavior;
highAvailabilityReplicaCount: BicepValueProxy | number;
readonly id: BicepValueProxy;
identity: DatabaseIdentityProxy;
readonly isInfraEncryptionEnabled: BicepValueProxy | boolean;
isLedgerOn: BicepValueProxy | boolean;
isZoneRedundant: BicepValueProxy | boolean;
keys: Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfSqlDatabaseKeyProxy;
readonly kind: BicepValueProxy | string;
licenseType: BicepValueProxy | DatabaseLicenseType;
location: BicepValueProxy;
longTermRetentionBackupResourceId: BicepValueProxy;
maintenanceConfigurationId: BicepValueProxy;
readonly managedBy: BicepValueProxy | string;
manualCutover: BicepValueProxy | boolean;
readonly maxLogSizeBytes: BicepValueProxy | number;
maxSizeBytes: BicepValueProxy | number;
minCapacity: BicepValueProxy | number;
name: BicepValueProxy | string;
parent: SqlServerProxy;
readonly pausedOn: BicepValueProxy | datetimeoffset;
performCutover: BicepValueProxy | boolean;
preferredEnclaveType: BicepValueProxy | SqlAlwaysEncryptedEnclaveType;
readScale: BicepValueProxy | DatabaseReadScale;
recoverableDatabaseId: BicepValueProxy;
recoveryServicesRecoveryPointId: BicepValueProxy;
requestedBackupStorageRedundancy: BicepValueProxy | SqlBackupStorageRedundancy;
readonly requestedServiceObjectiveName: BicepValueProxy | string;
restorableDroppedDatabaseId: BicepValueProxy;
restorePointInTime: BicepValueProxy | datetimeoffset;
readonly resumedOn: BicepValueProxy | datetimeoffset;
sampleName: BicepValueProxy | SampleSchemaName;
secondaryType: BicepValueProxy | SecondaryType;
sku: SqlSkuProxy;
sourceDatabaseDeletedOn: BicepValueProxy | datetimeoffset;
sourceDatabaseId: BicepValueProxy;
sourceResourceId: BicepValueProxy;
readonly status: BicepValueProxy | SqlDatabaseStatus;
readonly systemData: SqlSystemDataProxy;
tags: Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxy;
useFreeLimit: BicepValueProxy | boolean;
addTo(infrastructure: AzureResourceInfrastructure): void;
clearAutoPauseDelay(): void;
clearAvailabilityZone(): void;
clearCatalogCollation(): void;
clearCollation(): void;
clearCreateMode(): void;
clearElasticPoolId(): void;
clearEncryptionProtector(): void;
clearEncryptionProtectorAutoRotation(): void;
clearFederatedClientId(): void;
clearFreeLimitExhaustionBehavior(): void;
clearHighAvailabilityReplicaCount(): void;
clearIsLedgerOn(): void;
clearIsZoneRedundant(): void;
clearLicenseType(): void;
clearLocation(): void;
clearLongTermRetentionBackupResourceId(): void;
clearMaintenanceConfigurationId(): void;
clearManualCutover(): void;
clearMaxSizeBytes(): void;
clearMinCapacity(): void;
clearName(): void;
clearPerformCutover(): void;
clearPreferredEnclaveType(): void;
clearReadScale(): void;
clearRecoverableDatabaseId(): void;
clearRecoveryServicesRecoveryPointId(): void;
clearRequestedBackupStorageRedundancy(): void;
clearRestorableDroppedDatabaseId(): void;
clearRestorePointInTime(): void;
clearSampleName(): void;
clearSecondaryType(): void;
clearSourceDatabaseDeletedOn(): void;
clearSourceDatabaseId(): void;
clearSourceResourceId(): void;
clearUseFreeLimit(): void;
}

Properties

propertyautoPauseDelayBicepValueProxy | numberget · set
Gets or sets the AutoPauseDelay provisioning property.
propertyavailabilityZoneBicepValueProxy | SqlAvailabilityZoneTypeget · set
Gets or sets the AvailabilityZone provisioning property.
propertycatalogCollationBicepValueProxy | CatalogCollationTypeget · set
Gets or sets the CatalogCollation provisioning property.
propertycollationBicepValueProxy | stringget · set
Gets or sets the Collation provisioning property.
propertycreatedOnBicepValueProxy | datetimeoffsetget
Gets the CreatedOn provisioning property.
propertycreateModeBicepValueProxy | SqlDatabaseCreateModeget · set
Gets or sets the CreateMode provisioning property.
propertycurrentBackupStorageRedundancyBicepValueProxy | SqlBackupStorageRedundancyget
Gets the CurrentBackupStorageRedundancy provisioning property.
propertycurrentServiceObjectiveNameBicepValueProxy | stringget
Gets the CurrentServiceObjectiveName provisioning property.
propertycurrentSkuSqlSkuProxyget
Gets the CurrentSku provisioning property.
propertydatabaseIdBicepValueProxy | guidget
Gets the DatabaseId provisioning property.
propertydefaultSecondaryLocationBicepValueProxyget
Gets the DefaultSecondaryLocation provisioning property.
propertyearliestRestoreOnBicepValueProxy | datetimeoffsetget
Gets the EarliestRestoreOn provisioning property.
propertyelasticPoolIdBicepValueProxyget · set
Gets or sets the ElasticPoolId provisioning property.
propertyencryptionProtectorBicepValueProxy | stringget · set
Gets or sets the EncryptionProtector provisioning property.
propertyencryptionProtectorAutoRotationBicepValueProxy | booleanget · set
Gets or sets the EncryptionProtectorAutoRotation provisioning property.
propertyfailoverGroupIdBicepValueProxyget
Gets the FailoverGroupId provisioning property.
propertyfederatedClientIdBicepValueProxy | guidget · set
Gets or sets the FederatedClientId provisioning property.
propertyfreeLimitExhaustionBehaviorBicepValueProxy | FreeLimitExhaustionBehaviorget · set
Gets or sets the FreeLimitExhaustionBehavior provisioning property.
propertyhighAvailabilityReplicaCountBicepValueProxy | numberget · set
Gets or sets the HighAvailabilityReplicaCount provisioning property.
propertyidBicepValueProxyget
Gets the Id provisioning property.
propertyidentityDatabaseIdentityProxyget · set
Gets or sets the Identity provisioning property.
propertyisInfraEncryptionEnabledBicepValueProxy | booleanget
Gets the IsInfraEncryptionEnabled provisioning property.
propertyisLedgerOnBicepValueProxy | booleanget · set
Gets or sets the IsLedgerOn provisioning property.
propertyisZoneRedundantBicepValueProxy | booleanget · set
Gets or sets the IsZoneRedundant provisioning property.
propertykeysAspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfSqlDatabaseKeyProxyget · set
Gets or sets the Keys provisioning property.
propertykindBicepValueProxy | stringget
Gets the Kind provisioning property.
propertylicenseTypeBicepValueProxy | DatabaseLicenseTypeget · set
Gets or sets the LicenseType provisioning property.
propertylocationBicepValueProxyget · set
Gets or sets the Location provisioning property.
propertylongTermRetentionBackupResourceIdBicepValueProxyget · set
Gets or sets the LongTermRetentionBackupResourceId provisioning property.
propertymaintenanceConfigurationIdBicepValueProxyget · set
Gets or sets the MaintenanceConfigurationId provisioning property.
propertymanagedByBicepValueProxy | stringget
Gets the ManagedBy provisioning property.
propertymanualCutoverBicepValueProxy | booleanget · set
Gets or sets the ManualCutover provisioning property.
propertymaxLogSizeBytesBicepValueProxy | numberget
Gets the MaxLogSizeBytes provisioning property.
propertymaxSizeBytesBicepValueProxy | numberget · set
Gets or sets the MaxSizeBytes provisioning property.
propertyminCapacityBicepValueProxy | numberget · set
Gets or sets the MinCapacity provisioning property.
propertynameBicepValueProxy | stringget · set
Gets or sets the Name provisioning property.
propertyparentSqlServerProxyget · set
Gets or sets the Parent provisioning property.
propertypausedOnBicepValueProxy | datetimeoffsetget
Gets the PausedOn provisioning property.
propertyperformCutoverBicepValueProxy | booleanget · set
Gets or sets the PerformCutover provisioning property.
propertypreferredEnclaveTypeBicepValueProxy | SqlAlwaysEncryptedEnclaveTypeget · set
Gets or sets the PreferredEnclaveType provisioning property.
propertyreadScaleBicepValueProxy | DatabaseReadScaleget · set
Gets or sets the ReadScale provisioning property.
propertyrecoverableDatabaseIdBicepValueProxyget · set
Gets or sets the RecoverableDatabaseId provisioning property.
propertyrecoveryServicesRecoveryPointIdBicepValueProxyget · set
Gets or sets the RecoveryServicesRecoveryPointId provisioning property.
propertyrequestedBackupStorageRedundancyBicepValueProxy | SqlBackupStorageRedundancyget · set
Gets or sets the RequestedBackupStorageRedundancy provisioning property.
propertyrequestedServiceObjectiveNameBicepValueProxy | stringget
Gets the RequestedServiceObjectiveName provisioning property.
propertyrestorableDroppedDatabaseIdBicepValueProxyget · set
Gets or sets the RestorableDroppedDatabaseId provisioning property.
propertyrestorePointInTimeBicepValueProxy | datetimeoffsetget · set
Gets or sets the RestorePointInTime provisioning property.
propertyresumedOnBicepValueProxy | datetimeoffsetget
Gets the ResumedOn provisioning property.
propertysampleNameBicepValueProxy | SampleSchemaNameget · set
Gets or sets the SampleName provisioning property.
propertysecondaryTypeBicepValueProxy | SecondaryTypeget · set
Gets or sets the SecondaryType provisioning property.
propertyskuSqlSkuProxyget · set
Gets or sets the Sku provisioning property.
propertysourceDatabaseDeletedOnBicepValueProxy | datetimeoffsetget · set
Gets or sets the SourceDatabaseDeletedOn provisioning property.
propertysourceDatabaseIdBicepValueProxyget · set
Gets or sets the SourceDatabaseId provisioning property.
propertysourceResourceIdBicepValueProxyget · set
Gets or sets the SourceResourceId provisioning property.
propertystatusBicepValueProxy | SqlDatabaseStatusget
Gets the Status provisioning property.
propertysystemDataSqlSystemDataProxyget
Gets the SystemData provisioning property.
propertytagsAspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxyget · set
Gets or sets the Tags provisioning property.
propertyuseFreeLimitBicepValueProxy | booleanget · set
Gets or sets the UseFreeLimit provisioning property.

Methods

methodaddTo
Adds this provisioning resource to the Azure resource infrastructure.
addTo(infrastructure: AzureResourceInfrastructure): void
infrastructureAzureResourceInfrastructure
Clears the AutoPauseDelay provisioning property.
clearAutoPauseDelay(): void
Clears the AvailabilityZone provisioning property.
clearAvailabilityZone(): void
Clears the CatalogCollation provisioning property.
clearCatalogCollation(): void
Clears the Collation provisioning property.
clearCollation(): void
Clears the CreateMode provisioning property.
clearCreateMode(): void
Clears the ElasticPoolId provisioning property.
clearElasticPoolId(): void
Clears the EncryptionProtector provisioning property.
clearEncryptionProtector(): void
Clears the EncryptionProtectorAutoRotation provisioning property.
clearEncryptionProtectorAutoRotation(): void
Clears the FederatedClientId provisioning property.
clearFederatedClientId(): void
Clears the FreeLimitExhaustionBehavior provisioning property.
clearFreeLimitExhaustionBehavior(): void
Clears the HighAvailabilityReplicaCount provisioning property.
clearHighAvailabilityReplicaCount(): void
Clears the IsLedgerOn provisioning property.
clearIsLedgerOn(): void
Clears the IsZoneRedundant provisioning property.
clearIsZoneRedundant(): void
Clears the LicenseType provisioning property.
clearLicenseType(): void
Clears the Location provisioning property.
clearLocation(): void
Clears the LongTermRetentionBackupResourceId provisioning property.
clearLongTermRetentionBackupResourceId(): void
Clears the MaintenanceConfigurationId provisioning property.
clearMaintenanceConfigurationId(): void
Clears the ManualCutover provisioning property.
clearManualCutover(): void
Clears the MaxSizeBytes provisioning property.
clearMaxSizeBytes(): void
Clears the MinCapacity provisioning property.
clearMinCapacity(): void
methodclearName
Clears the Name provisioning property.
clearName(): void
Clears the PerformCutover provisioning property.
clearPerformCutover(): void
Clears the PreferredEnclaveType provisioning property.
clearPreferredEnclaveType(): void
Clears the ReadScale provisioning property.
clearReadScale(): void
Clears the RecoverableDatabaseId provisioning property.
clearRecoverableDatabaseId(): void
Clears the RecoveryServicesRecoveryPointId provisioning property.
clearRecoveryServicesRecoveryPointId(): void
Clears the RequestedBackupStorageRedundancy provisioning property.
clearRequestedBackupStorageRedundancy(): void
Clears the RestorableDroppedDatabaseId provisioning property.
clearRestorableDroppedDatabaseId(): void
Clears the RestorePointInTime provisioning property.
clearRestorePointInTime(): void
Clears the SampleName provisioning property.
clearSampleName(): void
Clears the SecondaryType provisioning property.
clearSecondaryType(): void
Clears the SourceDatabaseDeletedOn provisioning property.
clearSourceDatabaseDeletedOn(): void
Clears the SourceDatabaseId provisioning property.
clearSourceDatabaseId(): void
Clears the SourceResourceId provisioning property.
clearSourceResourceId(): void
Clears the UseFreeLimit provisioning property.
clearUseFreeLimit(): void