Edit

Share via

Get-AzFrontDoorFrontendEndpoint

Module:
Az.FrontDoor Module

Gets a Frontend endpoint with the specified name within the specified Front Door.

Syntax

ByFieldsParameterSet (Default) 

Get-AzFrontDoorFrontendEndpoint
    -FrontDoorName <String>
    -ResourceGroupName <String>
    [-Name <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzFrontDoorFrontendEndpoint
    -FrontDoorName <String>
    -ResourceGroupName <String>
    -Name <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List 

Get-AzFrontDoorFrontendEndpoint
    -FrontDoorName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityFrontDoor 

Get-AzFrontDoorFrontendEndpoint
    -Name <String>
    -FrontDoorInputObject <IFrontDoorIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ByObjectParameterSet 

Get-AzFrontDoorFrontendEndpoint
    -FrontDoorInputObject <IFrontDoorIdentity>
    [-Name <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzFrontDoorFrontendEndpoint
    -InputObject <IFrontDoorIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets a Frontend endpoint with the specified name within the specified Front Door.

Examples

Example 1: Get a specific frontend endpoint by name

Get-AzFrontDoorFrontendEndpoint -ResourceGroupName "myResourceGroup" -FrontDoorName "myFrontDoor" -Name "myFrontDoor-azurefd-net"

HostName                         : myFrontDoor-azurefd.net
SessionAffinityEnabledState      : Disabled
SessionAffinityTtlSeconds        : 0
WebApplicationFirewallPolicyLink :
CustomHttpsProvisioningState     : Enabled
CustomHttpsProvisioningSubstate  : CertificateProvisioned
CertificateSource                : FrontDoor
MinimumTlsVersion                : 1.2
ResourceState                    : Enabled
Id                               : /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/myResourceGroup/providers/Microsoft.Network/frontDoors/myFrontDoor/frontendEndpoints/myFrontDoor-azurefd-net
Name                             : myFrontDoor-azurefd-net
Type                             : Microsoft.Network/frontDoors/frontendEndpoints

Get details of a specific frontend endpoint from the Front Door configuration.

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

-FrontDoorInputObject

Identity Parameter

Parameter properties

Type:IFrontDoorIdentity
Default value:None
Supports wildcards:False
DontShow:False
Aliases:FrontDoorObject

Parameter sets

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

-FrontDoorName

Name of the Front Door which is globally unique.

Parameter properties

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

Parameter sets

ByFieldsParameterSet
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
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IFrontDoorIdentity
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 the Frontend endpoint which is unique within the Front Door.

Parameter properties

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

Parameter sets

ByFieldsParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Name of the Resource group within the Azure subscription.

Parameter properties

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

Parameter sets

ByFieldsParameterSet
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
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Parameter properties

Type:

String[]

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

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
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

IFrontDoorIdentity

Outputs

IFrontendEndpoint