次の方法で共有

Databases - Get

  • リファレンス
サービス:
SQL Database
API バージョン:
2023-08-01

データベースを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2023-08-01
省略可能なパラメーターを含む: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?$expand={$expand}&$filter={$filter}&api-version=2023-08-01

URI パラメーター

名前 / 必須 型 説明
databaseName
 path True

string

データベースの名前。
resourceGroupName
 path True

string

リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string

Azure サブスクリプションを識別するサブスクリプション ID。
api-version
 query True

string

要求に使用する API バージョン。
$expand
 query

string

応答に含める子リソース。
$filter
 query

string

コレクション内の要素をフィルター処理する OData フィルター式。

応答

名前 型 説明
200 OK

Database

指定したデータベースを正常に取得しました。
Other Status Codes

ErrorResponse

エラー応答: ***

  • 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合

  • 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Gets a database configured with Default enclave type.
Gets a database configured with VBS enclave type.
Gets a database with Availability zone specified.
Gets a database with database level keys expanded.
Gets a database.

Gets a database configured with Default enclave type.

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "Default"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database configured with VBS enclave type.

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "VBS"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database with Availability zone specified.

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "S0",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "isLedgerOn": false,
    "availabilityZone": "1"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database with database level keys expanded.

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?$expand=keys&api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    },
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database.

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

定義

名前 説明
AlwaysEncryptedEnclaveType

データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。
AvailabilityZoneType

データベースがピン留めされる可用性ゾーンを指定します。
BackupStorageRedundancy

このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。
CatalogCollationType

メタデータ カタログの照合順序。
CreateMode

データベースの作成モードを指定します。

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。
Database

データベース リソース。
DatabaseIdentity

リソースの Azure Active Directory ID 構成。
DatabaseIdentityType

ID の種類
DatabaseKey

保存時の暗号化に使用されるデータベース レベルのキー。
DatabaseKeyType

データベース キーの種類。 サポートされている値は 'AzureKeyVault' のみです。
DatabaseLicenseType

このデータベースに適用するライセンスの種類。 ライセンスが必要な場合は LicenseIncluded、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は BasePrice します。
DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。
DatabaseStatus

データベースの状態。
DatabaseUserIdentity

リソースの Azure Active Directory ID 構成。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
FreeLimitExhaustionBehavior

空きデータベースに対して毎月の空き制限が使い果たされたときの動作を指定します。

自動一時停止: 残りの月の空き制限が使い果たされると、データベースは自動的に一時停止されます。

BillForUsage: 空き制限が使い果たされると、データベースは引き続きオンラインになり、超過分は課金されます。
SampleName

このデータベースの作成時に適用するサンプル スキーマの名前。
SecondaryType

データベースがセカンダリの場合は、そのセカンダリ の種類。 有効な値は Geo、Named、Standby です。
Sku

ARM リソース SKU。

AlwaysEncryptedEnclaveType

列挙

データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。

値 説明
Default
VBS

AvailabilityZoneType

列挙

データベースがピン留めされる可用性ゾーンを指定します。

値 説明
1
2
3
NoPreference

BackupStorageRedundancy

列挙

このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。

値 説明
Geo
GeoZone
Local
Zone

CatalogCollationType

列挙

メタデータ カタログの照合順序。

値 説明
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

列挙

データベースの作成モードを指定します。

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。

値 説明
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Object

データベース リソース。

名前 型 説明
id

string

リソース ID。
identity

DatabaseIdentity

データベースの Azure Active Directory ID。
kind

string

データベースの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
location

string

リソースの場所。
managedBy

string

データベースを管理するリソース。
name

string

リソース名。
properties.autoPauseDelay

integer (int32)

データベースが自動的に一時停止されるまでの時間 (分)。 -1 の値は、自動一時停止が無効になっていることを意味します
properties.availabilityZone

AvailabilityZoneType

データベースがピン留めされる可用性ゾーンを指定します。
properties.catalogCollation

CatalogCollationType

メタデータ カタログの照合順序。
properties.collation

string

データベースの照合順序。
properties.createMode

CreateMode

データベースの作成モードを指定します。

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。
properties.creationDate

string (date-time)

データベースの作成日 (ISO8601形式)。
properties.currentBackupStorageRedundancy

BackupStorageRedundancy

このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。
properties.currentServiceObjectiveName

string

データベースの現在のサービス レベル目標名。
properties.currentSku

Sku

SKU の名前と層。
properties.databaseId

