Set-AzSqlServer
SQL Database サーバーのプロパティを変更します。
構文
Default (既定)
Set-AzSqlServer
[-ServerName] <String>
[-SqlAdministratorPassword <SecureString>]
[-Tags <Hashtable>]
[-ServerVersion <String>]
[-AssignIdentity]
[-PublicNetworkAccess <String>]
[-RestrictOutboundNetworkAccess <String>]
[-MinimalTlsVersion <String>]
[-PrimaryUserAssignedIdentityId <String>]
[-KeyId <String>]
[-FederatedClientId <Guid>]
[-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
[-IdentityType <String>]
[-EnableSoftDelete <Boolean>]
[-SoftDeleteRetentionDays <Int32>]
[-Force]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzSqlServer コマンドレットは、Azure SQL Database サーバーのプロパティを変更します。
例
例 1: 管理者パスワードをリセットする
$SecureString = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SqlAdministratorPassword $secureString
ResourceGroupName : ResourceGroup01
ServerName : Server01
Location : Australia East
SqlAdministratorLogin : adminLogin
SqlAdministratorPassword :
ServerVersion : 12.0
Tags :
Identity :
FullyQualifiedDomainName : server01.database.windows.net
このコマンドは、server01 という名前の AzureSQL サーバーの管理者パスワードをリセットします。
例 2: SQL Database サーバーのプロパティを変更します。 (autogenerated)
Set-AzSqlServer -AssignIdentity -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01'
例 3: サーバーの論理的な削除リテンション期間を有効にする (既定の 7 日間)
Set-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EnableSoftDelete $true
ResourceGroupName : ResourceGroup01
ServerName : Server01
Location : centralus
SqlAdministratorLogin : SqlAdminUser
SqlAdministratorPassword :
ServerVersion : 12.0
Tags :
Identity :
FullyQualifiedDomainName : Server01.database.windows.net
MinimalTlsVersion : 1.2
PublicNetworkAccess : Enabled
RestrictOutboundNetworkAccess : Disabled
Administrators :
PrimaryUserAssignedIdentityId :
KeyId :
FederatedClientId :
SoftDeleteRetentionDays : 7
このコマンドを使用すると、Azure SQL Server の名前付き server01 での論理的な削除リテンション期間が有効になり、既定の保持期間は 7 日になります。 保持期間をカスタマイズするには、SoftDeleteRetentionDays パラメーターを使用します。
例 4: サーバーの論理的な削除の保持を無効にする
Set-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EnableSoftDelete $false -SoftDeleteRetentionDays 0
ResourceGroupName : ResourceGroup01
ServerName : Server01
Location : centralus
SqlAdministratorLogin : SqlAdminUser
SqlAdministratorPassword :
ServerVersion : 12.0
Tags :
Identity :
FullyQualifiedDomainName : Server01.database.windows.net
MinimalTlsVersion : 1.2
PublicNetworkAccess : Enabled
RestrictOutboundNetworkAccess : Disabled
Administrators :
PrimaryUserAssignedIdentityId :
KeyId :
FederatedClientId :
SoftDeleteRetentionDays : 0
このコマンドを実行すると、Server01 という名前の Azure SQL Server での論理的な削除リテンション期間が無効になります。
パラメーター
-AssignIdentity
Azure KeyVault などのキー管理サービスで使用するために、このサーバーの Microsoft Entra ID を生成して割り当てます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EnableSoftDelete
サーバーの論理的な削除を有効にするかどうかを示すブール値。サーバーは、削除後 7 日間の既定値で復元できます。 別の保持期間を指定する場合は、SoftDeleteRetentionDays パラメーターを使用します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FederatedClientId
クロステナント CMK を使用するときにサーバーのフェデレーション クライアント ID を指定します。テナント間 CMK を使用しない場合は、この値を設定しないでください
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IdentityType
サーバーに割り当てる ID の種類。 指定できる値は、SystemAssigned、UserAssigned、'SystemAssigned、UserAssigned' および None です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-KeyId
暗号化に使用される Azure Key Vault URI。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MinimalTlsVersion
Sql Server に適用する最小 TLS バージョン
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| 指定可能な値: | None, 1.0, 1.1, 1.2 |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PrimaryUserAssignedIdentityId
プライマリ ユーザー マネージド ID (UMI) です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PublicNetworkAccess
サーバーへのパブリック ネットワーク アクセスを許可するかどうかを指定するフラグを有効または無効にします。
無効にすると、プライベート リンクを介して行われた接続のみがこのサーバーに到達できます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
サーバーが割り当てられているリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RestrictOutboundNetworkAccess
有効にすると、送信ファイアウォール規則によって許可される送信接続のみが成功します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServerName
このコマンドレットが変更するサーバーの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | 名前 |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ServerVersion
このコマンドレットがサーバーを変更するバージョンを指定します。 このパラメーターに使用できる値は 2.0 と 12.0 です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SoftDeleteRetentionDays
削除後の指定した日数だけサーバーを復元できるように、サーバーの論理的な削除リテンション期間の値。 有効な値のみが 0 から 35 です。 0 に設定すると、論理的な削除の保持は無効になります。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SqlAdministratorPassword
データベース サーバー管理者の新しいパスワードを SecureString として指定します。
SecureString を取得するには、Get-Credential コマンドレットを使用します。 詳細については、「 Get-Help ConvertTo-SecureString」と入力します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
このコマンドレットがサーバーに関連付けるタグのディクショナリを指定します。 サーバー上のタグとして設定されたハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | タグ |
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UserAssignedIdentityId
ユーザー割り当て ID の一覧。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
