ApplicationGateways interface

Package:

@azure/arm-network

Interface representing a ApplicationGateways.

Methods

beginBackendHealth(string, string, ApplicationGatewaysBackendHealthOptionalParams)	Gets the backend health of the specified application gateway in a resource group.
beginBackendHealthAndWait(string, string, ApplicationGatewaysBackendHealthOptionalParams)	Gets the backend health of the specified application gateway in a resource group.
beginBackendHealthOnDemand(string, string, ApplicationGatewayOnDemandProbe, ApplicationGatewaysBackendHealthOnDemandOptionalParams)	Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.
beginBackendHealthOnDemandAndWait(string, string, ApplicationGatewayOnDemandProbe, ApplicationGatewaysBackendHealthOnDemandOptionalParams)	Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.
beginCreateOrUpdate(string, string, ApplicationGateway, ApplicationGatewaysCreateOrUpdateOptionalParams)	Creates or updates the specified application gateway.
beginCreateOrUpdateAndWait(string, string, ApplicationGateway, ApplicationGatewaysCreateOrUpdateOptionalParams)	Creates or updates the specified application gateway.
beginDelete(string, string, ApplicationGatewaysDeleteOptionalParams)	Deletes the specified application gateway.
beginDeleteAndWait(string, string, ApplicationGatewaysDeleteOptionalParams)	Deletes the specified application gateway.
beginStart(string, string, ApplicationGatewaysStartOptionalParams)	Starts the specified application gateway.
beginStartAndWait(string, string, ApplicationGatewaysStartOptionalParams)	Starts the specified application gateway.
beginStop(string, string, ApplicationGatewaysStopOptionalParams)	Stops the specified application gateway in a resource group.
beginStopAndWait(string, string, ApplicationGatewaysStopOptionalParams)	Stops the specified application gateway in a resource group.
get(string, string, ApplicationGatewaysGetOptionalParams)	Gets the specified application gateway.
getSslPredefinedPolicy(string, ApplicationGatewaysGetSslPredefinedPolicyOptionalParams)	Gets Ssl predefined policy with the specified policy name.
list(string, ApplicationGatewaysListOptionalParams)	Lists all application gateways in a resource group.
listAll(ApplicationGatewaysListAllOptionalParams)	Gets all the application gateways in a subscription.
listAvailableRequestHeaders(ApplicationGatewaysListAvailableRequestHeadersOptionalParams)	Lists all available request headers.
listAvailableResponseHeaders(ApplicationGatewaysListAvailableResponseHeadersOptionalParams)	Lists all available response headers.
listAvailableServerVariables(ApplicationGatewaysListAvailableServerVariablesOptionalParams)	Lists all available server variables.
listAvailableSslOptions(ApplicationGatewaysListAvailableSslOptionsOptionalParams)	Lists available Ssl options for configuring Ssl policy.
listAvailableSslPredefinedPolicies(ApplicationGatewaysListAvailableSslPredefinedPoliciesOptionalParams)	Lists all SSL predefined policies for configuring Ssl policy.
listAvailableWafRuleSets(ApplicationGatewaysListAvailableWafRuleSetsOptionalParams)	Lists all available web application firewall rule sets.
updateTags(string, string, TagsObject, ApplicationGatewaysUpdateTagsOptionalParams)	Updates the specified application gateway tags.

Method Details

beginBackendHealth(string, string, ApplicationGatewaysBackendHealthOptionalParams)

Gets the backend health of the specified application gateway in a resource group.

function beginBackendHealth(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysBackendHealthOptionalParams): Promise<SimplePollerLike<OperationState<ApplicationGatewayBackendHealth>, ApplicationGatewayBackendHealth>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysBackendHealthOptionalParams

The options parameters.

Returns

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

beginBackendHealthAndWait(string, string, ApplicationGatewaysBackendHealthOptionalParams)

Gets the backend health of the specified application gateway in a resource group.

function beginBackendHealthAndWait(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysBackendHealthOptionalParams): Promise<ApplicationGatewayBackendHealth>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysBackendHealthOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewayBackendHealth>

beginBackendHealthOnDemand(string, string, ApplicationGatewayOnDemandProbe, ApplicationGatewaysBackendHealthOnDemandOptionalParams)

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

function beginBackendHealthOnDemand(resourceGroupName: string, applicationGatewayName: string, probeRequest: ApplicationGatewayOnDemandProbe, options?: ApplicationGatewaysBackendHealthOnDemandOptionalParams): Promise<SimplePollerLike<OperationState<ApplicationGatewayBackendHealthOnDemand>, ApplicationGatewayBackendHealthOnDemand>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

probeRequest

ApplicationGatewayOnDemandProbe

Request body for on-demand test probe operation.

options

ApplicationGatewaysBackendHealthOnDemandOptionalParams

The options parameters.

Returns

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

beginBackendHealthOnDemandAndWait(string, string, ApplicationGatewayOnDemandProbe, ApplicationGatewaysBackendHealthOnDemandOptionalParams)

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

function beginBackendHealthOnDemandAndWait(resourceGroupName: string, applicationGatewayName: string, probeRequest: ApplicationGatewayOnDemandProbe, options?: ApplicationGatewaysBackendHealthOnDemandOptionalParams): Promise<ApplicationGatewayBackendHealthOnDemand>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

probeRequest

ApplicationGatewayOnDemandProbe

Request body for on-demand test probe operation.

options

ApplicationGatewaysBackendHealthOnDemandOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewayBackendHealthOnDemand>

beginCreateOrUpdate(string, string, ApplicationGateway, ApplicationGatewaysCreateOrUpdateOptionalParams)

Creates or updates the specified application gateway.

function beginCreateOrUpdate(resourceGroupName: string, applicationGatewayName: string, parameters: ApplicationGateway, options?: ApplicationGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApplicationGateway>, ApplicationGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

parameters

ApplicationGateway

Parameters supplied to the create or update application gateway operation.

options

ApplicationGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, ApplicationGateway, ApplicationGatewaysCreateOrUpdateOptionalParams)

Creates or updates the specified application gateway.

function beginCreateOrUpdateAndWait(resourceGroupName: string, applicationGatewayName: string, parameters: ApplicationGateway, options?: ApplicationGatewaysCreateOrUpdateOptionalParams): Promise<ApplicationGateway>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

parameters

ApplicationGateway

Parameters supplied to the create or update application gateway operation.

options

ApplicationGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApplicationGateway>

beginDelete(string, string, ApplicationGatewaysDeleteOptionalParams)

Deletes the specified application gateway.

function beginDelete(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ApplicationGatewaysDeleteOptionalParams)

Deletes the specified application gateway.

function beginDeleteAndWait(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ApplicationGatewaysStartOptionalParams)

Starts the specified application gateway.

function beginStart(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, ApplicationGatewaysStartOptionalParams)

Starts the specified application gateway.

function beginStartAndWait(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, ApplicationGatewaysStopOptionalParams)

Stops the specified application gateway in a resource group.

