Update-AzMySqlServer
Updates an existing server.
The request body can contain one to many of the properties present in the normal server definition.
Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
Syntax
UpdateExpanded (Default)
Update-AzMySqlServer
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AdministratorLoginPassword <SecureString>]
[-ReplicationRole <String>]
[-SkuCapacity <Int32>]
[-SkuFamily <String>]
[-Sku <String>]
[-SkuTier <SkuTier>]
[-SslEnforcement <SslEnforcementEnum>]
[-MinimalTlsVersion <MinimalTlsVersionEnum>]
[-BackupRetentionDay <Int32>]
[-StorageAutogrow <StorageAutogrow>]
[-StorageInMb <Int32>]
[-Tag <Hashtable>]
[-PublicNetworkAccess <PublicNetworkAccessEnum>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzMySqlServer
-InputObject <IMySqlIdentity>
[-AdministratorLoginPassword <SecureString>]
[-ReplicationRole <String>]
[-SkuCapacity <Int32>]
[-SkuFamily <String>]
[-Sku <String>]
[-SkuTier <SkuTier>]
[-SslEnforcement <SslEnforcementEnum>]
[-MinimalTlsVersion <MinimalTlsVersionEnum>]
[-BackupRetentionDay <Int32>]
[-StorageAutogrow <StorageAutogrow>]
[-StorageInMb <Int32>]
[-Tag <Hashtable>]
[-PublicNetworkAccess <PublicNetworkAccessEnum>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates an existing server.
The request body can contain one to many of the properties present in the normal server definition.
Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
Examples
Example 1: Update MySql server by resource group and server name
Update-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -SslEnforcement Disabled
Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement
---- -------- ------------------ ------- ----------------------- ------- ------- --------------
mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Disabled
This cmdlet updates MySql server by resource group and server name.
Example 2: Update MySql server by identity.
Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Update-AzMySqlServer -BackupRetentionDay 23 -StorageInMb 10240
Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement
---- -------- ------------------ ------- ----------------------- ------- ------- --------------
mysql-test eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled
This cmdlet updates MySql server by identity.
Parameters
-AdministratorLoginPassword
The password of the administrator login.
Parameter properties
Type: SecureString
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AsJob
Run the command as a job.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-BackupRetentionDay
Backup retention days for the server.
Day count is between 7 and 35.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: cf
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Identity Parameter.
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: IMySqlIdentity
Default value: None
Supports wildcards: False
DontShow: False
UpdateViaIdentityExpanded
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-MinimalTlsVersion
Set the minimal TLS version for connections to server when SSL is enabled.
Default is TLSEnforcementDisabled.accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Name
The name of the server.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: ServerName
Parameter sets
UpdateExpanded
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-NoWait
Run the command asynchronously.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-PublicNetworkAccess
Whether or not public network access is allowed for this server.
Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ReplicationRole
The replication role of the server.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceGroupName
The name of the resource group that contains the resource.
You can obtain this value from the Azure Resource Manager API or the portal.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
UpdateExpanded
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Sku
The name of the sku, typically, tier + family + cores, e.g.
B_Gen4_1, GP_Gen5_8.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SkuCapacity
The scale up/out capacity, representing server's compute units.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SkuFamily
The family of hardware.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SkuTier
The tier of the particular SKU, e.g.
Basic.
Parameter properties
Type: SkuTier
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SslEnforcement
Enable ssl enforcement or not when connect to server.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-StorageAutogrow
Enable Storage Auto Grow.
Parameter properties
Type: StorageAutogrow
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-StorageInMb
Max storage allowed for a server.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SubscriptionId
The subscription ID that identifies an Azure subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id
Supports wildcards: False
DontShow: False
Parameter sets
UpdateExpanded
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Tag
Application-specific metadata in the form of key-value pairs.
Parameter properties
Type: Hashtable
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: wi
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs