Share via


Databases - List By Recommended Elastic Pool

Returns a list of databases inside a recommended elastic pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools/{recommendedElasticPoolName}/databases?api-version=2014-04-01

URI Parameters

Name In Required Type Description
recommendedElasticPoolName
path True

string

The name of the recommended elastic pool to be retrieved.

resourceGroupName
path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True

string

The name of the server.

subscriptionId
path True

string

The subscription ID that identifies an Azure subscription.

api-version
query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

DatabaseListResult

OK

Examples

Gets databases in an elastic pool

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/recommendedElasticPools/sqlcrudtest-7745/databases?api-version=2014-04-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/databases/master",
      "name": "master",
      "type": "Microsoft.Sql/servers/databases",
      "location": "Japan East",
      "kind": "v12.0,system",
      "properties": {
        "databaseId": "e760a51c-3dce-4d8c-976b-a2b929a73e08",
        "edition": "System",
        "status": "Online",
        "serviceLevelObjective": "System2",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": "32212254720",
        "creationDate": "2017-02-10T00:59:33.483Z",
        "currentServiceObjectiveId": "620323bf-2879-4807-b30d-c2e6d7b3b3aa",
        "requestedServiceObjectiveId": "620323bf-2879-4807-b30d-c2e6d7b3b3aa",
        "requestedServiceObjectiveName": "System2",
        "sampleName": null,
        "defaultSecondaryLocation": "Japan West",
        "earliestRestoreDate": null,
        "elasticPoolName": null,
        "containmentState": 2,
        "readScale": "Disabled",
        "failoverGroupId": null
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/databases/sqlcrudtest-1142",
      "name": "sqlcrudtest-1142",
      "type": "Microsoft.Sql/servers/databases",
      "location": "Japan East",
      "kind": "v12.0,user",
      "properties": {
        "databaseId": "11c1813c-52db-4d17-95d7-119eda1850b1",
        "edition": "Standard",
        "status": "Online",
        "serviceLevelObjective": "S0",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": "268435456000",
        "creationDate": "2017-02-10T01:03:34.04Z",
        "currentServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveName": "S0",
        "sampleName": null,
        "defaultSecondaryLocation": "Japan West",
        "earliestRestoreDate": "2017-02-10T01:14:10.233Z",
        "elasticPoolName": null,
        "containmentState": 2,
        "readScale": "Disabled",
        "failoverGroupId": null
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/databases/sqlcrudtest-2788",
      "name": "sqlcrudtest-2788",
      "type": "Microsoft.Sql/servers/databases",
      "location": "Japan East",
      "kind": "v12.0,user",
      "properties": {
        "databaseId": "d63e118b-41cf-49b9-8dac-aa6ef6f91731",
        "edition": "Standard",
        "status": "Online",
        "serviceLevelObjective": "S0",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": "268435456000",
        "creationDate": "2017-02-10T01:00:21.067Z",
        "currentServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveName": "S0",
        "sampleName": null,
        "defaultSecondaryLocation": "Japan West",
        "earliestRestoreDate": "2017-02-10T01:10:52.25Z",
        "elasticPoolName": null,
        "containmentState": 2,
        "readScale": "Disabled",
        "failoverGroupId": null
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/databases/sqlcrudtest-6877",
      "name": "sqlcrudtest-6877",
      "type": "Microsoft.Sql/servers/databases",
      "location": "Japan East",
      "kind": "v12.0,user",
      "properties": {
        "databaseId": "40ac16e8-855c-439c-b495-c97e918a771c",
        "edition": "Standard",
        "status": "Online",
        "serviceLevelObjective": "S0",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": "268435456000",
        "creationDate": "2017-02-10T01:02:28.853Z",
        "currentServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveName": "S0",
        "sampleName": null,
        "defaultSecondaryLocation": "Japan West",
        "earliestRestoreDate": "2017-02-10T01:13:21.66Z",
        "elasticPoolName": null,
        "containmentState": 2,
        "readScale": "Disabled",
        "failoverGroupId": null
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Sql/servers/sqlcrudtest-7177/databases/sqlcrudtest-9888",
      "name": "sqlcrudtest-9888",
      "type": "Microsoft.Sql/servers/databases",
      "location": "Japan East",
      "kind": "v12.0,user",
      "properties": {
        "databaseId": "59daf4ad-082f-4ac5-b38a-ed656b937980",
        "edition": "Standard",
        "status": "Online",
        "serviceLevelObjective": "S0",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": "268435456000",
        "creationDate": "2017-02-10T01:01:25.347Z",
        "currentServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "requestedServiceObjectiveName": "S0",
        "sampleName": null,
        "defaultSecondaryLocation": "Japan West",
        "earliestRestoreDate": "2017-02-10T01:12:05.303Z",
        "elasticPoolName": null,
        "containmentState": 2,
        "readScale": "Disabled",
        "failoverGroupId": null
      }
    }
  ]
}

Definitions

Name Description
CreateMode

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.

OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

Database

The list of databases housed in the server.

DatabaseEdition

The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
DatabaseListResult

Represents the response to a list database request.

OperationImpact

The estimated impact of doing recommended index action.

ReadScale

Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition.

RecommendedIndex

The recommended indices for this database.

RecommendedIndexAction

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance.

RecommendedIndexState

The current recommendation state.

RecommendedIndexType

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE)