function beginStop(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysStopOptionalParams

The options parameters.

Returns

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

beginStopAndWait(string, string, ApplicationGatewaysStopOptionalParams)

Stops the specified application gateway in a resource group.

function beginStopAndWait(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysStopOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ApplicationGatewaysGetOptionalParams)

Gets the specified application gateway.

function get(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysGetOptionalParams): Promise<ApplicationGateway>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

options

ApplicationGatewaysGetOptionalParams

The options parameters.

Returns

Promise<ApplicationGateway>

getSslPredefinedPolicy(string, ApplicationGatewaysGetSslPredefinedPolicyOptionalParams)

Gets Ssl predefined policy with the specified policy name.

function getSslPredefinedPolicy(predefinedPolicyName: string, options?: ApplicationGatewaysGetSslPredefinedPolicyOptionalParams): Promise<ApplicationGatewaySslPredefinedPolicy>

Parameters

predefinedPolicyName

string

Name of Ssl predefined policy.

options

ApplicationGatewaysGetSslPredefinedPolicyOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewaySslPredefinedPolicy>

list(string, ApplicationGatewaysListOptionalParams)

Lists all application gateways in a resource group.

function list(resourceGroupName: string, options?: ApplicationGatewaysListOptionalParams): PagedAsyncIterableIterator<ApplicationGateway, ApplicationGateway[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

ApplicationGatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApplicationGateway, ApplicationGateway[], PageSettings>

listAll(ApplicationGatewaysListAllOptionalParams)

Gets all the application gateways in a subscription.

function listAll(options?: ApplicationGatewaysListAllOptionalParams): PagedAsyncIterableIterator<ApplicationGateway, ApplicationGateway[], PageSettings>

Parameters

options

ApplicationGatewaysListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApplicationGateway, ApplicationGateway[], PageSettings>

listAvailableRequestHeaders(ApplicationGatewaysListAvailableRequestHeadersOptionalParams)

Lists all available request headers.

function listAvailableRequestHeaders(options?: ApplicationGatewaysListAvailableRequestHeadersOptionalParams): Promise<ApplicationGatewaysListAvailableRequestHeadersResponse>

Parameters

options

ApplicationGatewaysListAvailableRequestHeadersOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewaysListAvailableRequestHeadersResponse>

listAvailableResponseHeaders(ApplicationGatewaysListAvailableResponseHeadersOptionalParams)

Lists all available response headers.

function listAvailableResponseHeaders(options?: ApplicationGatewaysListAvailableResponseHeadersOptionalParams): Promise<ApplicationGatewaysListAvailableResponseHeadersResponse>

Parameters

options

ApplicationGatewaysListAvailableResponseHeadersOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewaysListAvailableResponseHeadersResponse>

listAvailableServerVariables(ApplicationGatewaysListAvailableServerVariablesOptionalParams)

Lists all available server variables.

function listAvailableServerVariables(options?: ApplicationGatewaysListAvailableServerVariablesOptionalParams): Promise<ApplicationGatewaysListAvailableServerVariablesResponse>

Parameters

options

ApplicationGatewaysListAvailableServerVariablesOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewaysListAvailableServerVariablesResponse>

listAvailableSslOptions(ApplicationGatewaysListAvailableSslOptionsOptionalParams)

Lists available Ssl options for configuring Ssl policy.

function listAvailableSslOptions(options?: ApplicationGatewaysListAvailableSslOptionsOptionalParams): Promise<ApplicationGatewayAvailableSslOptions>

Parameters

options

ApplicationGatewaysListAvailableSslOptionsOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewayAvailableSslOptions>

listAvailableSslPredefinedPolicies(ApplicationGatewaysListAvailableSslPredefinedPoliciesOptionalParams)

Lists all SSL predefined policies for configuring Ssl policy.

function listAvailableSslPredefinedPolicies(options?: ApplicationGatewaysListAvailableSslPredefinedPoliciesOptionalParams): PagedAsyncIterableIterator<ApplicationGatewaySslPredefinedPolicy, ApplicationGatewaySslPredefinedPolicy[], PageSettings>

Parameters

options

ApplicationGatewaysListAvailableSslPredefinedPoliciesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApplicationGatewaySslPredefinedPolicy, ApplicationGatewaySslPredefinedPolicy[], PageSettings>

listAvailableWafRuleSets(ApplicationGatewaysListAvailableWafRuleSetsOptionalParams)

Lists all available web application firewall rule sets.

function listAvailableWafRuleSets(options?: ApplicationGatewaysListAvailableWafRuleSetsOptionalParams): Promise<ApplicationGatewayAvailableWafRuleSetsResult>

Parameters

options

ApplicationGatewaysListAvailableWafRuleSetsOptionalParams

The options parameters.

Returns

Promise<ApplicationGatewayAvailableWafRuleSetsResult>

updateTags(string, string, TagsObject, ApplicationGatewaysUpdateTagsOptionalParams)

Updates the specified application gateway tags.

function updateTags(resourceGroupName: string, applicationGatewayName: string, parameters: TagsObject, options?: ApplicationGatewaysUpdateTagsOptionalParams): Promise<ApplicationGateway>

Parameters

resourceGroupName

string

The name of the resource group.

applicationGatewayName

string

The name of the application gateway.

parameters

TagsObject

Parameters supplied to update application gateway tags.

options

ApplicationGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ApplicationGateway>