< Back

Get-AzureEndpoint

Wed Jan 30, 2019 5:43 pm

NAME Get-AzureEndpoint



SYNOPSIS

Gets information about the endpoints that are assigned to an Azure virtual machine.





SYNTAX

Get-AzureEndpoint [[-Name] <String>] -VM <IPersistentVM> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable

<String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureEndpoint cmdlet gets information about the endpoints that are assigned to an Azure virtual machine.





PARAMETERS

-Name <String>

Specifies the name of the endpoint for which this cmdlet gets information.



Required? false

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the virtual machine from which this cmdlet gets endpoint information.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Get endpoint information for a virtual machine --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine12" | Get-AzureEndpoint



This command retrieves the configuration of a virtual machine named VirtualMachine12 by using the Get-AzureVM cmdlet. The command passes it to the

current cmdlet by using the pipeline operator. This cmdlet gets endpoint information for that virtual machine.



RELATED LINKS

Add-AzureEndpoint

Get-AzureVM

Remove-AzureEndpoint

Set-AzureEndpoint