Microsoft.Sql server/databases 2023-02-01-preview
- 最新
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2019-06-01-preview
- 2017-10-01-preview
- 2017-03-01-プレビュー
- 2014-04-01
Bicep リソース定義
サーバー/データベース リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/databases リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Sql/servers/databases@2023-02-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
autoPauseDelay: int
availabilityZone: 'string'
catalogCollation: 'string'
collation: 'string'
createMode: 'string'
elasticPoolId: 'string'
encryptionProtector: 'string'
encryptionProtectorAutoRotation: bool
federatedClientId: 'string'
freeLimitExhaustionBehavior: 'string'
highAvailabilityReplicaCount: int
isLedgerOn: bool
keys: {
{customized property}: {}
}
licenseType: 'string'
longTermRetentionBackupResourceId: 'string'
maintenanceConfigurationId: 'string'
manualCutover: bool
maxSizeBytes: int
minCapacity: json('decimal-as-string')
performCutover: bool
preferredEnclaveType: 'string'
readScale: 'string'
recoverableDatabaseId: 'string'
recoveryServicesRecoveryPointId: 'string'
requestedBackupStorageRedundancy: 'string'
restorableDroppedDatabaseId: 'string'
restorePointInTime: 'string'
sampleName: 'string'
secondaryType: 'string'
sourceDatabaseDeletionDate: 'string'
sourceDatabaseId: 'string'
sourceResourceId: 'string'
useFreeLimit: bool
zoneRedundant: bool
}
}
プロパティ値
servers/databases
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 128 有効な文字: 次は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| location | リソースの場所。 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku | データベース SKU。 SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation します。Azure CLI: az sql db list-editions -l {location} -o table Azure PowerShell: Get-AzSqlServerServiceObjective -Location {location} |
SKU |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: サーバー |
| identity | データベースの Azure Active Directory ID。 | DatabaseIdentity |
| properties | リソースのプロパティ。 | DatabaseProperties |
DatabaseIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類 | 'None' 'UserAssigned' |
| userAssignedIdentities | 使用するユーザー割り当て ID のリソース ID | DatabaseIdentityUserAssignedIdentities |
DatabaseIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseUserIdentity |
DatabaseUserIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DatabaseProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoPauseDelay | データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します | INT |
| availabilityZone | データベースがピン留めされる可用性ゾーンを指定します。 | '1' '2' '3' 'NoPreference' |
| catalogCollation | メタデータ カタログの照合順序。 | 'DATABASE_DEFAULT' 'SQL_Latin1_General_CP1_CI_AS' |
| 照合順序 (collation) | データベースの照合順序。 | 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 はサポートされていません。 |
'Copy' 'Default' 'OnlineSecondary' 'PointInTimeRestore' 'Recovery' 'Restore' 'RestoreExternalBackup' 'RestoreExternalBackupSecondary' 'RestoreLongTermRetentionBackup' 'Secondary' |
| elasticPoolId | このデータベースを含むエラスティック プールのリソース識別子。 | string |
| encryptionProtector | データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure キー コンテナー URI。 | string |
| encryptionProtectorAutoRotation | データベース暗号化保護機能 AKV キーの自動ローテーションを有効または無効にするフラグ。 | [bool] |
| federatedClientId | データベース CMK ごとのテナント間シナリオに使用されるクライアント ID | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 空きデータベースの月次空き制限が使い果たされた場合の動作を指定します。 AutoPause: 月の残りの期間の空き制限が使い果たされると、データベースは自動的に一時停止されます。 BillForUsage: データベースは空き制限を使い果たした時点で引き続きオンラインになり、超過分は課金されます。 |
'AutoPause' 'BillOverUsage' |
| highAvailabilityReplicaCount | 高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。 | INT |
| isLedgerOn | このデータベースが台帳データベースかどうか。つまり、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースが作成された後は変更できません。 | [bool] |
| キー | 使用するユーザー割り当て ID のリソース ID | DatabasePropertiesKeys |
| licenseType | このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスを持っていて、Azure ハイブリッド特典の資格がある場合は 。 |
'BasePrice' 'LicenseIncluded' |
| longTermRetentionBackupResourceId | このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。 | string |
| maintenanceConfigurationId | データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 | string |
| manualCutover | Hyperscale レベルへのデータベースの更新操作中に、顧客が制御する手動カットオーバーを実行する必要があるかどうか。 このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。 manualCutover を指定すると、ユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまでスケーリング操作が待機します。 カットオーバーをトリガーするには、スケーリング操作が待機中状態の場合は、'performCutover' パラメーターを指定してください。 |
[bool] |
| maxSizeBytes | バイト単位で表されるデータベースの最大サイズ。 | INT |
| minCapacity | データベースが常に割り当てる最小容量。一時停止していない場合は、10 進値を指定するには、 json() 関数を使用します。 | int または json decimal |
| performCutover | スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。 このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。 このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。 performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。 |
[bool] |
| preferredEnclaveType | データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。 | 'Default' 'VBS' |
| readScale | 読み取り専用ルーティングの状態。 有効にした場合、アプリケーションインテントが接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。 | 'Disabled' 'Enabled' |
| recoverableDatabaseId | このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。 | string |
| recoveryServicesRecoveryPointId | このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。 | string |
| requestedBackupStorageRedundancy | このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。 | 'Geo' 'GeoZone' 'Local' 'Zone' |
| restorableDroppedDatabaseId | このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。 | string |
| restorePointInTime | 新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。 | string |
| sampleName | このデータベースの作成時に適用するサンプル スキーマの名前。 | 'AdventureWorksLT' 'WideWorldImportersFull' 'WideWorldImportersStd' |
| secondaryType | データベースがセカンダリの場合は、セカンダリ の種類。 有効な値は、Geo、Named、Standby です。 | 'Geo' 'Named' 'Standby' |
| sourceDatabaseDeletionDate | データベースが削除された時刻を指定します。 | string |
| sourceDatabaseId | このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。 | 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" ヘッダーの詳細については、「/azure/azure-resource-manager/management/authenticate-multi-tenant」を参照してください。 |
string |
| useFreeLimit | データベースで無料の月次制限を使用するかどうか。 サブスクリプション内の 1 つのデータベースで許可されます。 | [bool] |
| zoneRedundant | このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。 | [bool] |
DatabasePropertiesKeys
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseKey |
DatabaseKey
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | 特定の SKU の容量。 | INT |
| family | サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。 | string |
| name | SKU の名前 (通常は文字 + 番号コード、例: P3)。 | string (必須) |
| size | 特定の SKU のサイズ | string |
| レベル | 特定の SKU のレベルまたはエディション (Basic、Premium など)。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
SQL データベースを使用した Django アプリ |
このテンプレートでは、Azure Linux CustomScript 拡張機能を使用してアプリケーションをデプロイします。 この例では、Ubuntu VM を作成し、Python、Django、Apache のサイレント インストールを実行してから、単純な Django アプリを作成します。 テンプレートでは、クエリを使用して Web ブラウザーに表示されるサンプル データを含むサンプル テーブルを含むSQL Databaseも作成されます |
| Azure での EPiserverCMS |
このテンプレートを使用すると、Azure での EpiServerCMS のデプロイに必要なリソースを作成できます |
| Azure SQL Database を使用した LANSA Windows VM ScaleSet の自動スケーリング |
このテンプレートでは、スケール セット内の VM の数が必要な Windows VMSS と、各 VM にインストールする LANSA MSI がデプロイされます。 VM スケール セットがデプロイされると、LANSA MSI をインストールするためにカスタム スクリプト拡張機能が使用されます) |
| 試用版ライセンスを使用してタコデプロイ 3.0 をデプロイする |
このテンプレートを使用すると、試用版ライセンスを使用して、1 つのタコデプロイ 3.0 サーバーをデプロイできます。 これにより、単一の Windows Server 2012R2 VM (Standard D2) と SQL DB (S1 レベル) で、リソース グループに指定された場所にデプロイされます。 |
| Orchard CMS ビデオ ポータル Web アプリ |
このテンプレートは、Azure Media Services モジュールを有効にして構成したAzure App Service Web Appsに Orchard CMS を簡単にデプロイする方法を提供します。 |
| スケーラブルな Umbraco CMS Web アプリ |
このテンプレートは、umbraco CMS Web アプリをAzure App Service Web Appsに簡単にデプロイする方法を提供します。 |
| シンプルな Umbraco CMS Web アプリ |
このテンプレートは、umbraco CMS Web アプリをAzure App Service Web Appsに簡単にデプロイする方法を提供します。 |
| Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
小規模または大規模なエンタープライズ向けのクラウド導入では、クラウド デプロイから価値を引き出すために、責任ある効率的なガバナンス モデルが必要です。 CloudWise (ソリューションのコード名) は、Azure Partner QuickStarts から入手できる複合ソリューションであり、顧客、システム インテグレーター、パートナーの導入を可能にする企業であり、コストの最適化、アプリケーションの信頼性の向上、ビジネス リスクの削減に重点を置いた、セルフサービスで自動化されたガバナンスと運用ソリューションを提供します。 このソリューションでは、可視性と制御の主要なガバナンスの柱が強調されています。 |
| ILB ASE を使用した eShop Web サイト |
App Service 環境は、Azure App Service アプリを高スケールで安全に実行するための完全に分離された専用の環境を提供する Azure App Service の Premium サービス プラン オプションであり、Web Apps、Mobile Apps、API Apps が含まれています。 |
| Azure SQL プライベート エンドポイントを使用する WebApp |
このテンプレートは、Azure SQL Server を指すプライベート エンドポイントを使用する Web アプリを作成する方法を示しています |
| 高可用性を備えたリモート デスクトップ サービス |
この ARM テンプレートサンプル コードでは、高可用性を備えた リモート デスクトップ サービス 2019 セッション コレクション ラボをデプロイします。 目標は、Windows Server 2019 を使用して、リモート デスクトップ サービス用の完全冗長で高可用性のソリューションを展開することです。 |
| Azure アーキテクチャに Sports Analytics をデプロイする |
ADLS Gen 2 が有効になっている Azure ストレージ アカウント、ストレージ アカウント (デプロイされている場合は Azure SQL Database) のリンクされたサービスを持つAzure Data Factory インスタンス、および Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントに対するストレージ BLOB データ共同作成者ロールが付与されます。 また、Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユース ケース用) をデプロイするオプションもあります。 Azure Key Vaultがデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に、Key Vault シークレット ユーザー ロールが付与されます。 |
| SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ |
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。 |
| Azure DMS を使用してAzure SQL データベースに移行する |
Azure Database Migration Service (DMS) は、オンプレミス データベースを Azure に移行するプロセスを効率化するように設計されています。 DMS を使用すると、既存のオンプレミスのSQL Serverと Oracle データベースを Azure 仮想マシン内のデータベース、Azure SQL Managed Instance、または Microsoft SQL Server Azure SQL移行が簡略化されます。 このテンプレートでは、Azure Database Migration サービスのインスタンスをデプロイします。このインスタンスには、SQL サーバーがインストールされた Azure VM がデプロイされます。これは、事前に作成されたデータベースを含むソース サーバーとして機能し、ソース サーバーからターゲット サーバーに移行するデータベースの事前作成済みスキーマを持つターゲット Azure SQL DB サーバーとして機能します。 また、このテンプレートでは、ソース VM、DMS サービス、ターゲット サーバーをサポートするために必要なリソース (NIC、vnet など) もデプロイされます。 |
| VNET でのカスタム Ambari + Hive メタストア DB を使用した HDInsight |
このテンプレートを使用すると、カスタム Ambari DB と Hive メタストアの両方として機能する新しい SQL DB を使用して、既存の仮想ネットワークに HDInsight クラスターを作成できます。 既存の SQL サーバー、ストレージ アカウント、VNET が必要です。 |
| HDInsight クラスターと SQL データベースをデプロイする |
このテンプレートを使用すると、SQoop をテストするための HDInsight クラスターとSQL Databaseを作成できます。 |
| プライベート エンドポイントの例 |
このテンプレートは、Azure SQL Server を指すプライベート エンドポイントを作成する方法を示しています |
| 監査がイベント ハブに書き込まれた Azure SQL Server |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、イベント ハブに監査ログを書き込むことができます |
| 監査が Log Analytics に書き込まれた Azure SQL Server |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、Log Analytics (OMS ワークスペース) に監査ログを書き込むことができます。 |
| Transparent Encryption を使用した専用 SQL プール |
Transparent Data Encryption を使用して、SQL Serverと専用 SQL プール (旧称 SQL DW) を作成します。 |
| SQL Serverとデータベースを作成する |
このテンプレートを使用すると、SQL Databaseとサーバーを作成できます。 |
| TDE を使用してSQL Databaseをプロビジョニングする |
このテンプレートは、Azure トラフィック用にファイアウォールを開いたSQL Serverと、Transparent Data Encryption (TDE) を使用した SQL データベースをプロビジョニングします。 |
| 新しい SQL エラスティック プールをデプロイする |
このテンプレートを使用すると、新しい関連付けられたSQL Serverとそれに割り当てる新しい SQL データベースを含む新しい SQL エラスティック プールをデプロイできます。 |
| フェールオーバー グループを使用してAzure SQL サーバーとデータベースを作成する |
データベースとフェールオーバー グループの 2 つのAzure SQL サーバーを作成します。 |
| Azure SQL バックエンドを使用したApp Service Environment |
このテンプレートでは、プライベート/分離環境で通常使用される関連リソースと共に、プライベート エンドポイントと共に、Azure SQL バックエンドを含むApp Service Environmentを作成します。 |
| SQL Databaseを使用してモバイル アプリをプロビジョニングする |
このテンプレートは、モバイル アプリ、SQL Database、および通知ハブをプロビジョニングします。 データベースと通知ハブのモバイル アプリで接続文字列を構成します。 |
| マネージド ID、SQL Server、ΑΙ を使用した Web アプリ |
アプリ用の Azure インフラストラクチャをデプロイする簡単な例 + データ + マネージド ID + 監視 |
| テンプレートを使用して Web アプリと Redis Cache + SQL DB を作成する |
このテンプレートでは、Redis キャッシュとSQL Databaseを使用して Azure Web アプリを作成します。 |
| SQL Databaseを使用して Web アプリをプロビジョニングする |
このテンプレートは、Web アプリ、SQL Database、自動スケーリング設定、アラート ルール、App Insights をプロビジョニングします。 データベースの Web アプリで接続文字列を構成します。 |
| Azure VM への Web アプリケーションの作成、構成、デプロイ |
SQL Azure データベースを使用して Windows VM を作成して構成し、PowerShell DSC を使用して Web アプリケーションを環境にデプロイする |
| Azure SQLを使用した Linux 上の Sonarqube Docker Web App |
このテンプレートは、公式の Sonarqube イメージを使用し、Azure SQL Server によってサポートされる、Azure App Service Web アプリ Linux コンテナーに Sonarqube をデプロイします。 |
ARM テンプレート リソース定義
サーバー/データベース リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/databases リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Sql/servers/databases",
"apiVersion": "2023-02-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"autoPauseDelay": "int",
"availabilityZone": "string",
"catalogCollation": "string",
"collation": "string",
"createMode": "string",
"elasticPoolId": "string",
"encryptionProtector": "string",
"encryptionProtectorAutoRotation": "bool",
"federatedClientId": "string",
"freeLimitExhaustionBehavior": "string",
"highAvailabilityReplicaCount": "int",
"isLedgerOn": "bool",
"keys": {
"{customized property}": {}
},
"licenseType": "string",
"longTermRetentionBackupResourceId": "string",
"maintenanceConfigurationId": "string",
"manualCutover": "bool",
"maxSizeBytes": "int",
"minCapacity": "[json('decimal-as-string')]",
"performCutover": "bool",
"preferredEnclaveType": "string",
"readScale": "string",
"recoverableDatabaseId": "string",
"recoveryServicesRecoveryPointId": "string",
"requestedBackupStorageRedundancy": "string",
"restorableDroppedDatabaseId": "string",
"restorePointInTime": "string",
"sampleName": "string",
"secondaryType": "string",
"sourceDatabaseDeletionDate": "string",
"sourceDatabaseId": "string",
"sourceResourceId": "string",
"useFreeLimit": "bool",
"zoneRedundant": "bool"
}
}
プロパティ値
servers/databases
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Sql/servers/databases' |
| apiVersion | リソース API のバージョン | '2023-02-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 128 有効な文字: 次は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| location | リソースの場所。 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku | データベース SKU。 SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation します。Azure CLI: az sql db list-editions -l {location} -o table Azure PowerShell: Get-AzSqlServerServiceObjective -Location {location} |
SKU |
| identity | データベースの Azure Active Directory ID。 | DatabaseIdentity |
| properties | リソースのプロパティ。 | DatabaseProperties |
DatabaseIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類 | 'None' 'UserAssigned' |
| userAssignedIdentities | 使用するユーザー割り当て ID のリソース ID | DatabaseIdentityUserAssignedIdentities |
DatabaseIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseUserIdentity |
DatabaseUserIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DatabaseProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoPauseDelay | データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します | INT |
| availabilityZone | データベースがピン留めされる可用性ゾーンを指定します。 | '1' '2' '3' 'NoPreference' |
| catalogCollation | メタデータ カタログの照合順序。 | 'DATABASE_DEFAULT' 'SQL_Latin1_General_CP1_CI_AS' |
| 照合順序 (collation) | データベースの照合順序。 | 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 はサポートされていません。 |
'Copy' 'Default' 'OnlineSecondary' 'PointInTimeRestore' 'Recovery' 'Restore' 'RestoreExternalBackup' 'RestoreExternalBackupSecondary' 'RestoreLongTermRetentionBackup' 'Secondary' |
| elasticPoolId | このデータベースを含むエラスティック プールのリソース識別子。 | string |
| encryptionProtector | データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure キー コンテナー URI。 | string |
| encryptionProtectorAutoRotation | データベース暗号化プロテクタ AKV キーの自動ローテーションを有効または無効にするフラグ。 | [bool] |
| federatedClientId | データベースごとのテナント間 CMK シナリオに使用されるクライアント ID | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 空きデータベースに対して毎月の空き制限が使い果たされた場合の動作を指定します。 AutoPause: 月の残りの期間、空き制限が使い果たされると、データベースは自動的に一時停止されます。 BillForUsage: データベースは、空き制限が使い果たされた時点で引き続きオンラインになり、超過分は課金されます。 |
'AutoPause' 'BillOverUsage' |
| highAvailabilityReplicaCount | 高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。 | INT |
| isLedgerOn | このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースが作成された後は変更できません。 | [bool] |
| キー | 使用するユーザー割り当て ID のリソース ID | DatabasePropertiesKeys |
| licenseType | このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスを持っていて、Azure ハイブリッド特典の対象である場合は 。 |
'BasePrice' 'LicenseIncluded' |
| longTermRetentionBackupResourceId | このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。 | string |
| maintenanceConfigurationId | データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 | string |
| manualCutover | Hyperscale レベルへのデータベースの更新操作中に、顧客が制御する手動カットオーバーを実行する必要があるかどうか。 このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。 manualCutover を指定すると、ユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまでスケーリング操作が待機します。 カットオーバーをトリガーするには、スケーリング操作が待機中の状態のときに 'performCutover' パラメーターを指定してください。 |
[bool] |
| maxSizeBytes | データベースの最大サイズ (バイト単位)。 | INT |
| minCapacity | データベースが常に割り当てる最小容量。一時停止していない場合は、10 進数の値を指定するには、 json() 関数を使用します。 | int または json decimal |
| performCutover | スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。 このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。 このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。 performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。 |
[bool] |
| preferredEnclaveType | データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。 | 'Default' 'VBS' |
| readScale | 読み取り専用ルーティングの状態。 有効にした場合、アプリケーションインテントが接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。 | 'Disabled' 'Enabled' |
| recoverableDatabaseId | このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。 | string |
| recoveryServicesRecoveryPointId | このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。 | string |
| requestedBackupStorageRedundancy | このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。 | 'Geo' 'GeoZone' 'Local' 'Zone' |
| restorableDroppedDatabaseId | このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。 | string |
| restorePointInTime | 新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。 | string |
| sampleName | このデータベースの作成時に適用するサンプル スキーマの名前。 | 'AdventureWorksLT' 'WideWorldImportersFull' 'WideWorldImportersStd' |
| secondaryType | データベースがセカンダリの場合は、セカンダリ型。 有効な値は Geo、名前付き、スタンバイです。 | 'Geo' 'Named' 'スタンバイ' |
| sourceDatabaseDeletionDate | データベースが削除された時刻を指定します。 | string |
| sourceDatabaseId | このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。 | 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" ヘッダーの詳細については、「/azure/azure-resource-manager/management/authenticate-multi-tenant」を参照してください。 |
string |
| useFreeLimit | データベースで無料の月次制限を使用するかどうか。 サブスクリプション内の 1 つのデータベースで許可されます。 | [bool] |
| zoneRedundant | このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。 | [bool] |
DatabasePropertiesKeys
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseKey |
DatabaseKey
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | 特定の SKU の容量。 | INT |
| family | 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 | string |
| name | SKU の名前 。通常は、文字 + 数値コード (P3 など)。 | string (必須) |
| size | 特定の SKU のサイズ | string |
| レベル | 特定の SKU のレベルまたはエディション (Basic、Premium など)。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| SQL Database を使用した Django アプリ |
このテンプレートでは、Azure Linux CustomScript 拡張機能を使用してアプリケーションをデプロイします。 この例では、Ubuntu VM を作成し、Python、Django、Apache のサイレント インストールを実行してから、単純な Django アプリを作成します。 テンプレートでは、クエリを使用して Web ブラウザーに表示されるサンプル データを含むサンプル テーブルを含むSQL Databaseも作成されます |
| Azure での EPiserverCMS |
このテンプレートを使用すると、Azure での EpiServerCMS のデプロイに必要なリソースを作成できます |
| Azure SQL Database を使用した LANSA Windows VM ScaleSet の自動スケーリング |
このテンプレートでは、スケール セット内の VM の数が必要な Windows VMSS と、各 VM にインストールする LANSA MSI がデプロイされます。 VM スケール セットがデプロイされると、LANSA MSI をインストールするためにカスタム スクリプト拡張機能が使用されます) |
| 試用版ライセンスを使用してタコデプロイ 3.0 をデプロイする |
このテンプレートを使用すると、試用版ライセンスを使用して、1 つのタコデプロイ 3.0 サーバーをデプロイできます。 これにより、単一の Windows Server 2012R2 VM (Standard D2) と SQL DB (S1 レベル) で、リソース グループに指定された場所にデプロイされます。 |
| Orchard CMS ビデオ ポータル Web アプリ |
このテンプレートは、Azure Media Services モジュールを有効にして構成したAzure App Service Web Appsに Orchard CMS を簡単にデプロイする方法を提供します。 |
| スケーラブルな Umbraco CMS Web アプリ |
このテンプレートは、Azure App Service Web Appsに umbraco CMS Web アプリを簡単にデプロイする方法を提供します。 |
| シンプルな Umbraco CMS Web アプリ |
このテンプレートは、Azure App Service Web Appsに umbraco CMS Web アプリを簡単にデプロイする方法を提供します。 |
| Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
小規模または大規模のエンタープライズ向けのクラウド導入では、クラウド デプロイから価値を引き出すために、責任ある効率的なガバナンス モデルが必要です。 CloudWise (ソリューションのコード名) は、Azure Partner QuickStarts から入手できる複合ソリューションであり、顧客、システム インテグレーター、パートナーの導入を可能にし、コストの最適化、アプリケーションの信頼性の向上、ビジネス リスクの削減に重点を置いた、セルフサービスで自動化されたガバナンスと運用ソリューションを提供します。 このソリューションでは、可視性と制御の主要なガバナンスの柱が強調されています。 |
| ILB ASE を使用した eShop Web サイト |
App Service 環境は、Azure App Service アプリを高スケールで安全に実行するための完全に分離された専用の環境を提供する Azure App Service の Premium サービス プラン オプションであり、Web Apps、Mobile Apps、API Apps が含まれています。 |
| Azure SQL プライベート エンドポイントを使用する WebApp |
このテンプレートは、Azure SQL Server を指すプライベート エンドポイントを使用する Web アプリを作成する方法を示しています |
| 高可用性を備えたリモート デスクトップ サービス |
この ARM テンプレート サンプル コードでは、高可用性を備えた リモート デスクトップ サービス 2019 セッション コレクション ラボをデプロイします。 目標は、Windows Server 2019 を使用して、リモート デスクトップ サービス用に完全冗長で高可用性のソリューションを展開することです。 |
| Azure アーキテクチャで Sports Analytics をデプロイする |
ADLS Gen 2 が有効な Azure ストレージ アカウント、ストレージ アカウント (デプロイされている場合はAzure SQL Database) のリンクされたサービスを持つAzure Data Factory インスタンス、および Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントに対するストレージ BLOB データ共同作成者ロールが付与されます。 また、Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミング ユース ケース用) をデプロイするオプションもあります。 Azure Key Vaultがデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に、Key Vault シークレット ユーザー ロールが付与されます。 |
| SQL Databaseを使用した Web アプリ、Azure Cosmos DB、Azure Search |
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。 |
| Azure DMS を使用してAzure SQL データベースに移行する |
Azure Database Migration Service (DMS) は、オンプレミス データベースを Azure に移行するプロセスを合理化するように設計されています。 DMS を使用すると、既存のオンプレミスのSQL Serverと Oracle データベースを、Azure 仮想マシンでデータベース、Azure SQL Managed Instance、または Microsoft SQL ServerをAzure SQLへの移行が簡略化されます。 このテンプレートでは、Azure Database Migration サービスのインスタンスをデプロイします。これは、SQL サーバーがインストールされている Azure VM であり、事前に作成されたデータベースを持つソース サーバーと、ソース サーバーからターゲット サーバーに移行するデータベースの事前に作成されたスキーマを持つターゲット Azure SQL DB サーバーとして機能します。 このテンプレートでは、ソース VM、DMS サービス、ターゲット サーバーをサポートするために必要なリソース (NIC、vnet など) もデプロイされます。 |
| VNET でのカスタム Ambari + Hive メタストア DB を使用した HDInsight |
このテンプレートを使用すると、カスタム Ambari DB と Hive メタストアの両方として機能する新しい SQL DB を使用して、既存の仮想ネットワークに HDInsight クラスターを作成できます。 既存の SQL サーバー、ストレージ アカウント、および VNET が必要です。 |
| HDInsight クラスターと SQL データベースをデプロイする |
このテンプレートを使用すると、SQoop をテストするための HDInsight クラスターとSQL Databaseを作成できます。 |
| プライベート エンドポイントの例 |
このテンプレートは、Azure SQL Server を指すプライベート エンドポイントを作成する方法を示しています |
| Event Hub に書き込まれた監査を使用したサーバーのAzure SQL |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、監査ログを Event Hub に書き込むことができます |
| Log Analytics に書き込まれた監査を使用したサーバーのAzure SQL |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、監査ログを Log Analytics (OMS ワークスペース) に書き込むことができます。 |
| Transparent Encryption を使用した専用 SQL プール |
Transparent Data Encryption を使用して、SQL Serverと専用 SQL プール (旧称 SQL DW) を作成します。 |
| SQL Serverとデータベースを作成する |
このテンプレートを使用すると、SQL Databaseとサーバーを作成できます。 |
| TDE を使用してSQL Databaseをプロビジョニングする |
このテンプレートは、Azure トラフィック用にファイアウォールを開いたSQL Serverと、Transparent Data Encryption (TDE) を使用した SQL データベースをプロビジョニングします。 |
| 新しい SQL エラスティック プールをデプロイする |
このテンプレートを使用すると、新しい関連付けられたSQL Serverとそれに割り当てる新しい SQL データベースを使用して、新しい SQL エラスティック プールをデプロイできます。 |
| フェールオーバー グループを使用してAzure SQL サーバーとデータベースを作成する |
2 つのAzure SQL サーバー、データベース、およびフェールオーバー グループを作成します。 |
| Azure SQL バックエンドでのApp Service Environment |
このテンプレートは、プライベート/分離環境で通常使用される関連付けられたリソースと共に、プライベート エンドポイントと共に、Azure SQL バックエンドを含むApp Service Environmentを作成します。 |
| SQL Databaseを使用してモバイル アプリをプロビジョニングする |
このテンプレートは、モバイル アプリ、SQL Database、および通知ハブをプロビジョニングします。 データベースと通知ハブのモバイル アプリで接続文字列を構成します。 |
| マネージド ID、SQL Server、ΑΙを使用した Web アプリ |
アプリ + データ + マネージド ID + 監視用の Azure インフラストラクチャをデプロイする簡単な例 |
| テンプレートを使用して Web アプリ + Redis Cache + SQL DB を作成する |
このテンプレートは、Redis キャッシュとSQL Databaseを使用して Azure Web アプリを作成します。 |
| SQL Databaseを使用して Web アプリをプロビジョニングする |
このテンプレートは、Web アプリ、SQL Database、自動スケーリング設定、アラート ルール、App Insights をプロビジョニングします。 データベースの Web アプリで接続文字列を構成します。 |
| Azure VM への Web アプリケーションの作成、構成、デプロイ |
SQL Azure データベースを使用して Windows VM を作成して構成し、PowerShell DSC を使用して Web アプリケーションを環境にデプロイする |
| Azure SQLを使用した Linux 上の Sonarqube Docker Web App |
このテンプレートは、公式の Sonarqube イメージを使用し、Azure SQL Server によってサポートされる、Azure App Service Web アプリ Linux コンテナーに Sonarqube をデプロイします。 |
Terraform (AzAPI プロバイダー) リソース定義
サーバー/データベース リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/databases リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/databases@2023-02-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
autoPauseDelay = int
availabilityZone = "string"
catalogCollation = "string"
collation = "string"
createMode = "string"
elasticPoolId = "string"
encryptionProtector = "string"
encryptionProtectorAutoRotation = bool
federatedClientId = "string"
freeLimitExhaustionBehavior = "string"
highAvailabilityReplicaCount = int
isLedgerOn = bool
keys = {
{customized property} = {}
}
licenseType = "string"
longTermRetentionBackupResourceId = "string"
maintenanceConfigurationId = "string"
manualCutover = bool
maxSizeBytes = int
minCapacity = "decimal-as-string"
performCutover = bool
preferredEnclaveType = "string"
readScale = "string"
recoverableDatabaseId = "string"
recoveryServicesRecoveryPointId = "string"
requestedBackupStorageRedundancy = "string"
restorableDroppedDatabaseId = "string"
restorePointInTime = "string"
sampleName = "string"
secondaryType = "string"
sourceDatabaseDeletionDate = "string"
sourceDatabaseId = "string"
sourceResourceId = "string"
useFreeLimit = bool
zoneRedundant = bool
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
プロパティ値
servers/databases
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Sql/servers/databases@2023-02-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 128 有効な文字: 次は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| location | リソースの場所。 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サーバー |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 |
| sku | データベース SKU。 SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation します。Azure CLI: az sql db list-editions -l {location} -o table Azure PowerShell: Get-AzSqlServerServiceObjective -Location {location} |
SKU |
| identity | データベースの Azure Active Directory ID。 | DatabaseIdentity |
| properties | リソースのプロパティ。 | DatabaseProperties |
DatabaseIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類 | "UserAssigned" |
| identity_ids | 使用するユーザー割り当て ID のリソース ID | ユーザー ID ID の配列。 |
DatabaseIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseUserIdentity |
DatabaseUserIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DatabaseProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoPauseDelay | データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します | INT |
| availabilityZone | データベースがピン留めされる可用性ゾーンを指定します。 | "1" "2" "3" "NoPreference" |
| catalogCollation | メタデータ カタログの照合順序。 | "DATABASE_DEFAULT" "SQL_Latin1_General_CP1_CI_AS" |
| 照合順序 (collation) | データベースの照合順序。 | 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 はサポートされていません。 |
"コピー" "Default" "OnlineSecondary" "PointInTimeRestore" "Recovery" "復元" "RestoreExternalBackup" "RestoreExternalBackupSecondary" "RestoreLongTermRetentionBackup" "Secondary" |
| elasticPoolId | このデータベースを含むエラスティック プールのリソース識別子。 | string |
| encryptionProtector | データベースカスタマー マネージド キーごとに構成されている場合の、データベースの Azure キー コンテナー URI。 | string |
| encryptionProtectorAutoRotation | データベース暗号化保護機能 AKV キーの自動ローテーションを有効または無効にするフラグ。 | [bool] |
| federatedClientId | データベース CMK ごとのテナント間シナリオに使用されるクライアント ID | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 空きデータベースの月次空き制限が使い果たされた場合の動作を指定します。 AutoPause: 月の残りの期間の空き制限が使い果たされると、データベースは自動的に一時停止されます。 BillForUsage: データベースは空き制限を使い果たした時点で引き続きオンラインになり、超過分は課金されます。 |
"AutoPause" "BillOverUsage" |
| highAvailabilityReplicaCount | 高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。 | INT |
| isLedgerOn | このデータベースが台帳データベースかどうか。つまり、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースが作成された後は変更できません。 | [bool] |
| キー | 使用するユーザー割り当て ID のリソース ID | DatabasePropertiesKeys |
| licenseType | このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスを持っていて、Azure ハイブリッド特典の資格がある場合は 。 |
"BasePrice" "LicenseIncluded" |
| longTermRetentionBackupResourceId | このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。 | string |
| maintenanceConfigurationId | データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 | string |
| manualCutover | Hyperscale レベルへのデータベースの更新操作中に、顧客が制御する手動カットオーバーを実行する必要があるかどうか。 このプロパティは、データベースを Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルにスケーリングする場合にのみ適用されます。 manualCutover を指定すると、ユーザー入力が Hyperscale データベースへのカットオーバーをトリガーするまでスケーリング操作が待機します。 カットオーバーをトリガーするには、スケーリング操作が待機中状態の場合は、'performCutover' パラメーターを指定してください。 |
[bool] |
| maxSizeBytes | バイト単位で表されるデータベースの最大サイズ。 | INT |
| minCapacity | 一時停止していない場合、データベースが常に割り当てる最小容量 文字列として 10 進値を指定します。 | int または json decimal |
| performCutover | スケーリング操作の進行中に待機状態の間に、顧客が制御する手動カットオーバーをトリガーします。 このプロパティ パラメーターは、'manualCutover' パラメーターと共に開始されるスケーリング操作にのみ適用されます。 このプロパティは、Business Critical/General Purpose/Premium/Standard レベルから Hyperscale レベルへのデータベースのスケーリングが既に進行中の場合にのみ適用されます。 performCutover を指定すると、スケーリング操作によってカットオーバーがトリガーされ、Hyperscale データベースへのロール変更が実行されます。 |
[bool] |
| preferredEnclaveType | データベースで要求されたエンクレーブの種類 (Default または VBS エンクレーブ)。 | "Default" "VBS" |
| readScale | 読み取り専用ルーティングの状態。 有効にすると、アプリケーションインテントが接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。 | "無効" "有効" |
| recoverableDatabaseId | このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。 | string |
| recoveryServicesRecoveryPointId | このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。 | string |
| requestedBackupStorageRedundancy | このデータベースのバックアップを格納するために使用するストレージ アカウントの種類。 | "Geo" "GeoZone" "Local" "Zone" |
| restorableDroppedDatabaseId | このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。 | string |
| restorePointInTime | 新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。 | string |
| sampleName | このデータベースの作成時に適用するサンプル スキーマの名前。 | "AdventureWorksLT" "WideWorldImportersFull" "WideWorldImportersStd" |
| secondaryType | データベースがセカンダリの場合は、セカンダリ型。 有効な値は Geo、名前付き、スタンバイです。 | "Geo" "Named" "Standby" |
| sourceDatabaseDeletionDate | データベースが削除された時刻を指定します。 | string |
| sourceDatabaseId | このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。 | 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" ヘッダーの詳細については、「/azure/azure-resource-manager/management/authenticate-multi-tenant」を参照してください。 |
string |
| useFreeLimit | データベースで無料の月次制限を使用するかどうか。 サブスクリプション内の 1 つのデータベースで許可されます。 | [bool] |
| zoneRedundant | このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。 | [bool] |
DatabasePropertiesKeys
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | DatabaseKey |
DatabaseKey
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | 特定の SKU の容量。 | INT |
| family | 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 | string |
| name | SKU の名前 。通常は、文字 + 数値コード (P3 など)。 | string (必須) |
| size | 特定の SKU のサイズ | string |
| レベル | 特定の SKU のレベルまたはエディション (Basic、Premium など)。 | string |