string (uuid)

データベースの ID。
properties.defaultSecondaryLocation

string

このデータベースの既定のセカンダリ リージョン。
properties.earliestRestoreDate

string (date-time)

これにより、このデータベースに対して復元が使用できる最も早い開始日と時刻が記録されます (ISO8601形式)。
properties.elasticPoolId

string (arm-id)

このデータベースを含むエラスティック プールのリソース識別子。
properties.encryptionProtector

string

データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure Key Vault URI。
properties.encryptionProtectorAutoRotation

boolean

データベース暗号化保護機能 AKV キーの自動ローテーションを有効または無効にするフラグ。
properties.failoverGroupId

string

このデータベースが属しているフェールオーバー グループ リソース識別子。
properties.federatedClientId

string (uuid)

データベース CMK ごとのテナント間のシナリオに使用されるクライアント ID
properties.freeLimitExhaustionBehavior

FreeLimitExhaustionBehavior

空きデータベースに対して毎月の空き制限が使い果たされたときの動作を指定します。

自動一時停止: 残りの月の空き制限が使い果たされると、データベースは自動的に一時停止されます。

BillForUsage: 空き制限が使い果たされると、データベースは引き続きオンラインになり、超過分は課金されます。
properties.highAvailabilityReplicaCount

integer (int32)

高可用性を提供するために使用される Business Critical、Premium、または Hyperscale Edition データベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。
properties.isInfraEncryptionEnabled

boolean

このデータベースに対して Infra 暗号化が有効になっています。
properties.isLedgerOn

boolean

このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースの作成後は変更できません。
properties.keys

<string,  DatabaseKey>

使用するユーザー割り当て ID のリソース ID
properties.licenseType

DatabaseLicenseType

このデータベースに適用するライセンスの種類。 ライセンスが必要な場合は LicenseIncluded、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は BasePrice します。
properties.longTermRetentionBackupResourceId

string (arm-id)

このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。
properties.maintenanceConfigurationId

string

データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンスの更新が行われる期間を定義します。
properties.manualCutover

boolean

お客様が管理する手動カットオーバーを、データベースの更新操作中に Hyperscale レベルに行う必要があるかどうか。

このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。

manualCutover を指定すると、スケーリング操作はユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまで待機します。

カットオーバーをトリガーするには、スケーリング操作が待機状態のときに 'performCutover' パラメーターを指定してください。
properties.maxLogSizeBytes

integer (int64)

このデータベースの最大ログ サイズ。
properties.maxSizeBytes

integer (int64)

バイト単位で表されるデータベースの最大サイズ。
properties.minCapacity

number (double)

一時停止されていない場合、データベースが常に割り当てる最小限の容量
properties.pausedDate

string (date-time)

ユーザー構成またはアクション (ISO8601形式) によってデータベースが一時停止された日付。 データベースの準備ができた場合は Null。
properties.performCutover

boolean

スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。

このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。

このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。

performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。
properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。
properties.readScale

DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。
properties.recoverableDatabaseId

string (arm-id)

このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。
properties.recoveryServicesRecoveryPointId

string (arm-id)

このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。
properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。
properties.requestedServiceObjectiveName

string

データベースの要求されたサービス レベル目標名。
properties.restorableDroppedDatabaseId

string (arm-id)

このデータベースの作成操作に関連付けられている、復元可能な削除されたデータベースのリソース識別子。
properties.restorePointInTime

string (date-time)

新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。
properties.resumedDate

string (date-time)

ユーザー アクションまたはデータベース ログイン (ISO8601形式) によってデータベースが再開された日付。 データベースが一時停止されている場合は Null。
properties.sampleName

SampleName

このデータベースの作成時に適用するサンプル スキーマの名前。
properties.secondaryType

SecondaryType

データベースがセカンダリの場合は、そのセカンダリ の種類。 有効な値は Geo、Named、Standby です。
properties.sourceDatabaseDeletionDate

string (date-time)

データベースが削除された時刻を指定します。
properties.sourceDatabaseId

string (arm-id)

このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。
properties.sourceResourceId

string (arm-id)

このデータベースの作成操作に関連付けられているソースのリソース識別子。

このプロパティは DataWarehouse エディションでのみサポートされており、サブスクリプション間で復元できます。

sourceResourceId が指定されている場合、sourceDatabaseId、recoverableDatabaseId、restorableDroppedDatabaseId、sourceDatabaseDeletionDate を指定しないでください。CreateMode は PointInTimeRestore、Restore、または Recover である必要があります。

