Get-SqlSmartAdmin
Gets the SQL Smart Admin object and its properties.
Syntax
Get-SqlSmartAdmin
[-Name <String>]
[-DatabaseName <String>]
[-ServerInstance <PSObject>]
[[-Path] <String>]
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-SqlSmartAdmin
[-Name <String>]
[-DatabaseName <String>]
[-ServerInstance <PSObject>]
[-InputObject] <Server>
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-SqlSmartAdmin
[-Name <String>]
[-DatabaseName <String>]
[-ServerInstance <PSObject>]
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Get-SqlSmartAdmin cmdlet gets the SQL Smart Admin object. The Smart Admin object includes SQL Server Managed Backup to Windows Azure_2 configuration settings. This cmdlet supports the following modes of operation to return the object:
- Pass the name of the server instance using the Name parameter. For a default instance, specify only the computer name. For a named instance, use Computername\InstanceName.
- Pass the path of the instance of SQL Server to the Path parameter.
Examples
Example 1: Get a Smart Admin object properties from a computer
PS C:\> Get-SqlSmartAdmin -Name "Computer\MyInstance"This command gets the smart admin object properties from the computer named 'Computer\MyInstance'.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseName
Specifies the name of the database that this cmdlet gets the SQL Smart Admin object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the instance of the Server object.
| Type: | Server |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the instance of the SQL Server in this format: Computer\Instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Specifies the path to the instance of SQL Server. If you do not specify a value for this parameter, the cmdlet sets the path to the current working location.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Script
Indicates that this cmdlet runs a Transact-SQL script that performs the task.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerInstance
Specifies the name of an instance of the SQL Server. For default instances, only specify the computer name: MyComputer. For named instances, use the format ComputerName\InstanceName. Both the Name and the ServerInstance parameters allow you to specify the name of the instance, but ServerInstance also accepts pipeline input of the Server instance name, or the SqInstanceInfo object.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
System.Management.Automation.PSObject
Microsoft.SqlServer.Management.Smo.Server