Edit

Share via

Get-AzStackHciEdgeDevice

Module:
Az.StackHCI Module

Get a EdgeDevice

Syntax

List (Default) 

Get-AzStackHciEdgeDevice
    -ResourceUri <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzStackHciEdgeDevice
    -Name <String>
    -ResourceUri <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzStackHciEdgeDevice
    -InputObject <IStackHciIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a EdgeDevice

Examples

Example 1:

Get-AzStackHciEdgeDevice -ResourceUri "subscriptions/<subId>/resourceGroups/<test-rg>/providers/Microsoft.HybridCompute/machines/<test-node>"

Kind    Name
----    ----
HCI     default

Gets the Edge Device

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 To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IStackHciIdentity
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

Name of Device

Parameter properties

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

Parameter sets

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

-ResourceUri

The fully qualified Azure Resource manager identifier of the resource.

Parameter properties

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

Parameter sets

List
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

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

IStackHciIdentity

Outputs

IEdgeDevice