Set-AzSqlServer

  • リファレンス
モジュール:
Az.Sql

SQL Database サーバーのプロパティを変更します。

構文

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>]
   [-Force]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzSqlServer コマンドレットは、Azure SQL Database サーバーのプロパティを変更します。

例

例 1: 管理者パスワードをリセットする

$ServerPassword = "newpassword"
$SecureString = ConvertTo-SecureString $ServerPassword -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 サーバーのプロパティを変更します。 (自動生成)

Set-AzSqlServer -AssignIdentity -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01'

パラメーター

-AssignIdentity

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

Type:SwitchParameter
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

-DefaultProfile

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

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

-FederatedClientId

クロステナント CMK を使用するときにサーバーのフェデレーション クライアント ID を指定します。テナント間 CMK を使用しない場合は、この値を設定しないでください

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

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

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

-IdentityType

サーバーに割り当てる ID の種類。 指定できる値は、SystemAsssigned、UserAssigned、'SystemAssigned、UserAssigned' 、None です。

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

-KeyId

暗号化に使用される Azure Key Vault URI。

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

-MinimalTlsVersion

Sql Server に適用する最小 TLS バージョン

Type:String
Accepted values:None, 1.0, 1.1, 1.2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PrimaryUserAssignedIdentityId

プライマリ ユーザー マネージド ID (UMI) です。

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

-PublicNetworkAccess

サーバーへのパブリック ネットワーク アクセスを許可するかどうかを指定するフラグを有効または無効にします。 無効にすると、プライベート リンクを介して行われた接続のみがこのサーバーに到達できます。

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

-RestrictOutboundNetworkAccess

有効にすると、送信ファイアウォール規則によって許可される送信接続のみが成功します。

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

-ServerName

このコマンドレットが変更するサーバーの名前を指定します。

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

-ServerVersion

このコマンドレットがサーバーを変更するバージョンを指定します。 このパラメーターに使用できる値は 2.0 と 12.0 です。

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

-SqlAdministratorPassword

データベース サーバー管理者の新しいパスワードを SecureString として指定します。 SecureString を取得するには、Get-Credential コマンドレットを使用します。 詳細を表示するには「Get-Help ConvertTo-SecureString」を入力します。

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-UserAssignedIdentityId

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

Type:List<T>[String]
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

入力

String

出力

AzureSqlServerModel