Get-MgmtSvcSqlDatabase
Gets a SQL Server database.
Syntax
Get-MgmtSvcSqlDatabase
[-HostingServerId] <String>
[[-Name] <String>]
[-Skip <Int32>]
[-First <Int32>]
[-Descending]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[<CommonParameters>]
Description
The Get-MgmtSvcSqlDatabase cmdlet gets SQL Server databases. By default, all SQL Server databases for a hosting server are returned. To get a specific database, use the Name parameter.
Examples
Example 1: Get a SQL database by name
PS C:\> Get-MgmtSvcSqlDatabase -AdminUri "https://Computer01:30004" -Token $Token -HostingServerId "u37k25" -Name "DB01"
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 the database named DB01 on the hosting server with the ID u37k25.
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 |
-Descending
Indicates that the returned databases are displayed in descending order.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-First
{{Fill First Description}}
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-HostingServerId
Specifies the ID of a SQL Server hosting server.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of a SQL Server database.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Skip
{{Fill Skip Description}}
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 |
Inputs
None
Outputs
SqlDatabase
This cmdlet emits a SqlDatabase object.