Databases - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2021-11-01-preview

URI パラメーター

Name In Required Type Description
databaseName
path True
  • string

データベースの名前。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True
  • string

要求で使用する API のバージョン。

応答

Name Type Description
200 OK

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

Other Status Codes

エラー応答: ***

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

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

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

Gets a database.

Sample Request

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

Sample Response

{
  "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"
}

定義

BackupStorageRedundancy

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

CatalogCollationType

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

CreateMode

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

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

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

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

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

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

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

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

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

Database

データベース リソース。

DatabaseIdentity

リソースの ID 構成をAzure Active Directoryします。

DatabaseIdentityType

ID の種類

DatabaseLicenseType

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

DatabaseReadScale

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

DatabaseStatus

データベースの状態。

DatabaseUserIdentity

リソースの ID 構成をAzure Active Directoryします。

SampleName

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

SecondaryType

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

Sku

ARM リソース SKU。

BackupStorageRedundancy

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

CatalogCollationType

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

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

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

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

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

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

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

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

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

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

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

Name Type Description
Copy
  • string
Default
  • string
OnlineSecondary
  • string
PointInTimeRestore
  • string
Recovery
  • string
Restore
  • string
RestoreExternalBackup
  • string
RestoreExternalBackupSecondary
  • string
RestoreLongTermRetentionBackup
  • string
Secondary
  • string

Database

データベース リソース。

Name Type Description
id
  • string

リソースの ID

identity

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

kind
  • string

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

location
  • string

リソースの場所。

managedBy
  • string

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

name
  • string

リソース名。

properties.autoPauseDelay
  • integer

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

properties.catalogCollation

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

properties.collation
  • string

データベースの照合順序。

properties.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

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

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

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

properties.currentSku

SKU の名前と階層。

properties.databaseId
  • string

データベースの ID です。

properties.defaultSecondaryLocation
  • string

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

properties.earliestRestoreDate
  • string

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

properties.elasticPoolId
  • string

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

properties.failoverGroupId
  • string

このデータベースが属するフェールオーバー グループ リソース識別子。

properties.federatedClientId
  • string

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

properties.highAvailabilityReplicaCount
  • integer

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

properties.isInfraEncryptionEnabled
  • boolean

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

properties.isLedgerOn
  • boolean

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

properties.licenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の資格がある場合。

properties.longTermRetentionBackupResourceId
  • string

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

properties.maintenanceConfigurationId
  • string

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

properties.maxLogSizeBytes
  • integer

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

properties.maxSizeBytes
  • integer

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

properties.minCapacity
  • number

データベースが常に割り当てる最小容量 (一時停止されていない場合)

properties.pausedDate
  • string

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

properties.readScale

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

properties.recoverableDatabaseId
  • string

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

properties.recoveryServicesRecoveryPointId
  • string

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

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

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

properties.restorableDroppedDatabaseId
  • string

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

properties.restorePointInTime
  • string

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

properties.resumedDate
  • string

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

properties.sampleName

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

properties.secondaryType

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

properties.sourceDatabaseDeletionDate
  • string

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

properties.sourceDatabaseId
  • string

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

properties.sourceResourceId
  • string

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

このプロパティは 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

データベースの状態。

properties.zoneRedundant
  • boolean

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

sku

データベース SKU。

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

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags
  • object

リソース タグ。

type
  • string

リソースの種類。

DatabaseIdentity

リソースの ID 構成をAzure Active Directoryします。

Name Type Description
tenantId
  • string

Azure Active Directoryテナント ID。

type

ID の種類

userAssignedIdentities

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

DatabaseIdentityType

ID の種類

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseReadScale

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

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

データベースの状態。

Name Type Description
AutoClosed
  • string
Copying
  • string
Creating
  • string
Disabled
  • string
EmergencyMode
  • string
Inaccessible
  • string
Offline
  • string
OfflineChangingDwPerformanceTiers
  • string
OfflineSecondary
  • string
Online
  • string
OnlineChangingDwPerformanceTiers
  • string
Paused
  • string
Pausing
  • string
Recovering
  • string
RecoveryPending
  • string
Restoring
  • string
Resuming
  • string
Scaling
  • string
Shutdown
  • string
Standby
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string
Suspect
  • string

DatabaseUserIdentity

リソースの ID 構成をAzure Active Directoryします。

Name Type Description
clientId
  • string

Azure Active Directory クライアント ID。

principalId
  • string

Azure Active Directory プリンシパル ID。

SampleName

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

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

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

Name Type Description
Geo
  • string
Named
  • string

Sku

ARM リソース SKU。

Name Type Description
capacity
  • integer

特定の SKU の容量。

family
  • string

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

name
  • string

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

size
  • string

特定の SKU のサイズ

tier
  • string

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