createMode が PointInTimeRestore の場合、sourceResourceId は既存のデータベースまたは既存の SQL プールのリソース ID である必要があり、restorePointInTime を指定する必要があります。

createMode が Restore の場合、sourceResourceId は、復元可能な削除されたデータベースまたは復元可能な削除された SQL プールのリソース ID である必要があります。

createMode が Recover の場合、sourceResourceId は回復可能なデータベースまたは回復可能な SQL プールのリソース ID である必要があります。

ソース サブスクリプションがターゲット サブスクリプションとは異なるテナントに属している場合、"x-ms-authorization-auxiliary" ヘッダーにはソース テナントの認証トークンが含まれている必要があります。 "x-ms-authorization-auxiliary" ヘッダーの詳細については、https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant を参照してください。
properties.status

DatabaseStatus

データベースの状態。
properties.useFreeLimit

boolean

データベースが無料の月次制限を使用しているかどうか。 サブスクリプション内の 1 つのデータベースで許可されます。
properties.zoneRedundant

boolean

このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。
sku

Sku

データベース SKU。

SKU の一覧は、リージョンとサポート プランによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、Capabilities_ListByLocation REST API または次のいずれかのコマンドを使用します。

az sql db list-editions -l <location> -o table

Get-AzSqlServerServiceObjective -Location <location>
tags

object

リソース タグ。
type

string

リソースの種類。

DatabaseIdentity

Object

リソースの Azure Active Directory ID 構成。

名前 型 説明
tenantId

string (uuid)

Azure Active Directory テナント ID。
type

DatabaseIdentityType

ID の種類
userAssignedIdentities

<string,  DatabaseUserIdentity>

使用するユーザー割り当て ID のリソース ID

DatabaseIdentityType

列挙

ID の種類

値 説明
None
UserAssigned

DatabaseKey

Object

保存時の暗号化に使用されるデータベース レベルのキー。

名前 型 説明
creationDate

string (date-time)

データベース キーの作成日。
subregion

string

サーバー キーのサブ領域。
thumbprint

string

データベース キーの拇印。
type

DatabaseKeyType

データベース キーの種類。 サポートされている値は 'AzureKeyVault' のみです。

DatabaseKeyType

列挙

データベース キーの種類。 サポートされている値は 'AzureKeyVault' のみです。

値 説明
AzureKeyVault

DatabaseLicenseType

列挙

このデータベースに適用するライセンスの種類。 ライセンスが必要な場合は LicenseIncluded、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は BasePrice します。

値 説明
BasePrice
LicenseIncluded

DatabaseReadScale

列挙

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

値 説明
Disabled
Enabled

DatabaseStatus

列挙

データベースの状態。

値 説明
AutoClosed
Copying
Creating
Disabled
EmergencyMode
Inaccessible
Offline
OfflineChangingDwPerformanceTiers
OfflineSecondary
Online
OnlineChangingDwPerformanceTiers
Paused
Pausing
Recovering
RecoveryPending
Restoring
Resuming
Scaling
Shutdown
Standby
Starting
Stopped
Stopping
Suspect

DatabaseUserIdentity

Object

リソースの Azure Active Directory ID 構成。

名前 型 説明
clientId

string (uuid)

Azure Active Directory クライアント ID。
principalId

string (uuid)

Azure Active Directory プリンシパル ID。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

FreeLimitExhaustionBehavior

列挙

空きデータベースに対して毎月の空き制限が使い果たされたときの動作を指定します。

自動一時停止: 残りの月の空き制限が使い果たされると、データベースは自動的に一時停止されます。

BillForUsage: 空き制限が使い果たされると、データベースは引き続きオンラインになり、超過分は課金されます。

値 説明
AutoPause
BillOverUsage

SampleName

列挙

このデータベースの作成時に適用するサンプル スキーマの名前。

値 説明
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

列挙

データベースがセカンダリの場合は、そのセカンダリ の種類。 有効な値は Geo、Named、Standby です。

値 説明
Geo
Named
Standby

Sku

Object

ARM リソース SKU。

名前 型 説明
capacity

integer (int32)

特定の SKU の容量。
family

string

同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name

string

SKU の名前 。通常は、文字 + 番号コード (P3 など)。
size

string

特定の SKU のサイズ
tier

string

特定の SKU のレベルまたはエディション (Basic、Premium など)。