Get-MgmtSvcSqlHostingServerByGroup
Get-MgmtSvcSqlHostingServerByGroup
Gets hosting servers by SQL Server group.
Syntax
Parameter Set: Default
Get-MgmtSvcSqlHostingServerByGroup [-AdminUri] <Uri> [-Token] <String> [-ServerGroupId] <String> [[-Name] <String[]> ] [-DisableCertificateValidation] [ <CommonParameters>]
Detailed Description
The Get-MgmtSvcSqlHostingServerByGroup gets SQL Server hosting servers by SQL Server group. By default, all SQL Server hosting servers for a group are returned. To get a specific hosting server, use the Name parameter.
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 |
-Name<String[]>
Specifies an array of SQL Server hosting server names.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServerGroupId<String>
Specifies the ID of a SQL Server group.
Aliases |
none |
Required? |
true |
Position? |
3 |
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 |
<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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
SqlHostingServerList
This cmdlet emits a SqlHostingServerList object.
Examples
Example 1: Get all SQL hosting servers for a group
NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.
This command gets all SQL Server hosting servers in the group with the ID of g5sho0.
PS C:\> Get-MgmtSvcSqlHostingServerByGroup -AdminUri "https://Computer01:30004" -Token $Token -ServerGroupId "g5sho0"