ApplicationGatewaysOperations interface

Package:
@azure/arm-network

Interface representing a ApplicationGateways operations.

Properties

backendHealth

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

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.
beginBackendHealth
beginBackendHealthAndWait
beginBackendHealthOnDemand
beginBackendHealthOnDemandAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
createOrUpdate

Creates or updates the specified application gateway.
delete

Deletes the specified application gateway.
get

Gets the specified application gateway.
getSslPredefinedPolicy

Gets Ssl predefined policy with the specified policy name.
list

Lists all application gateways in a resource group.
listAll

Gets all the application gateways in a subscription.
listAvailableRequestHeaders

Lists all available request headers.
listAvailableResponseHeaders

Lists all available response headers.
listAvailableServerVariables

Lists all available server variables.
listAvailableSslOptions

Lists available Ssl options for configuring Ssl policy.
listAvailableSslPredefinedPolicies

Lists all SSL predefined policies for configuring Ssl policy.
listAvailableWafRuleSets

Lists all available web application firewall rule sets.
start

Starts the specified application gateway.
stop

Stops the specified application gateway in a resource group.
updateTags

Updates the specified application gateway tags.

Property Details

backendHealth

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

backendHealth: (resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysBackendHealthOptionalParams) => PollerLike<OperationState<ApplicationGatewayBackendHealth>, ApplicationGatewayBackendHealth>

Property Value

(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysBackendHealthOptionalParams) => PollerLike<OperationState<ApplicationGatewayBackendHealth>, ApplicationGatewayBackendHealth>

backendHealthOnDemand

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

backendHealthOnDemand: (resourceGroupName: string, applicationGatewayName: string, probeRequest: ApplicationGatewayOnDemandProbe, options?: ApplicationGatewaysBackendHealthOnDemandOptionalParams) => PollerLike<OperationState<ApplicationGatewayBackendHealthOnDemand>, ApplicationGatewayBackendHealthOnDemand>

Property Value

(resourceGroupName: string, applicationGatewayName: string, probeRequest: ApplicationGatewayOnDemandProbe, options?: ApplicationGatewaysBackendHealthOnDemandOptionalParams) => PollerLike<OperationState<ApplicationGatewayBackendHealthOnDemand>, ApplicationGatewayBackendHealthOnDemand>

beginBackendHealth

Warning

This API is now deprecated.

use backendHealth instead

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

Property Value

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

beginBackendHealthAndWait

Warning

This API is now deprecated.

use backendHealth instead

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

Property Value

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

beginBackendHealthOnDemand

Warning

This API is now deprecated.

use backendHealthOnDemand instead

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

Property Value

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

beginBackendHealthOnDemandAndWait

Warning

This API is now deprecated.

use backendHealthOnDemand instead

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

Property Value

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

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginStart

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStartAndWait

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStop

Warning

This API is now deprecated.

use stop instead

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

Property Value

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

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

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

Property Value

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

createOrUpdate

Creates or updates the specified application gateway.

createOrUpdate: (resourceGroupName: string, applicationGatewayName: string, parameters: ApplicationGateway, options?: ApplicationGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ApplicationGateway>, ApplicationGateway>

Property Value

(resourceGroupName: string, applicationGatewayName: string, parameters: ApplicationGateway, options?: ApplicationGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ApplicationGateway>, ApplicationGateway>

delete

Deletes the specified application gateway.

delete: (resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified application gateway.

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

Property Value

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

getSslPredefinedPolicy

Gets Ssl predefined policy with the specified policy name.

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

Property Value

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

list

Lists all application gateways in a resource group.

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

Property Value

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

listAll

Gets all the application gateways in a subscription.

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

Property Value

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

listAvailableRequestHeaders

Lists all available request headers.

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

Property Value

(options?: ApplicationGatewaysListAvailableRequestHeadersOptionalParams) => Promise<ApplicationGatewaysListAvailableRequestHeadersResponse>

listAvailableResponseHeaders

Lists all available response headers.

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

Property Value

(options?: ApplicationGatewaysListAvailableResponseHeadersOptionalParams) => Promise<ApplicationGatewaysListAvailableResponseHeadersResponse>

listAvailableServerVariables

Lists all available server variables.

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

Property Value

(options?: ApplicationGatewaysListAvailableServerVariablesOptionalParams) => Promise<ApplicationGatewaysListAvailableServerVariablesResponse>

listAvailableSslOptions

Lists available Ssl options for configuring Ssl policy.

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

Property Value

(options?: ApplicationGatewaysListAvailableSslOptionsOptionalParams) => Promise<ApplicationGatewayAvailableSslOptions>

listAvailableSslPredefinedPolicies

Lists all SSL predefined policies for configuring Ssl policy.

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

Property Value

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

listAvailableWafRuleSets

Lists all available web application firewall rule sets.

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

Property Value

(options?: ApplicationGatewaysListAvailableWafRuleSetsOptionalParams) => Promise<ApplicationGatewayAvailableWafRuleSetsResult>

start

Starts the specified application gateway.

start: (resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Stops the specified application gateway in a resource group.

stop: (resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, applicationGatewayName: string, options?: ApplicationGatewaysStopOptionalParams) => PollerLike<OperationState<void>, void>

updateTags

Updates the specified application gateway tags.

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

Property Value

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