FrontendEndpoints interface

Package:

@azure/arm-frontdoor

Interface representing a FrontendEndpoints.

Methods

beginDisableHttps(string, string, string, FrontendEndpointsDisableHttpsOptionalParams)	Disables a frontendEndpoint for HTTPS traffic
beginDisableHttpsAndWait(string, string, string, FrontendEndpointsDisableHttpsOptionalParams)	Disables a frontendEndpoint for HTTPS traffic
beginEnableHttps(string, string, string, CustomHttpsConfiguration, FrontendEndpointsEnableHttpsOptionalParams)	Enables a frontendEndpoint for HTTPS traffic
beginEnableHttpsAndWait(string, string, string, CustomHttpsConfiguration, FrontendEndpointsEnableHttpsOptionalParams)	Enables a frontendEndpoint for HTTPS traffic
get(string, string, string, FrontendEndpointsGetOptionalParams)	Gets a Frontend endpoint with the specified name within the specified Front Door.
listByFrontDoor(string, string, FrontendEndpointsListByFrontDoorOptionalParams)	Lists all of the frontend endpoints within a Front Door.

Method Details

beginDisableHttps(string, string, string, FrontendEndpointsDisableHttpsOptionalParams)

Disables a frontendEndpoint for HTTPS traffic

function beginDisableHttps(resourceGroupName: string, frontDoorName: string, frontendEndpointName: string, options?: FrontendEndpointsDisableHttpsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

frontendEndpointName

string

Name of the Frontend endpoint which is unique within the Front Door.

options

FrontendEndpointsDisableHttpsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDisableHttpsAndWait(string, string, string, FrontendEndpointsDisableHttpsOptionalParams)

Disables a frontendEndpoint for HTTPS traffic

function beginDisableHttpsAndWait(resourceGroupName: string, frontDoorName: string, frontendEndpointName: string, options?: FrontendEndpointsDisableHttpsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

frontendEndpointName

string

Name of the Frontend endpoint which is unique within the Front Door.

options

FrontendEndpointsDisableHttpsOptionalParams

The options parameters.

Returns

Promise<void>

beginEnableHttps(string, string, string, CustomHttpsConfiguration, FrontendEndpointsEnableHttpsOptionalParams)

Enables a frontendEndpoint for HTTPS traffic

function beginEnableHttps(resourceGroupName: string, frontDoorName: string, frontendEndpointName: string, customHttpsConfiguration: CustomHttpsConfiguration, options?: FrontendEndpointsEnableHttpsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

frontendEndpointName

string

Name of the Frontend endpoint which is unique within the Front Door.

customHttpsConfiguration

CustomHttpsConfiguration

The configuration specifying how to enable HTTPS

options

FrontendEndpointsEnableHttpsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginEnableHttpsAndWait(string, string, string, CustomHttpsConfiguration, FrontendEndpointsEnableHttpsOptionalParams)

Enables a frontendEndpoint for HTTPS traffic

function beginEnableHttpsAndWait(resourceGroupName: string, frontDoorName: string, frontendEndpointName: string, customHttpsConfiguration: CustomHttpsConfiguration, options?: FrontendEndpointsEnableHttpsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

frontendEndpointName

string

Name of the Frontend endpoint which is unique within the Front Door.

customHttpsConfiguration

CustomHttpsConfiguration

The configuration specifying how to enable HTTPS

options

FrontendEndpointsEnableHttpsOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, FrontendEndpointsGetOptionalParams)

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

function get(resourceGroupName: string, frontDoorName: string, frontendEndpointName: string, options?: FrontendEndpointsGetOptionalParams): Promise<FrontendEndpoint>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

frontendEndpointName

string

Name of the Frontend endpoint which is unique within the Front Door.

options

FrontendEndpointsGetOptionalParams

The options parameters.

Returns

Promise<FrontendEndpoint>

listByFrontDoor(string, string, FrontendEndpointsListByFrontDoorOptionalParams)

Lists all of the frontend endpoints within a Front Door.

function listByFrontDoor(resourceGroupName: string, frontDoorName: string, options?: FrontendEndpointsListByFrontDoorOptionalParams): PagedAsyncIterableIterator<FrontendEndpoint, FrontendEndpoint[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

frontDoorName

string

Name of the Front Door which is globally unique.

options

FrontendEndpointsListByFrontDoorOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FrontendEndpoint, FrontendEndpoint[], PageSettings>