Edit

Share via


Get-AzFluidRelayServer

Get a Fluid Relay server.

Syntax

List (Default)

Get-AzFluidRelayServer
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityResourceGroup

Get-AzFluidRelayServer
    -Name <String>
    -ResourceGroupInputObject <IFluidRelayIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzFluidRelayServer
    -Name <String>
    -ResourceGroup <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1

Get-AzFluidRelayServer
    -ResourceGroup <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzFluidRelayServer
    -InputObject <IFluidRelayIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a Fluid Relay server.

Examples

Example 1: List Fluid Relay server.

Get-AzFluidRelayServer
Location Name            ResourceGroupName
-------- ----            -----------------
westus2  azps-fluidrelay azpstest-gp

List Fluid Relay server.

Example 2: List Fluid Relay server by ResourceGroup.

Get-AzFluidRelayServer -ResourceGroup azpstest-gp
Location Name            ResourceGroupName
-------- ----            -----------------
westus2  azps-fluidrelay azpstest-gp

List Fluid Relay server.

Example 3: Get a Fluid Relay server by ResourceGroup.

Get-AzFluidRelayServer -Name azps-fluidrelay -ResourceGroup azpstest-gp
Location Name            ResourceGroupName
-------- ----            -----------------
westus2  azps-fluidrelay azpstest-gp

Get a Fluid Relay server.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IFluidRelayIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The Fluid Relay server resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:FluidRelayServerName

Parameter sets

GetViaIdentityResourceGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroup

The resource group containing the resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupInputObject

Identity Parameter

Parameter properties

Type:IFluidRelayIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityResourceGroup
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The subscription id (GUID) for this resource.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IFluidRelayIdentity

Outputs

IFluidRelayServer