# SqlDatabaseProxy

- Module: [Aspire.Hosting.Azure.Provisioning.Sql](/reference/api/typescript/aspire.hosting.azure.provisioning.sql.md)
- Version: `13.6.0-preview.1.26478.8`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62)

Represents the SqlDatabase Azure Provisioning model.

## Definition

```typescript
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

- `autoPauseDelay`: `BicepValueProxy | number` `get - set` -- Gets or sets the AutoPauseDelay provisioning property.
- `availabilityZone`: `BicepValueProxy | SqlAvailabilityZoneType` `get - set` -- Gets or sets the AvailabilityZone provisioning property.
- `catalogCollation`: `BicepValueProxy | CatalogCollationType` `get - set` -- Gets or sets the CatalogCollation provisioning property.
- `collation`: `BicepValueProxy | string` `get - set` -- Gets or sets the Collation provisioning property.
- `createdOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the CreatedOn provisioning property.
- `createMode`: `BicepValueProxy | SqlDatabaseCreateMode` `get - set` -- Gets or sets the CreateMode provisioning property.
- `currentBackupStorageRedundancy`: `BicepValueProxy | SqlBackupStorageRedundancy` `get` -- Gets the CurrentBackupStorageRedundancy provisioning property.
- `currentServiceObjectiveName`: `BicepValueProxy | string` `get` -- Gets the CurrentServiceObjectiveName provisioning property.
- `currentSku`: [SqlSkuProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlskuproxy.md) `get` -- Gets the CurrentSku provisioning property.
- `databaseId`: `BicepValueProxy | guid` `get` -- Gets the DatabaseId provisioning property.
- `defaultSecondaryLocation`: `BicepValueProxy` `get` -- Gets the DefaultSecondaryLocation provisioning property.
- `earliestRestoreOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the EarliestRestoreOn provisioning property.
- `elasticPoolId`: `BicepValueProxy` `get - set` -- Gets or sets the ElasticPoolId provisioning property.
- `encryptionProtector`: `BicepValueProxy | string` `get - set` -- Gets or sets the EncryptionProtector provisioning property.
- `encryptionProtectorAutoRotation`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EncryptionProtectorAutoRotation provisioning property.
- `failoverGroupId`: `BicepValueProxy` `get` -- Gets the FailoverGroupId provisioning property.
- `federatedClientId`: `BicepValueProxy | guid` `get - set` -- Gets or sets the FederatedClientId provisioning property.
- `freeLimitExhaustionBehavior`: `BicepValueProxy | FreeLimitExhaustionBehavior` `get - set` -- Gets or sets the FreeLimitExhaustionBehavior provisioning property.
- `highAvailabilityReplicaCount`: `BicepValueProxy | number` `get - set` -- Gets or sets the HighAvailabilityReplicaCount provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `identity`: [DatabaseIdentityProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/databaseidentityproxy.md) `get - set` -- Gets or sets the Identity provisioning property.
- `isInfraEncryptionEnabled`: `BicepValueProxy | boolean` `get` -- Gets the IsInfraEncryptionEnabled provisioning property.
- `isLedgerOn`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the IsLedgerOn provisioning property.
- `isZoneRedundant`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the IsZoneRedundant provisioning property.
- `keys`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfSqlDatabaseKeyProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-dictionaryofsqldatabasekeyproxy.md) `get - set` -- Gets or sets the Keys provisioning property.
- `kind`: `BicepValueProxy | string` `get` -- Gets the Kind provisioning property.
- `licenseType`: `BicepValueProxy | DatabaseLicenseType` `get - set` -- Gets or sets the LicenseType provisioning property.
- `location`: `BicepValueProxy` `get - set` -- Gets or sets the Location provisioning property.
- `longTermRetentionBackupResourceId`: `BicepValueProxy` `get - set` -- Gets or sets the LongTermRetentionBackupResourceId provisioning property.
- `maintenanceConfigurationId`: `BicepValueProxy` `get - set` -- Gets or sets the MaintenanceConfigurationId provisioning property.
- `managedBy`: `BicepValueProxy | string` `get` -- Gets the ManagedBy provisioning property.
- `manualCutover`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the ManualCutover provisioning property.
- `maxLogSizeBytes`: `BicepValueProxy | number` `get` -- Gets the MaxLogSizeBytes provisioning property.
- `maxSizeBytes`: `BicepValueProxy | number` `get - set` -- Gets or sets the MaxSizeBytes provisioning property.
- `minCapacity`: `BicepValueProxy | number` `get - set` -- Gets or sets the MinCapacity provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `parent`: [SqlServerProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy.md) `get - set` -- Gets or sets the Parent provisioning property.
- `pausedOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the PausedOn provisioning property.
- `performCutover`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the PerformCutover provisioning property.
- `preferredEnclaveType`: `BicepValueProxy | SqlAlwaysEncryptedEnclaveType` `get - set` -- Gets or sets the PreferredEnclaveType provisioning property.
- `readScale`: `BicepValueProxy | DatabaseReadScale` `get - set` -- Gets or sets the ReadScale provisioning property.
- `recoverableDatabaseId`: `BicepValueProxy` `get - set` -- Gets or sets the RecoverableDatabaseId provisioning property.
- `recoveryServicesRecoveryPointId`: `BicepValueProxy` `get - set` -- Gets or sets the RecoveryServicesRecoveryPointId provisioning property.
- `requestedBackupStorageRedundancy`: `BicepValueProxy | SqlBackupStorageRedundancy` `get - set` -- Gets or sets the RequestedBackupStorageRedundancy provisioning property.
- `requestedServiceObjectiveName`: `BicepValueProxy | string` `get` -- Gets the RequestedServiceObjectiveName provisioning property.
- `restorableDroppedDatabaseId`: `BicepValueProxy` `get - set` -- Gets or sets the RestorableDroppedDatabaseId provisioning property.
- `restorePointInTime`: `BicepValueProxy | datetimeoffset` `get - set` -- Gets or sets the RestorePointInTime provisioning property.
- `resumedOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the ResumedOn provisioning property.
- `sampleName`: `BicepValueProxy | SampleSchemaName` `get - set` -- Gets or sets the SampleName provisioning property.
- `secondaryType`: `BicepValueProxy | SecondaryType` `get - set` -- Gets or sets the SecondaryType provisioning property.
- `sku`: [SqlSkuProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlskuproxy.md) `get - set` -- Gets or sets the Sku provisioning property.
- `sourceDatabaseDeletedOn`: `BicepValueProxy | datetimeoffset` `get - set` -- Gets or sets the SourceDatabaseDeletedOn provisioning property.
- `sourceDatabaseId`: `BicepValueProxy` `get - set` -- Gets or sets the SourceDatabaseId provisioning property.
- `sourceResourceId`: `BicepValueProxy` `get - set` -- Gets or sets the SourceResourceId provisioning property.
- `status`: `BicepValueProxy | SqlDatabaseStatus` `get` -- Gets the Status provisioning property.
- `systemData`: [SqlSystemDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlsystemdataproxy.md) `get` -- Gets the SystemData provisioning property.
- `tags`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-dictionaryofstringproxy.md) `get - set` -- Gets or sets the Tags provisioning property.
- `useFreeLimit`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the UseFreeLimit provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearAutoPauseDelay](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearautopausedelay.md) -- `method` -- Clears the AutoPauseDelay provisioning property.
    ```typescript
  clearAutoPauseDelay(): void
  ```
- [clearAvailabilityZone](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearavailabilityzone.md) -- `method` -- Clears the AvailabilityZone provisioning property.
    ```typescript
  clearAvailabilityZone(): void
  ```
- [clearCatalogCollation](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearcatalogcollation.md) -- `method` -- Clears the CatalogCollation provisioning property.
    ```typescript
  clearCatalogCollation(): void
  ```
- [clearCollation](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearcollation.md) -- `method` -- Clears the Collation provisioning property.
    ```typescript
  clearCollation(): void
  ```
- [clearCreateMode](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearcreatemode.md) -- `method` -- Clears the CreateMode provisioning property.
    ```typescript
  clearCreateMode(): void
  ```
- [clearElasticPoolId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearelasticpoolid.md) -- `method` -- Clears the ElasticPoolId provisioning property.
    ```typescript
  clearElasticPoolId(): void
  ```
- [clearEncryptionProtector](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearencryptionprotector.md) -- `method` -- Clears the EncryptionProtector provisioning property.
    ```typescript
  clearEncryptionProtector(): void
  ```
- [clearEncryptionProtectorAutoRotation](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearencryptionprotectorautorotation.md) -- `method` -- Clears the EncryptionProtectorAutoRotation provisioning property.
    ```typescript
  clearEncryptionProtectorAutoRotation(): void
  ```
- [clearFederatedClientId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearfederatedclientid.md) -- `method` -- Clears the FederatedClientId provisioning property.
    ```typescript
  clearFederatedClientId(): void
  ```
- [clearFreeLimitExhaustionBehavior](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearfreelimitexhaustionbehavior.md) -- `method` -- Clears the FreeLimitExhaustionBehavior provisioning property.
    ```typescript
  clearFreeLimitExhaustionBehavior(): void
  ```
- [clearHighAvailabilityReplicaCount](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearhighavailabilityreplicacount.md) -- `method` -- Clears the HighAvailabilityReplicaCount provisioning property.
    ```typescript
  clearHighAvailabilityReplicaCount(): void
  ```
- [clearIsLedgerOn](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearisledgeron.md) -- `method` -- Clears the IsLedgerOn provisioning property.
    ```typescript
  clearIsLedgerOn(): void
  ```
- [clearIsZoneRedundant](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/cleariszoneredundant.md) -- `method` -- Clears the IsZoneRedundant provisioning property.
    ```typescript
  clearIsZoneRedundant(): void
  ```
- [clearLicenseType](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearlicensetype.md) -- `method` -- Clears the LicenseType provisioning property.
    ```typescript
  clearLicenseType(): void
  ```
- [clearLocation](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearlocation.md) -- `method` -- Clears the Location provisioning property.
    ```typescript
  clearLocation(): void
  ```
- [clearLongTermRetentionBackupResourceId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearlongtermretentionbackupresourceid.md) -- `method` -- Clears the LongTermRetentionBackupResourceId provisioning property.
    ```typescript
  clearLongTermRetentionBackupResourceId(): void
  ```
- [clearMaintenanceConfigurationId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearmaintenanceconfigurationid.md) -- `method` -- Clears the MaintenanceConfigurationId provisioning property.
    ```typescript
  clearMaintenanceConfigurationId(): void
  ```
- [clearManualCutover](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearmanualcutover.md) -- `method` -- Clears the ManualCutover provisioning property.
    ```typescript
  clearManualCutover(): void
  ```
- [clearMaxSizeBytes](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearmaxsizebytes.md) -- `method` -- Clears the MaxSizeBytes provisioning property.
    ```typescript
  clearMaxSizeBytes(): void
  ```
- [clearMinCapacity](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearmincapacity.md) -- `method` -- Clears the MinCapacity provisioning property.
    ```typescript
  clearMinCapacity(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearPerformCutover](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearperformcutover.md) -- `method` -- Clears the PerformCutover provisioning property.
    ```typescript
  clearPerformCutover(): void
  ```
