< Back
Get-AzureRmServerManagementGateway
Post
NAME Get-AzureRmServerManagementGateway
SYNOPSIS
Gets one or more Server Management Gateways.
SYNTAX
Get-AzureRmServerManagementGateway [-Gateway] <Gateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmServerManagementGateway [-ResourceGroupName] <String> [-GatewayName] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmServerManagementGateway [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmServerManagementGateway cmdlet gets one or more Azure Server Management Gateways.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Gateway <Gateway>
Specifies a gateway that this cmdlet gets.
The cmdlet uses the ResourceGroupName and GatewayName parameters through the specified Gateway to perform the action.
When this parameter is specified, this cmdlet will include detailed status for the gateway.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-GatewayName <String>
Specifies the name of the Server Management Gateway for which this cmdlet gets gate.
When you specify the GatewayName parameter, this cmdlet will include detailed status on the gateway.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for which this cmdlet gets gateways.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Gateway
Parameter 'Gateway' accepts value of type 'Gateway' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ServerManagement.Model.Gateway
NOTES
* If this cmdlet is use without parameters, it will return all the gateways associated with the subscription.
Example 1: Get all gateways in a subscription
PS C:\\>Get-AzureRmServerManagementGateway
Resource Group Location Auto Upgrade Gateway Name
-------------- -------- ------------ ------------
groupOne centralus Off mygateway
groupOne centralus Off othergateway
groupTwo centralus On privategateway
This command gets all Server Management Gateways in the subscription.
Example 2: Get gateways in a resource group
PS C:\\>Get-AzureRmServerManagementGateway -ResourceGroupName "Group001"
Resource Group Location Auto Upgrade Gateway Name
-------------- -------- ------------ ------------
myGroup centralus Off mygateway
This command gets all Server Management Gateways that belong to the resource group named Group001.
Example 3: Get all installed instances of a gateway
PS C:\\>(Get-AzureRmServerManagementGateway -ResourceGroupName "Group002" -GatewayName "Gateway01").Instances
Name Installed Version Operating System
---- --------- ------- ----------------
GATEWAYPC 4/13/2016 6:35:04 PM 1.0.1104.0 Microsoft Windows 10 Enterprise
This command gets all instances of a Server Management Gateway named Gateway01 that belong to the resource group named Group002.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entgateway
New-AzureRmServerManagementGateway
Remove-AzureRmServerManagementGateway
SYNOPSIS
Gets one or more Server Management Gateways.
SYNTAX
Get-AzureRmServerManagementGateway [-Gateway] <Gateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmServerManagementGateway [-ResourceGroupName] <String> [-GatewayName] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmServerManagementGateway [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmServerManagementGateway cmdlet gets one or more Azure Server Management Gateways.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Gateway <Gateway>
Specifies a gateway that this cmdlet gets.
The cmdlet uses the ResourceGroupName and GatewayName parameters through the specified Gateway to perform the action.
When this parameter is specified, this cmdlet will include detailed status for the gateway.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-GatewayName <String>
Specifies the name of the Server Management Gateway for which this cmdlet gets gate.
When you specify the GatewayName parameter, this cmdlet will include detailed status on the gateway.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for which this cmdlet gets gateways.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Gateway
Parameter 'Gateway' accepts value of type 'Gateway' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ServerManagement.Model.Gateway
NOTES
* If this cmdlet is use without parameters, it will return all the gateways associated with the subscription.
Example 1: Get all gateways in a subscription
PS C:\\>Get-AzureRmServerManagementGateway
Resource Group Location Auto Upgrade Gateway Name
-------------- -------- ------------ ------------
groupOne centralus Off mygateway
groupOne centralus Off othergateway
groupTwo centralus On privategateway
This command gets all Server Management Gateways in the subscription.
Example 2: Get gateways in a resource group
PS C:\\>Get-AzureRmServerManagementGateway -ResourceGroupName "Group001"
Resource Group Location Auto Upgrade Gateway Name
-------------- -------- ------------ ------------
myGroup centralus Off mygateway
This command gets all Server Management Gateways that belong to the resource group named Group001.
Example 3: Get all installed instances of a gateway
PS C:\\>(Get-AzureRmServerManagementGateway -ResourceGroupName "Group002" -GatewayName "Gateway01").Instances
Name Installed Version Operating System
---- --------- ------- ----------------
GATEWAYPC 4/13/2016 6:35:04 PM 1.0.1104.0 Microsoft Windows 10 Enterprise
This command gets all instances of a Server Management Gateway named Gateway01 that belong to the resource group named Group002.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entgateway
New-AzureRmServerManagementGateway
Remove-AzureRmServerManagementGateway