Set-AzSqlDatabase

リファレンス

モジュール:: Az.Sql

データベースのプロパティを設定するか、既存のデータベースをエラスティックプールに移動します。

構文

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 <System.Collections.Generic.List`1[System.String]>]
   [-KeyList <System.Collections.Generic.List`1[System.String]>]
   [-KeysToRemove <System.Collections.Generic.List`1[System.String]>]
   [-FederatedClientId <Guid>]
   [-PreferredEnclaveType <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 <System.Collections.Generic.List`1[System.String]>]
   [-KeyList <System.Collections.Generic.List`1[System.String]>]
   [-KeysToRemove <System.Collections.Generic.List`1[System.String]>]
   [-FederatedClientId <Guid>]
   [-PreferredEnclaveType <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 <System.Collections.Generic.List`1[System.String]>]
   [-KeyList <System.Collections.Generic.List`1[System.String]>]
   [-KeysToRemove <System.Collections.Generic.List`1[System.String]>]
   [-FederatedClientId <Guid>]
   [-PreferredEnclaveType <String>]
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzSqlDatabase コマンドレットは、Azure SQL Database 内のデータベースのプロパティを設定します。このコマンドレットは、データベースのサービスレベル (Edition)、パフォーマンスレベル (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
Accept pipeline input:	False
Accept wildcard characters:	False

-AssignIdentity

Azure KeyVault などのキー管理サービスで使用するために、このデータベースの Azure Active Directory ID を生成して割り当てます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoPauseDelayInMinutes

データベース (サーバーレスのみ)、-1 がオプトアウトされるまでの自動一時停止遅延 (分単位)

Type:	Int32
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputeGeneration

割り当てるコンピューティングの生成。

Type:	String
Aliases:	Family
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputeModel

Azure Sql データベースの計算モデル。サーバーレスまたはプロビジョニング済み

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

データベースの名前を指定します。

Type:	String
Aliases:	Name
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Edition

データベースのエディションを指定します。このパラメーターの有効値は、次のとおりです。

なし
Basic
Standard
Premium
DataWarehouse
Free
Stretch
GeneralPurpose
ハイパースケール
BusinessCritical

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ElasticPoolName

データベースを移動するエラスティックプールの名前を指定します。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionProtector

SQL Databaseの暗号化保護機能キー。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-FederatedClientId

SQL Databaseのフェデレーションクライアント ID。これは、テナント間 CMK シナリオに使用されます。

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-HighAvailabilityReplicaCount

データベースに関連付けられている読み取り専用セカンダリレプリカの数。 Hyperscale エディションの場合のみ。

Type:	Int32
Aliases:	ReadReplicaCount
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyList

SQL Databaseの AKV キーの一覧。

Type:	List<T>[String]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeysToRemove

SQL Databaseから削除する AKV キーの一覧。

Type:	List<T>[String]
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-MaintenanceConfigurationId

SQL Databaseのメンテナンス構成 ID。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxSizeBytes

Azure SQL Database の最大サイズ (バイト単位)。

Type:	Int64
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-MinimumCapacity

一時停止されていない場合は、データベースが常に割り当てる最小容量。サーバーレス Azure Sql データベースの場合のみ。

Type:	Double
Aliases:	MinVCore, MinCapacity
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NewName

データベースの名前を変更する新しい名前。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PreferredEnclaveType

Azure Sql データベースに推奨されるエンクレーブの種類。使用できる値は Default と VBS です。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ReadScale

有効にすると、アプリケーションインテントが接続文字列で読み取り専用に設定されている接続は、読み取り専用セカンダリレプリカにルーティングされる可能性があります。このプロパティは、Premium および Business Critical データベースでのみ設定できます。

Type:	DatabaseReadScale
Accepted values:	Disabled, Enabled
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-RequestedServiceObjectiveName

データベースに割り当てるサービス目標の名前を指定します。サービス目標の詳細については、Microsoft Developer Network Library の「Azure SQL Database サービスレベルとパフォーマンスレベル」を参照してください。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

サーバーが割り当てられているリソースグループの名前を指定します。

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-SecondaryType

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

Type:	String
Accepted values:	Named, Geo
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerName

データベースをホストするサーバーの名前を指定します。

Type:	String
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Tags

ハッシュテーブルの形式のキーと値のペア。例: @{key0="value0";key1=$null;key2="value2"}

Type:	Hashtable
Aliases:	Tag
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentityId

SQL Databaseのユーザー割り当て ID の一覧。

Type:	List<T>[String]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-VCore

Azure Sql データベースの仮想コア番号

Type:	Int32
Aliases:	Capacity, MaxVCore, MaxCapacity
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ZoneRedundant

Azure Sql Database に関連付けるゾーン冗長

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

出力

AzureSqlDatabaseModel