SampleName

Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition.

ServiceObjectiveName

The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
ServiceTierAdvisor

The list of service tier advisors for this database. Expanded property

SloUsageMetric

Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.

TransparentDataEncryption

The transparent data encryption info for this database.

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

CreateMode

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.

OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

Value Description
Copy
Default
NonReadableSecondary
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreLongTermRetentionBackup

Database

The list of databases housed in the server.

Name Type Description
id

string

Resource ID.

kind

string

Kind of database. This is metadata used for the Azure portal experience.

location

string

Resource location.

name

string

Resource name.

properties.collation

string

The collation of the database. If createMode is not Default, this value is ignored.

properties.containmentState

integer (int64)

The containment state of the database.

properties.createMode

CreateMode

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.

OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

properties.creationDate

string (date-time)

The creation date of the database (ISO8601 format).

properties.currentServiceObjectiveId

string (uuid)

The current service level objective ID of the database. This is the ID of the service level objective that is currently active.

properties.databaseId

string (uuid)

The ID of the database.

properties.defaultSecondaryLocation

string

The default secondary region for this database.

properties.earliestRestoreDate

string (date-time)

This records the earliest start date and time that restore is available for this database (ISO8601 format).

properties.edition

DatabaseEdition

The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
properties.elasticPoolName

string

The name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.

properties.failoverGroupId

string

The resource identifier of the failover group containing this database.

properties.maxSizeBytes

string

The max size of the database expressed in bytes. If createMode is not Default, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation."

properties.readScale

ReadScale

Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition.

properties.recommendedIndex

RecommendedIndex[]

The recommended indices for this database.

properties.recoveryServicesRecoveryPointResourceId

string

Conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.

properties.requestedServiceObjectiveId

string (uuid)

The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName.

The list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API.

properties.requestedServiceObjectiveName

ServiceObjectiveName

The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
properties.restorePointInTime

string (date-time)

Conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.

properties.sampleName

SampleName

Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition.

properties.serviceLevelObjective

ServiceObjectiveName

The current service level objective of the database.

properties.serviceTierAdvisors

ServiceTierAdvisor[]

The list of service tier advisors for this database. Expanded property

properties.sourceDatabaseDeletionDate

string (date-time)

Conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.

properties.sourceDatabaseId

string

Conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.

properties.status

string

The status of the database.

properties.transparentDataEncryption

TransparentDataEncryption[]

The transparent data encryption info for this database.

properties.zoneRedundant

boolean

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

tags

object

Resource tags.

type

string

Resource type.

DatabaseEdition

The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
Value Description
Web
Business
Basic
Standard
Premium
PremiumRS
Free
Stretch
DataWarehouse
System
System2
GeneralPurpose
BusinessCritical
Hyperscale

DatabaseListResult

Represents the response to a list database request.

Name Type Description
value

Database[]

The list of databases housed in the server.

OperationImpact

The estimated impact of doing recommended index action.

Name Type Description
changeValueAbsolute

number (double)

The absolute impact to dimension.

changeValueRelative

number (double)

The relative impact to dimension (null if not applicable)

name

string

The name of the impact dimension.

unit

string

The unit in which estimated impact to dimension is measured.

ReadScale

Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition.

Value Description
Enabled
Disabled

RecommendedIndex

The recommended indices for this database.

Name Type Description
id

string

Resource ID.

name

string

Resource name.

properties.action

RecommendedIndexAction

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance.

properties.columns

string[]

Columns over which to build index

properties.created

string (date-time)

The UTC datetime showing when this resource was created (ISO8601 format).

properties.estimatedImpact

OperationImpact[]

