Set-MgmtSvcSqlHostingServer
Set-MgmtSvcSqlHostingServer
Updates a SQL Server hosting server.
Syntax
Parameter Set: ByProperties
Set-MgmtSvcSqlHostingServer [-AdminUri] <Uri> [-Token] <String> [-Name] <String> [-HostingServerId] <String> [[-TotalSpaceMB] <Int32> ] [-DisableCertificateValidation] [-MaximumResourcePools <System.Int32> ] [-NumberOfCpuCores <System.Int32> ] [-SqlUser <System.Management.Automation.PSCredential> ] [-SupportedIopsPerVolume <System.Int32> ] [-TotalMemoryGB <System.Int32> ] [ <CommonParameters>]
Parameter Set: ByObject
Set-MgmtSvcSqlHostingServer [-AdminUri] <Uri> [-Token] <String> [[-HostingServer] <SqlHostingServer> ] [-DisableCertificateValidation] [ <CommonParameters>]
Detailed Description
The Set-MgmtSvcSqlHostingServer cmdlet updates a SQL Server hosting server.
Parameters
-AdminUri<Uri>
Specifies the URI of the Windows Azure Pack administrator API. Use the following format: https://< computer>:<port>, where <computer> is the computer on which the administrator API is installed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DisableCertificateValidation
Disables certificate validation for the Windows Azure Pack installation.
If you specify this parameter, you can use self-signed certificates.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HostingServer<SqlHostingServer>
Specifies a SQL Server hosting server object.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-HostingServerId<String>
Specifies the ID of a SQL Server hosting server.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaximumResourcePools<System.Int32>
Specifies the number of resource pools for the server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a SQL Server hosting server.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NumberOfCpuCores<System.Int32>
Specifies the number of CPU cores for the server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-SqlUser<System.Management.Automation.PSCredential>
Specifies a SQL user account and password as a PSCredential object. To create a PSCredential object, use the Get-Credential cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-SupportedIopsPerVolume<System.Int32>
Specifies the supported I/O operations per second (IOPS) for the server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Token<String>
Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TotalMemoryGB<System.Int32>
Specifies the total amount of memory, in gigabytes, for the server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-TotalSpaceMB<Int32>
Specifies the size, in megabytes (MB) of the hosting server.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
SqlHostingServer
You can pipe a SqlHostingServer object to this cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
SqlHostingServer
This cmdlet emits a SqlHostingServer object.
Examples
Example 1: Update a SQL hosting server
NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.
The first command prompts the user for credentials and stores the provided user name and password in the $Credential variable. The SqlUser parameter is only required if the hosting server's connection must be repaired.
The second command updates the total space to 4096 MB for the hosting server named SQLServer01.Contoso.com.
The third command updates the values of total space, CPU core, memory, supported IOPS per volume, and maximum resource pools allowed in the server.
PS C:\> $Creds = Get-Credential
PS C:\> Set-MgmtSvcSqlHostingServer -AdminUri "https://Computer01:30004" -Token $Token -Name "SQLServer01.Contoso.com" -TotalSpaceMB 4096 -User $Creds -HostingServerId "u37k25"
PS C:\> Set-MgmtSvcSqlHostingServer -AdminUri "https://Computer01:30004" -Token $Token -Name "SQLServer01.Contoso.com" -TotalSpaceMB 4096 -NumberOfCpuCores 4 -TotalMemoryGB 12 -SupportedIopsPerVolume 500 -MaximumResourcePools 12 -HostingServerId "u37k25"