- [clearPreferredEnclaveType](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearpreferredenclavetype.md) -- `method` -- Clears the PreferredEnclaveType provisioning property.
    ```typescript
  clearPreferredEnclaveType(): void
  ```
- [clearReadScale](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearreadscale.md) -- `method` -- Clears the ReadScale provisioning property.
    ```typescript
  clearReadScale(): void
  ```
- [clearRecoverableDatabaseId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearrecoverabledatabaseid.md) -- `method` -- Clears the RecoverableDatabaseId provisioning property.
    ```typescript
  clearRecoverableDatabaseId(): void
  ```
- [clearRecoveryServicesRecoveryPointId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearrecoveryservicesrecoverypointid.md) -- `method` -- Clears the RecoveryServicesRecoveryPointId provisioning property.
    ```typescript
  clearRecoveryServicesRecoveryPointId(): void
  ```
- [clearRequestedBackupStorageRedundancy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearrequestedbackupstorageredundancy.md) -- `method` -- Clears the RequestedBackupStorageRedundancy provisioning property.
    ```typescript
  clearRequestedBackupStorageRedundancy(): void
  ```
- [clearRestorableDroppedDatabaseId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearrestorabledroppeddatabaseid.md) -- `method` -- Clears the RestorableDroppedDatabaseId provisioning property.
    ```typescript
  clearRestorableDroppedDatabaseId(): void
  ```
