你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzSqlServer

模块:: Az.Sql Module

修改 SQL 数据库服务器的属性。

语法

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 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 服务器上重置管理员密码。

示例 2：修改 SQL 数据库服务器的属性。 (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
别名:	cf

参数集

(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 时指定服务器的联合客户端 ID，如果不打算使用跨租户 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 Key Vault 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） ID。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-PublicNetworkAccess

采用一个标志（已启用/禁用）以指定是否允许对服务器的公用网络访问。禁用后，只有通过专用链接建立的连接才能访问此服务器。

参数属性

类型:	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
别名:	Name

参数集

(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=“value2”}

参数属性

类型:	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 （默认值）

说明

示例

示例 1：重置管理员密码

示例 2：修改 SQL 数据库服务器的属性。 (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

相关链接

反馈