Database interface
データベース リソース。
- Extends
プロパティ
auto |
データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します |
availability |
データベースがピン留めされる可用性ゾーンを指定します。 |
catalog |
メタデータ カタログの照合順序。 |
collation | データベースの照合順序。 |
create |
データベースの作成モードを指定します。 既定値: 通常のデータベースの作成。 コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。 セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。 PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。 回復: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。 復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能なドロップされたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。 RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントリソース ID として指定する必要があります。 DataWarehouse エディションでは、Copy、Secondary、RestoreLongTermRetentionBackup はサポートされていません。 |
creation |
データベースの作成日 (ISO8601 形式)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
current |
このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
current |
データベースの現在のサービス レベル目標名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
current |
SKU の名前と階層。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
database |
データベースの ID です。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
default |
このデータベースの既定のセカンダリ リージョン。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
earliest |
これにより、このデータベースで復元できる最も早い開始日と時刻が記録されます (ISO8601 形式)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
elastic |
このデータベースを含むエラスティック プールのリソース識別子。 |
encryption |
データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure キー コンテナー URI。 |
failover |
このデータベースが属しているフェールオーバー グループ リソース識別子。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
federated |
データベースごとのテナント間 CMK シナリオに使用されるクライアント ID |
high |
高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。 |
identity | データベースの Azure Active Directory ID。 |
is |
このデータベースでは、インフラストラクチャ暗号化が有効になっています。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
is |
このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースが作成された後は変更できません。 |
keys | 使用するユーザー割り当て ID のリソース ID |
kind | データベースの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
license |
このデータベースに適用するライセンスの種類。
|
long |
このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。 |
maintenance |
データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 |
managed |
データベースを管理するリソース。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
manual |
Hyperscale レベルへのデータベースの更新操作中に、顧客が制御する手動カットオーバーを実行する必要があるかどうか。 このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。 manualCutover を指定すると、ユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまでスケーリング操作が待機します。 カットオーバーをトリガーするには、スケーリング操作が待機中の状態のときに 'performCutover' パラメーターを指定してください。 |
max |
このデータベースの最大ログ サイズ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
max |
データベースの最大サイズ (バイト単位)。 |
min |
一時停止されていない場合、データベースが常に割り当てる最小容量 |
paused |
ユーザー構成またはアクション (ISO8601 形式) によってデータベースが一時停止された日付。 データベースの準備ができている場合は Null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
perform |
スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。 このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。 このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。 performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。 |
preferred |
データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。 |
read |
読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。 |
recoverable |
このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。 |
recovery |
このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。 |
requested |
このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。 |
requested |
データベースの要求されたサービス レベルの目標名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
restorable |
このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。 |
restore |
新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601 形式) を指定します。 |
resumed |
ユーザー アクションまたはデータベース ログインによってデータベースが再開された日付 (ISO8601 形式)。 データベースが一時停止されている場合は Null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
sample |
このデータベースの作成時に適用するサンプル スキーマの名前。 |
secondary |
データベースがセカンダリの場合は、セカンダリ の種類。 有効な値は、Geo、Named、Standby です。 |
sku | データベース SKU。 SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用
|
source |
データベースが削除された時刻を指定します。 |
source |
このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。 |
source |
このデータベースの作成操作に関連付けられているソースのリソース識別子。 このプロパティは 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 |
status | データベースの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
zone |
このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。 |
継承されたプロパティ
id | リソースの ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
location | リソースの場所。 |
name | リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
tags | リソース タグ。 |
type | リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
autoPauseDelay
データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します
autoPauseDelay?: number
プロパティ値
number
availabilityZone
データベースがピン留めされる可用性ゾーンを指定します。
availabilityZone?: string
プロパティ値
string
catalogCollation
メタデータ カタログの照合順序。
catalogCollation?: string
プロパティ値
string
collation
データベースの照合順序。
collation?: string
プロパティ値
string
createMode
データベースの作成モードを指定します。
既定値: 通常のデータベースの作成。
コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。
セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。
PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。
回復: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。
復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能なドロップされたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。
RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントリソース ID として指定する必要があります。
DataWarehouse エディションでは、Copy、Secondary、RestoreLongTermRetentionBackup はサポートされていません。
createMode?: string
プロパティ値
string
creationDate
データベースの作成日 (ISO8601 形式)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
creationDate?: Date
プロパティ値
Date
currentBackupStorageRedundancy
このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
currentBackupStorageRedundancy?: string
プロパティ値
string
currentServiceObjectiveName
データベースの現在のサービス レベル目標名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
currentServiceObjectiveName?: string
プロパティ値
string
currentSku
databaseId
データベースの ID です。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
databaseId?: string
プロパティ値
string
defaultSecondaryLocation
このデータベースの既定のセカンダリ リージョン。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
defaultSecondaryLocation?: string
プロパティ値
string
earliestRestoreDate
これにより、このデータベースで復元できる最も早い開始日と時刻が記録されます (ISO8601 形式)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
earliestRestoreDate?: Date
プロパティ値
Date
elasticPoolId
このデータベースを含むエラスティック プールのリソース識別子。
elasticPoolId?: string
プロパティ値
string
encryptionProtector
データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure キー コンテナー URI。
encryptionProtector?: string
プロパティ値
string
failoverGroupId
このデータベースが属しているフェールオーバー グループ リソース識別子。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
failoverGroupId?: string
プロパティ値
string
federatedClientId
データベースごとのテナント間 CMK シナリオに使用されるクライアント ID
federatedClientId?: string
プロパティ値
string
highAvailabilityReplicaCount
高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。
highAvailabilityReplicaCount?: number
プロパティ値
number
identity
isInfraEncryptionEnabled
このデータベースでは、インフラストラクチャ暗号化が有効になっています。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
isInfraEncryptionEnabled?: boolean
プロパティ値
boolean
isLedgerOn
このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースが作成された後は変更できません。
isLedgerOn?: boolean
プロパティ値
boolean
keys
使用するユーザー割り当て ID のリソース ID
keys?: {[propertyName: string]: DatabaseKey}
プロパティ値
{[propertyName: string]: DatabaseKey}
kind
データベースの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
kind?: string
プロパティ値
string
licenseType
このデータベースに適用するライセンスの種類。
LicenseIncluded
ライセンスが必要な場合、またはBasePrice
ライセンスを持っていて、Azure ハイブリッド特典の対象である場合は 。
licenseType?: string
プロパティ値
string
longTermRetentionBackupResourceId
このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。
longTermRetentionBackupResourceId?: string
プロパティ値
string
maintenanceConfigurationId
データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。
maintenanceConfigurationId?: string
プロパティ値
string
managedBy
データベースを管理するリソース。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
managedBy?: string
プロパティ値
string
manualCutover
Hyperscale レベルへのデータベースの更新操作中に、顧客が制御する手動カットオーバーを実行する必要があるかどうか。
このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。
manualCutover を指定すると、ユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまでスケーリング操作が待機します。
カットオーバーをトリガーするには、スケーリング操作が待機中の状態のときに 'performCutover' パラメーターを指定してください。
manualCutover?: boolean
プロパティ値
boolean
maxLogSizeBytes
このデータベースの最大ログ サイズ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
maxLogSizeBytes?: number
プロパティ値
number
maxSizeBytes
データベースの最大サイズ (バイト単位)。
maxSizeBytes?: number
プロパティ値
number
minCapacity
一時停止されていない場合、データベースが常に割り当てる最小容量
minCapacity?: number
プロパティ値
number
pausedDate
ユーザー構成またはアクション (ISO8601 形式) によってデータベースが一時停止された日付。 データベースの準備ができている場合は Null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
pausedDate?: Date
プロパティ値
Date
performCutover
スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。
このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。
このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。
performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。
performCutover?: boolean
プロパティ値
boolean
preferredEnclaveType
データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。
preferredEnclaveType?: string
プロパティ値
string
readScale
読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。
readScale?: string
プロパティ値
string
recoverableDatabaseId
このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。
recoverableDatabaseId?: string
プロパティ値
string
recoveryServicesRecoveryPointId
このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。
recoveryServicesRecoveryPointId?: string
プロパティ値
string
requestedBackupStorageRedundancy
このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。
requestedBackupStorageRedundancy?: string
プロパティ値
string
requestedServiceObjectiveName
データベースの要求されたサービス レベルの目標名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
requestedServiceObjectiveName?: string
プロパティ値
string
restorableDroppedDatabaseId
このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。
restorableDroppedDatabaseId?: string
プロパティ値
string
restorePointInTime
新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601 形式) を指定します。
restorePointInTime?: Date
プロパティ値
Date
resumedDate
ユーザー アクションまたはデータベース ログインによってデータベースが再開された日付 (ISO8601 形式)。 データベースが一時停止されている場合は Null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
resumedDate?: Date
プロパティ値
Date
sampleName
このデータベースの作成時に適用するサンプル スキーマの名前。
sampleName?: string
プロパティ値
string
secondaryType
データベースがセカンダリの場合は、セカンダリ の種類。 有効な値は、Geo、Named、Standby です。
secondaryType?: string
プロパティ値
string
sku
データベース SKU。
SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation
します。
az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
sku?: Sku
プロパティ値
sourceDatabaseDeletionDate
データベースが削除された時刻を指定します。
sourceDatabaseDeletionDate?: Date
プロパティ値
Date
sourceDatabaseId
このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。
sourceDatabaseId?: string
プロパティ値
string
sourceResourceId
このデータベースの作成操作に関連付けられているソースのリソース識別子。
このプロパティは 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
sourceResourceId?: string
プロパティ値
string
status
データベースの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
status?: string
プロパティ値
string
zoneRedundant
このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。
zoneRedundant?: boolean
プロパティ値
boolean
継承されたプロパティの詳細
id
location
name
リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name?: string
プロパティ値
string
tags
リソース タグ。
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
type
リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type?: string
プロパティ値
string