Test-MgmtSvcSqlHostingServer

Reference

Module:: MgmtSvcSqlServer

Verifies a SQL Server hosting server can be created.

Syntax

Test-MgmtSvcSqlHostingServer
    [-TotalSpaceMB] <Int32>
    [-SqlUser] <PSCredential>
    [-ServerGroupId] <String>
    [-Name] <String>
    [-NumberOfCpuCores <Int32>]
    [-TotalMemoryGB <Int32>]
    [-SupportedIopsPerVolume <Int32>]
    [-MaximumResourcePools <Int32>]
    [-AdminUri] <Uri>
    [-Token] <String>
    [-DisableCertificateValidation]
    [<CommonParameters>]

Test-MgmtSvcSqlHostingServer
    [-ServerGroupId] <String>
    [[-HostingServer] <SqlHostingServer>]
    [-AdminUri] <Uri>
    [-Token] <String>
    [-DisableCertificateValidation]
    [<CommonParameters>]

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.

Examples

Example 1: Verify a SQL Server hosting server

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"

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.

Parameters

-AdminUri

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.

Type:	Uri
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostingServer

Specifies a SQL Server hosting server object.

Type:	SqlHostingServer
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MaximumResourcePools

Specifies the number of resource pools for the server.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of a SQL Server.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NumberOfCpuCores

Specifies the number of CPU cores for the server.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerGroupId

Specifies the ID for a SQL Server group.

Type:	String
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SqlUser

Specifies a user account and password as a PSCredential object. To create a PSCredential object, use the Get-Credential cmdlet.

Type:	PSCredential
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SupportedIopsPerVolume

Specifies the supported I/O operations per second (IOPS) for the server.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Token

Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TotalMemoryGB

Specifies the total amount of memory, in gigabytes, for the server.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TotalSpaceMB

Specifies the size, in megabytes (MB) of the hosting server.

Type:	Int32
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

SqlHostingServer

You can pipe a SqlHostingServer object to this cmdlet.

Outputs