Set-AzSqlDatabase
データベースのプロパティを設定するか、既存のデータベースをエラスティック プールに移動します。
構文
Set-AzSqlDatabase
[-DatabaseName] <String>
[-MaxSizeBytes <Int64>]
[-Edition <String>]
[-RequestedServiceObjectiveName <String>]
[-ElasticPoolName <String>]
[-ReadScale <DatabaseReadScale>]
[-Tags <Hashtable>]
[-ZoneRedundant]
[-AsJob]
[-LicenseType <String>]
[-ComputeModel <String>]
[-AutoPauseDelayInMinutes <Int32>]
[-MinimumCapacity <Double>]
[-HighAvailabilityReplicaCount <Int32>]
[-BackupStorageRedundancy <String>]
[-SecondaryType <String>]
[-MaintenanceConfigurationId <String>]
[-AssignIdentity]
[-EncryptionProtector <String>]
[-UserAssignedIdentityId <String[]>]
[-KeyList <String[]>]
[-KeysToRemove <String[]>]
[-FederatedClientId <Guid>]
[-PreferredEnclaveType <String>]
[-EncryptionProtectorAutoRotation]
[-UseFreeLimit]
[-FreeLimitExhaustionBehavior <String>]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSqlDatabase
[-DatabaseName] <String>
[-MaxSizeBytes <Int64>]
[-Edition <String>]
[-ReadScale <DatabaseReadScale>]
[-Tags <Hashtable>]
[-ZoneRedundant]
[-AsJob]
[-VCore <Int32>]
[-ComputeGeneration <String>]
[-LicenseType <String>]
[-ComputeModel <String>]
[-AutoPauseDelayInMinutes <Int32>]
[-MinimumCapacity <Double>]
[-HighAvailabilityReplicaCount <Int32>]
[-BackupStorageRedundancy <String>]
[-SecondaryType <String>]
[-MaintenanceConfigurationId <String>]
[-AssignIdentity]
[-EncryptionProtector <String>]
[-UserAssignedIdentityId <String[]>]
[-KeyList <String[]>]
[-KeysToRemove <String[]>]
[-FederatedClientId <Guid>]
[-PreferredEnclaveType <String>]
[-EncryptionProtectorAutoRotation]
[-UseFreeLimit]
[-FreeLimitExhaustionBehavior <String>]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSqlDatabase
[-DatabaseName] <String>
-NewName <String>
[-AsJob]
[-BackupStorageRedundancy <String>]
[-SecondaryType <String>]
[-MaintenanceConfigurationId <String>]
[-AssignIdentity]
[-EncryptionProtector <String>]
[-UserAssignedIdentityId <String[]>]
[-KeyList <String[]>]
[-KeysToRemove <String[]>]
[-FederatedClientId <Guid>]
[-PreferredEnclaveType <String>]
[-EncryptionProtectorAutoRotation]
[-UseFreeLimit]
[-FreeLimitExhaustionBehavior <String>]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzSqlDatabase コマンドレットは、Azure SQL Database のデータベースのプロパティを設定します。 このコマンドレットは、データベースのサービス レベル (エディション)、パフォーマンス レベル (RequestedServiceObjectiveName)、およびストレージの最大サイズ (MaxSizeBytes) を変更できます。 さらに、ElasticPoolName パラメーターを指定して、データベースをエラスティック プールに移動できます。 データベースが既にエラスティック プール内にある場合は、RequestedServiceObjectiveName パラメーターを使用して、エラスティック プールから単一データベースのパフォーマンス レベルにデータベースを移動できます。
例
例 1: データベースを Standard S0 データベースに更新する
Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "Standard" -RequestedServiceObjectiveName "S0"
ResourceGroupName : ResourceGroup01
ServerName : Server01
DatabaseName : Database01
Location : Central US
DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition : Standard
CollationName : SQL_Latin1_General_CP1_CI_AS
CatalogCollation :
MaxSizeBytes : 268435456000
Status : Online
CreationDate : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7
CurrentServiceObjectiveName : S0
RequestedServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7
RequestedServiceObjectiveName :
ElasticPoolName :
EarliestRestoreDate :
Tags :このコマンドは、Database01 という名前のデータベースを、Server01 という名前のサーバー上の Standard S0 データベースに更新します。
例 2: エラスティック プールにデータベースを追加する
Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -ElasticPoolName "ElasticPool01"
ResourceGroupName : ResourceGroup01
ServerName : Server01
DatabaseName : Database01
Location : Central US
DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition : Standard
CollationName : SQL_Latin1_General_CP1_CI_AS
CatalogCollation :
MaxSizeBytes : 268435456000
Status : Online
CreationDate : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419
CurrentServiceObjectiveName : ElasticPool
RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419
RequestedServiceObjectiveName :
ElasticPoolName : elasticpool01
EarliestRestoreDate :
Tags :このコマンドは、Server01 という名前のサーバーでホストされている ElasticPool01 という名前のエラスティック プールに Database01 という名前のデータベースを追加します。
例 3: データベースのストレージの最大サイズを変更する
Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -MaxSizeBytes 1099511627776
ResourceGroupName : ResourceGroup01
ServerName : Server01
DatabaseName : Database01
Location : Central US
DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition : Standard
CollationName : SQL_Latin1_General_CP1_CI_AS
CatalogCollation :
MaxSizeBytes : 1099511627776
Status : Online
CreationDate : 8/24/2017 9:00:37 AM
CurrentServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40
CurrentServiceObjectiveName : S3
RequestedServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40
RequestedServiceObjectiveName :
ElasticPoolName :
EarliestRestoreDate :
Tags :このコマンドは、Database01 という名前のデータベースを更新して、最大サイズを 1 TB (テラバイト)に設定します。
例 4: 既存の General Purpose データベースを Hyperscale サービス レベルに更新する
Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "Hyperscale" -RequestedServiceObjectiveName "HS_Gen5_2"
ResourceGroupName : ResourceGroup01
ServerName : Server01
DatabaseName : Database01
Location : Central US
DatabaseId : 56246136-839f-4171-80af-4c28142463b1
Edition : Hyperscale
CollationName : SQL_Latin1_General_CP1_CI_AS
CatalogCollation :
MaxSizeBytes : -1
Status : Online
CreationDate : 12/6/2020 5:34:16 PM
CurrentServiceObjectiveId : 00000000-0000-0000-0000-000000000000
CurrentServiceObjectiveName : HS_Gen5_2
RequestedServiceObjectiveName : HS_Gen5_2
RequestedServiceObjectiveId :
ElasticPoolName :
EarliestRestoreDate : 12/6/2020 5:34:16 PM
Tags : {}
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/servers/Server01/databases/Database01
CreateMode :
ReadScale : Enabled
ZoneRedundant :
Capacity : 2
Family : Gen5
SkuName : HS_Gen5
LicenseType : LicenseIncluded
AutoPauseDelayInMinutes :
MinimumCapacity :
ReadReplicaCount : 1
BackupStorageRedundancy : Geoこのコマンドは、Database01 という名前のデータベースを General Purpose から Hyperscale サービス レベルに更新します。
例 5: データベースの優先エンクレーブの種類を VBS に更新する
Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -PreferredEnclaveType "VBS"
ResourceGroupName : ResourceGroup01
ServerName : Server01
DatabaseName : Database01
Location : Central US
DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition : Standard
CollationName : SQL_Latin1_General_CP1_CI_AS
CatalogCollation :
MaxSizeBytes : 1099511627776
Status : Online
CreationDate : 8/24/2017 9:00:37 AM
CurrentServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40
CurrentServiceObjectiveName : S3
RequestedServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40
PreferredEnclaveType : VBS
RequestedServiceObjectiveName :
ElasticPoolName :
EarliestRestoreDate :
Tags :このコマンドは、データベースを更新して VBS エンクレーブを構成します
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AssignIdentity
Azure KeyVault などのキー管理サービスで使用するために、このデータベースの Microsoft Entra ID を生成して割り当てます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AutoPauseDelayInMinutes
データベースの自動一時停止遅延 (サーバーレスのみ)、-1 (オプトアウト)
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupStorageRedundancy
SQL Database のバックアップを格納するために使用されるバックアップ ストレージの冗長性。 オプションは、Local、Zone、Geo、GeoZone です。 データベースの各エディションでサポートされるオプションについては、「Get-AzSqlCapability」を参照してください。
| Type: | String |
| Accepted values: | Local, Zone, Geo, GeoZone |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputeGeneration
割り当てるコンピューティング世代。
| Type: | String |
| Aliases: | Family |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputeModel
Azure Sql データベースの計算モデル。 サーバーレスまたはプロビジョニング済み
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseName
データベースの名前を指定します。
| Type: | String |
| Aliases: | Name |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Edition
データベースのエディションを指定します。 このパラメーターの有効値は、次のとおりです。
- なし
- Basic
- Standard
- Premium
- DataWarehouse
- Free
- Stretch
- GeneralPurpose
- Hyperscale
- BusinessCritical
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ElasticPoolName
データベースを移動するエラスティック プールの名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionProtector
SQL Database の暗号化保護機能キー。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionProtectorAutoRotation
AKV キーの自動ローテーションの状態
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FederatedClientId
SQL Database のフェデレーション クライアント ID。 これは、テナント間の CMK シナリオに使用されます。
| Type: | Nullable<T>[Guid] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FreeLimitExhaustionBehavior
空き制限データベースの枯渇動作。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HighAvailabilityReplicaCount
データベースに関連付けられている読み取りonly セカンダリ レプリカの数。 Hyperscale エディションの場合のみ。
| Type: | Int32 |
| Aliases: | ReadReplicaCount |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyList
SQL Database の AKV キーの一覧。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeysToRemove
SQL Database から削除する AKV キーの一覧。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseType
Azure Sql データベースのライセンスの種類。 次のいずれかの値になります。
- BasePrice - 既存の SQL Server ライセンス所有者の Azure ハイブリッド特典 (AHB) 割引価格が適用されます。 データベースの価格は、既存の SQL Server ライセンス所有者に対して割引されます。
- LicenseIncluded - 既存の SQL Server ライセンス所有者のAzure ハイブリッド特典 (AHB) 割引価格は適用されません。 データベースの価格には、新しい SQL Server ライセンス コストが含まれます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaintenanceConfigurationId
SQL Database のメンテナンス構成 ID。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxSizeBytes
Azure SQL Database の最大サイズ (バイト単位)。
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumCapacity
一時停止されていない場合、データベースが常に割り当てる最小容量。 サーバーレス Azure Sql データベースの場合のみ。
| Type: | Double |
| Aliases: | MinVCore, MinCapacity |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewName
データベースの名前を変更する新しい名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreferredEnclaveType
Azure Sql データベースに推奨されるエンクレーブの種類。 使用できる値は Default と VBS です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReadScale
有効にすると、アプリケーションインテントが接続文字列で読み取り専用に設定されている接続は、読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 このプロパティは、プレミアム および Business Critical データベースでのみ設定できます。
| Type: | DatabaseReadScale |
| Accepted values: | Disabled, Enabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequestedServiceObjectiveName
データベースに割り当てるサービス目標の名前を指定します。 サービス目標の詳細については、 Microsoft 開発者ネットワーク ライブラリの「Azure SQL Database サービス レベルとパフォーマンス レベル 」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
サーバーが割り当てられているリソース グループの名前を指定します。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SecondaryType
データベースがセカンダリの場合は、そのセカンダリ の種類。 有効な値は Geo と Named です。
| Type: | String |
| Accepted values: | Named, Geo |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerName
データベースをホストするサーバーの名前を指定します。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tags
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
| Type: | Hashtable |
| Aliases: | Tag |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseFreeLimit
このデータベースには空き制限を使用します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityId
SQL Database のユーザー割り当て ID の一覧。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VCore
Azure Sql データベースの仮想コア番号
| Type: | Int32 |
| Aliases: | Capacity, MaxVCore, MaxCapacity |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ZoneRedundant
Azure Sql Database に関連付けるゾーン冗長性
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
出力
関連リンク
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示