Set-AzSqlServer

模組:: Az.Sql Module

修改 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>]

Description

Set-AzSqlServer Cmdlet 會修改 Azure SQL 資料庫伺服器的屬性。

範例

範例 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 Server 上的系統管理員密碼。

範例 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

此命令會在名為 server01 的 Azure SQL Server 上啟用虛刪除保留，預設保留期間為 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

為此伺服器產生並指派 Microsoft Entra 身分識別，以與金鑰管理服務搭配使用（例如 Azure KeyVault）。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	參見

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DefaultProfile

用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶

參數屬性

類型:	IAzureContextContainer
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzContext, AzureRmContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-EnableSoftDelete

布林值，用於是否要啟用伺服器的虛刪除，以便在卸除之後，伺服器可以還原預設值 7 天。如果您想要指定不同的保留期間，請使用 SoftDeleteRetentionDays 參數。

參數屬性

類型:	Boolean
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FederatedClientId

指定使用跨租用戶 CMK 時伺服器的同盟用戶端識別碼，如果您不打算使用跨租用戶 CMK，請勿設定此值

參數屬性

類型:	Nullable<T>[Guid]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Force

強制命令執行，而不要求使用者確認。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-IdentityType

要指派給伺服器的身分類型。可能的值為 SystemAssigned、UserAssigned、'SystemAssigned、UserAssigned' 和 None。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-KeyId

用於加密的 Azure 金鑰保存庫 URI。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-MinimalTlsVersion

要強制執行 Sql Server 的最低 TLS 版本

參數屬性

類型:	String
預設值:	None
接受的值:	None, 1.0, 1.1, 1.2
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-PrimaryUserAssignedIdentityId

主要使用者受控識別（UMI）識別碼。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-PublicNetworkAccess

採用啟用/停用的旗標，以指定是否允許對伺服器的公用網路存取。停用時，只有透過 Private Links 建立的連線才能連線到此伺服器。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceGroupName

指定指派伺服器的資源群組名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RestrictOutboundNetworkAccess

啟用時，只有輸出防火牆規則允許的輸出連線才會成功。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ServerName

指定此 Cmdlet 修改的伺服器名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	名稱

參數集

(All)

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ServerVersion

指定此 Cmdlet 將伺服器變更為的版本。此參數的可接受值為：2.0 和 12.0。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SoftDeleteRetentionDays

伺服器虛刪除保留天數的值，讓伺服器可以在卸除之後還原指定的天數。只有有效的值介於 0-35 之間。如果設定為 0，則會停用虛刪除保留。

參數屬性

類型:	Nullable<T>[Int32]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SqlAdministratorPassword

為資料庫伺服器管理者指定新密碼（ 作為 SecureString）。若要取得 SecureString，請使用 Get-Credential Cmdlet。如需詳細資訊，請鍵入 Get-Help ConvertTo-SecureString。

參數屬性

類型:	SecureString
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Tags

指定此 Cmdlet 與伺服器相關聯的標籤字典。雜湊表形式的鍵值對，在伺服器上設定為標籤。例如：@{key0=“value0”;key1=$null;key2=“值2”}

參數屬性

類型:	Hashtable
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	標記

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UserAssignedIdentityId

使用者指派的身分清單。

參數屬性

類型:	List<T>[String]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	威斯康辛

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

共用方式為

Set-AzSqlServer

語法

Default (預設值)

Description

範例

範例 1：重設管理員密碼

範例 2：修改 SQL Database 伺服器的屬性。 (autogenerated)

範例 3：啟用伺服器的虛刪除保留 （預設為 7 天）

範例 4：停用伺服器的虛刪除保留

參數

-AssignIdentity

參數屬性

參數集

-Confirm

參數屬性

參數集

-DefaultProfile

參數屬性

參數集

-EnableSoftDelete

參數屬性

參數集

-FederatedClientId

參數屬性

參數集

-Force

參數屬性

參數集

-IdentityType

參數屬性

參數集

-KeyId

參數屬性

參數集

-MinimalTlsVersion

參數屬性

參數集

-PrimaryUserAssignedIdentityId

參數屬性

參數集

-PublicNetworkAccess

參數屬性

參數集

-ResourceGroupName

參數屬性

參數集

-RestrictOutboundNetworkAccess

參數屬性

參數集

-ServerName

參數屬性

參數集

-ServerVersion

參數屬性

參數集

-SoftDeleteRetentionDays

參數屬性

參數集

-SqlAdministratorPassword

參數屬性

參數集

-Tags

參數屬性

參數集

-UserAssignedIdentityId

參數屬性

參數集

-WhatIf

參數屬性

參數集

CommonParameters

輸入

String

輸出

AzureSqlServerModel

相關連結

意見反應

範例 3：啟用伺服器的虛刪除保留（預設為 7 天）