- [clearRestorePointInTime](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearrestorepointintime.md) -- `method` -- Clears the RestorePointInTime provisioning property.
    ```typescript
  clearRestorePointInTime(): void
  ```
- [clearSampleName](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearsamplename.md) -- `method` -- Clears the SampleName provisioning property.
    ```typescript
  clearSampleName(): void
  ```
- [clearSecondaryType](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearsecondarytype.md) -- `method` -- Clears the SecondaryType provisioning property.
    ```typescript
  clearSecondaryType(): void
  ```
- [clearSourceDatabaseDeletedOn](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearsourcedatabasedeletedon.md) -- `method` -- Clears the SourceDatabaseDeletedOn provisioning property.
    ```typescript
  clearSourceDatabaseDeletedOn(): void
  ```
- [clearSourceDatabaseId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearsourcedatabaseid.md) -- `method` -- Clears the SourceDatabaseId provisioning property.
    ```typescript
  clearSourceDatabaseId(): void
  ```
- [clearSourceResourceId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearsourceresourceid.md) -- `method` -- Clears the SourceResourceId provisioning property.
    ```typescript
  clearSourceResourceId(): void
  ```
- [clearUseFreeLimit](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqldatabaseproxy/clearusefreelimit.md) -- `method` -- Clears the UseFreeLimit provisioning property.
    ```typescript
  clearUseFreeLimit(): void
  ```