The estimated impact of doing recommended index action.

properties.includedColumns

string[]

The list of column names to be included in the index

properties.indexScript

string

The full build index script

properties.indexType

RecommendedIndexType

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE)

properties.lastModified

string (date-time)

The UTC datetime of when was this resource last changed (ISO8601 format).

properties.reportedImpact

OperationImpact[]

The values reported after index action is complete.

properties.schema

string

The schema where table to build index over resides

properties.state

RecommendedIndexState

The current recommendation state.

properties.table

string

The table on which to build index.

type

string

Resource type.

RecommendedIndexAction

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance.

Value Description
Create
Drop
Rebuild

RecommendedIndexState

The current recommendation state.

Value Description
Active
Pending
Executing
Verifying
Pending Revert
Reverting
Reverted
Ignored
Expired
Blocked
Success

RecommendedIndexType

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE)

Value Description
CLUSTERED
NONCLUSTERED
COLUMNSTORE
CLUSTERED COLUMNSTORE

SampleName

Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition.

Value Description
AdventureWorksLT

ServiceObjectiveName

The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
Value Description
System
System0
System1
System2
System3
System4
System2L
System3L
System4L
Free
Basic
S0
S1
S2
S3
S4
S6
S7
S9
S12
P1
P2
P3
P4
P6
P11
P15
PRS1
PRS2
PRS4
PRS6
DW100
DW200
DW300
DW400
DW500
DW600
DW1000
DW1200
DW1000c
DW1500
DW1500c
DW2000
DW2000c
DW3000
DW2500c
DW3000c
DW6000
DW5000c
DW6000c
DW7500c
DW10000c
DW15000c
DW30000c
DS100
DS200
DS300
DS400
DS500
DS600
DS1000
DS1200
DS1500
DS2000
ElasticPool

ServiceTierAdvisor

The list of service tier advisors for this database. Expanded property

Name Type Description
id

string

Resource ID.

name

string

Resource name.

properties.activeTimeRatio

number (double)

The activeTimeRatio for service tier advisor.

properties.avgDtu

number (double)

Gets or sets avgDtu for service tier advisor.

properties.confidence

number (double)

Gets or sets confidence for service tier advisor.

properties.currentServiceLevelObjective

string

Gets or sets currentServiceLevelObjective for service tier advisor.

properties.currentServiceLevelObjectiveId

string (uuid)

Gets or sets currentServiceLevelObjectiveId for service tier advisor.

properties.databaseSizeBasedRecommendationServiceLevelObjective

string

Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor.

properties.databaseSizeBasedRecommendationServiceLevelObjectiveId

string (uuid)

Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor.

properties.disasterPlanBasedRecommendationServiceLevelObjective

string

Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor.

properties.disasterPlanBasedRecommendationServiceLevelObjectiveId

string (uuid)

Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor.

properties.maxDtu

number (double)

Gets or sets maxDtu for service tier advisor.

properties.maxSizeInGB

number (double)

Gets or sets maxSizeInGB for service tier advisor.

properties.minDtu

number (double)

Gets or sets minDtu for service tier advisor.

properties.observationPeriodEnd

string (date-time)

The observation period start (ISO8601 format).

properties.observationPeriodStart

string (date-time)

The observation period start (ISO8601 format).

properties.overallRecommendationServiceLevelObjective

string

Gets or sets overallRecommendationServiceLevelObjective for service tier advisor.

properties.overallRecommendationServiceLevelObjectiveId

string (uuid)

Gets or sets overallRecommendationServiceLevelObjectiveId for service tier advisor.

properties.serviceLevelObjectiveUsageMetrics

SloUsageMetric[]

Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.

properties.usageBasedRecommendationServiceLevelObjective

string

Gets or sets usageBasedRecommendationServiceLevelObjective for service tier advisor.

properties.usageBasedRecommendationServiceLevelObjectiveId

string (uuid)

Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor.

type

string

Resource type.

SloUsageMetric

Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.

Name Type Description
inRangeTimeRatio

number (double)

Gets or sets inRangeTimeRatio for SLO usage metric.

serviceLevelObjective

ServiceObjectiveName

The serviceLevelObjective for SLO usage metric.

serviceLevelObjectiveId

string (uuid)

The serviceLevelObjectiveId for SLO usage metric.

TransparentDataEncryption

The transparent data encryption info for this database.

Name Type Description
id

string

Resource ID.

location

string

Resource location.

name

string

Resource name.

properties.status

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

type

string

Resource type.

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

Value Description
Enabled
Disabled