Test-MgmtSvcSqlHostingServer
Test-MgmtSvcSqlHostingServer
Verifies a SQL Server hosting server can be created.
Syntax
Parameter Set: ByProperties
Test-MgmtSvcSqlHostingServer [-AdminUri] <Uri> [-Token] <String> [-Name] <String> [-TotalSpaceMB] <Int32> [-SqlUser] <System.Management.Automation.PSCredential> [-ServerGroupId] <String> [-DisableCertificateValidation] [-MaximumResourcePools <System.Int32> ] [-NumberOfCpuCores <System.Int32> ] [-SupportedIopsPerVolume <System.Int32> ] [-TotalMemoryGB <System.Int32> ] [ <CommonParameters>]
Parameter Set: ByObject
Test-MgmtSvcSqlHostingServer [-AdminUri] <Uri> [-Token] <String> [[-HostingServer] <SqlHostingServer> ] [-ServerGroupId] <String> [-DisableCertificateValidation] [ <CommonParameters>]
Detailed Description
The Test-MgmtSvcSqlHostingServer cmdlet verifies that a SQL Server hosting server can be created, and that the specified login credentials are correct. This cmdlet verifies that no server with the same name is already registered.
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 |
-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.
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 |
-ServerGroupId<String>
Specifies the ID for a SQL Server group.
Aliases |
none |
Required? |
true |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SqlUser<System.Management.Automation.PSCredential>
Specifies a user account and password as a PSCredential object. To create a PSCredential object, use the Get-Credential cmdlet.
Aliases |
none |
Required? |
true |
Position? |
5 |
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? |
true |
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: Verify a SQL Server 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 second command tests the SQL Server hosting server named SQLServer01.Contoso.com, using the credentials provided in the first command.
PS C:\> $Creds = Get-Credential
PS C:\> Test-MgmtSvcSqlHostingServer -AdminUri "https://Computer01:30004" -Token $Token -Name "SQLServer01.Contoso.com" -TotalSpaceMB 2048 -User $Creds -ServerGroupId "g5sho0"