Database interface

パッケージ:

@azure/arm-sql

データベース リソース。

Extends

TrackedResource

プロパティ

autoPauseDelay	データベースが自動的に一時停止されるまでの時間 (分)。 -1 の値は、自動一時停止が無効になっていることを意味します
availabilityZone	データベースがピン留めされる可用性ゾーンを指定します。
catalogCollation	メタデータ カタログの照合順序。
collation	データベースの照合順序。
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 はサポートされていません。
creationDate	データベースの作成日 (ISO8601形式)。
currentBackupStorageRedundancy	このデータベースのバックアップを格納するために使用されるストレージ アカウントの種類。
currentServiceObjectiveName	データベースの現在のサービス レベル目標名。
currentSku	SKU の名前と層。
databaseId	データベースの ID。
defaultSecondaryLocation	このデータベースの既定のセカンダリ リージョン。
earliestRestoreDate	これにより、このデータベースに対して復元が使用できる最も早い開始日と時刻が記録されます (ISO8601形式)。
elasticPoolId	このデータベースを含むエラスティック プールのリソース識別子。
encryptionProtector	データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure Key Vault URI。
encryptionProtectorAutoRotation	データベース暗号化保護機能 AKV キーの自動ローテーションを有効または無効にするフラグ。
failoverGroupId	このデータベースが属しているフェールオーバー グループ リソース識別子。
federatedClientId	データベース CMK ごとのテナント間のシナリオに使用されるクライアント ID
freeLimitExhaustionBehavior	空きデータベースに対して毎月の空き制限が使い果たされたときの動作を指定します。 自動一時停止: 残りの月の空き制限が使い果たされると、データベースは自動的に一時停止されます。 BillForUsage: 空き制限が使い果たされると、データベースは引き続きオンラインになり、超過分は課金されます。
highAvailabilityReplicaCount	高可用性を提供するために使用される Business Critical、Premium、または Hyperscale Edition データベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。
identity	データベースの Azure Active Directory ID。
isInfraEncryptionEnabled	このデータベースに対して Infra 暗号化が有効になっています。
isLedgerOn	このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースの作成後は変更できません。
keys	使用するユーザー割り当て ID のリソース ID
kind	データベースの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
licenseType	このデータベースに適用するライセンスの種類。 ライセンスが必要な場合は LicenseIncluded、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は BasePrice します。
longTermRetentionBackupResourceId	このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。
maintenanceConfigurationId	データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンスの更新が行われる期間を定義します。
managedBy	データベースを管理するリソース。
manualCutover	お客様が管理する手動カットオーバーを、データベースの更新操作中に Hyperscale レベルに行う必要があるかどうか。 このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。 manualCutover を指定すると、スケーリング操作はユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまで待機します。 カットオーバーをトリガーするには、スケーリング操作が待機状態のときに 'performCutover' パラメーターを指定してください。
maxLogSizeBytes	このデータベースの最大ログ サイズ。
maxSizeBytes	バイト単位で表されるデータベースの最大サイズ。
minCapacity	一時停止されていない場合、データベースが常に割り当てる最小限の容量
pausedDate	ユーザー構成またはアクション (ISO8601形式) によってデータベースが一時停止された日付。 データベースの準備ができた場合は Null。
performCutover	スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。 このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。 このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。 performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。
preferredEnclaveType	データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。
readScale	読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。
recoverableDatabaseId	このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。
recoveryServicesRecoveryPointId	このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。
requestedBackupStorageRedundancy	このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。
requestedServiceObjectiveName	データベースの要求されたサービス レベル目標名。
restorableDroppedDatabaseId	このデータベースの作成操作に関連付けられている、復元可能な削除されたデータベースのリソース識別子。
restorePointInTime	新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。
resumedDate	ユーザー アクションまたはデータベース ログイン (ISO8601形式) によってデータベースが再開された日付。 データベースが一時停止されている場合は Null。
sampleName	このデータベースの作成時に適用するサンプル スキーマの名前。
secondaryType	データベースがセカンダリの場合は、そのセカンダリ の種類。 有効な値は Geo、Named、Standby です。
sku	データベース SKU。 SKU の一覧は、リージョンとサポート プランによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、Capabilities_ListByLocation REST API または次のいずれかのコマンドを使用します。 az sql db list-editions -l <location> -o table Get-AzSqlServerServiceObjective -Location <location>
sourceDatabaseDeletionDate	データベースが削除された時刻を指定します。
sourceDatabaseId	このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。
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 を参照してください。
status	データベースの状態。
useFreeLimit	データベースが無料の月次制限を使用しているかどうか。 サブスクリプション内の 1 つのデータベースで許可されます。
zoneRedundant	このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	リソースが存在する地理的な場所
name	リソースの名前
systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	リソース タグ。
type	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

プロパティの詳細

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 エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。

createMode?: string

プロパティ値

string

creationDate

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

creationDate?: Date

プロパティ値

Date

currentBackupStorageRedundancy

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

currentBackupStorageRedundancy?: string

プロパティ値

string

currentServiceObjectiveName

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

currentServiceObjectiveName?: string

プロパティ値

string

currentSku

SKU の名前と層。

currentSku?: Sku

プロパティ値

Sku

databaseId

データベースの ID。

databaseId?: string

プロパティ値

string

defaultSecondaryLocation

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

defaultSecondaryLocation?: string

プロパティ値

string

earliestRestoreDate

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

earliestRestoreDate?: Date

プロパティ値

Date

elasticPoolId

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

elasticPoolId?: string

プロパティ値

string

encryptionProtector

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

encryptionProtector?: string

プロパティ値

string

encryptionProtectorAutoRotation

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

encryptionProtectorAutoRotation?: boolean

プロパティ値

boolean

failoverGroupId

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

failoverGroupId?: string

プロパティ値

string

federatedClientId

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

federatedClientId?: string

プロパティ値

string

freeLimitExhaustionBehavior

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

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

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

freeLimitExhaustionBehavior?: string

プロパティ値

string

highAvailabilityReplicaCount

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

highAvailabilityReplicaCount?: number

プロパティ値

number

identity

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

identity?: DatabaseIdentity

プロパティ値

DatabaseIdentity

isInfraEncryptionEnabled

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

isInfraEncryptionEnabled?: boolean

プロパティ値

boolean

isLedgerOn

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

isLedgerOn?: boolean

プロパティ値

boolean

keys

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

keys?: Record<string, DatabaseKey>

プロパティ値

Record<string, DatabaseKey>

kind

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

kind?: string

プロパティ値

string

licenseType

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

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 名、レベル/エディション、ファミリ、容量を含む) を確認するには、Capabilities_ListByLocation REST API または次のいずれかのコマンドを使用します。

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

Get-AzSqlServerServiceObjective -Location <location>

sku?: 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

useFreeLimit

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

useFreeLimit?: boolean

プロパティ値

boolean

zoneRedundant

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

zoneRedundant?: boolean

プロパティ値

boolean

継承されたプロパティの詳細

id

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

プロパティ値

string

TrackedResource.id から継承された

location

リソースが存在する地理的な場所

location: string

プロパティ値

string

TrackedResource.location から継承

name

リソースの名前

name?: string

プロパティ値

string

TrackedResource.name から継承された

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

systemData?: SystemData

プロパティ値

SystemData

trackedResource.systemData から継承

tags

リソース タグ。

tags?: Record<string, string>

プロパティ値

Record<string, string>

TrackedResource.tags から継承された

type

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

type?: string

プロパティ値

string

trackedResource.typeから継承された