Get-MgmtSvcSqlHostingServerByGroup

  • Reference
Module:
MgmtSvcSqlServer

Gets hosting servers by SQL Server group.

Syntax

Get-MgmtSvcSqlHostingServerByGroup
   [-ServerGroupId] <String>
   [[-Name] <String[]>]
   [-AdminUri] <Uri>
   [-Token] <String>
   [-DisableCertificateValidation]
   [<CommonParameters>]

Description

The Get-MgmtSvcSqlHostingServerByGroup cmdlet 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.

Examples

Example 1: Get all SQL hosting servers for a group

PS C:\> Get-MgmtSvcSqlHostingServerByGroup -AdminUri "https://Computer01:30004" -Token $Token -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.

This command gets all SQL Server hosting servers in the group with the ID of g5sho0.

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

-Name

Specifies an array of SQL Server hosting server names.

Type:String[]
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServerGroupId

Specifies the ID of a SQL Server group.

Type:String
Position:2
Default value:None
Required:True
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

Inputs

None

Outputs

SqlHostingServerList

This cmdlet emits a SqlHostingServerList object.