Get-AzureEndpoint
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureEndpoint
Gets an object with information about the endpoints assigned to an Azure virtual machine.
Syntax
Parameter Set: Default
Get-AzureEndpoint [[-Name] <String> ] -VM <IPersistentVM> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Get-AzureEndpoint cmdlet returns an object with information about the endpoints that are assigned to an Azure virtual machine.
Parameters
-Name<String>
Specifies the name of the input endpoint from which information will be retrieved. If the Name parameter is omitted, the cmdlet retrieves information about all endpoints assigned to the specified virtual machine.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
Specifies the virtual machine object from which endpoint information will be retrieved.
Aliases |
InputObject |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This command gets endpoint information for the virtual machine “MyVM”.
PS C:\> Get-AzureVM –ServiceName “MyService” –Name “MyVM” | Get-AzureEndpoint