ApplicationGatewaysOperations Class

ApplicationGatewaysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ApplicationGatewaysOperations

Constructor

ApplicationGatewaysOperations(client, config, serializer, deserializer)

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_backend_health

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

begin_backend_health_on_demand

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

begin_create_or_update

Creates or updates the specified application gateway.

begin_delete

Deletes the specified application gateway.

begin_start

Starts the specified application gateway.

begin_stop

Stops the specified application gateway in a resource group.

begin_update_tags

Updates the specified application gateway tags.

get

Gets the specified application gateway.

get_ssl_predefined_policy

Gets Ssl predefined policy with the specified policy name.

list

Lists all application gateways in a resource group.

list_all

Gets all the application gateways in a subscription.

list_available_request_headers

Lists all available request headers.

list_available_response_headers

Lists all available response headers.

list_available_server_variables

Lists all available server variables.

list_available_ssl_options

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_predefined_policies

Lists all SSL predefined policies for configuring Ssl policy.

list_available_waf_rule_sets

Lists all available web application firewall rule sets.

begin_backend_health

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

begin_backend_health(resource_group_name, application_gateway_name, expand=None, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

expand
str
default value: None

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGatewayBackendHealth or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_backend_health_on_demand

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

begin_backend_health_on_demand(resource_group_name, application_gateway_name, probe_request, expand=None, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

probe_request
ApplicationGatewayOnDemandProbe
Required

Request body for on-demand test probe operation.

expand
str
default value: None

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGatewayBackendHealthOnDemand or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_create_or_update

Creates or updates the specified application gateway.

begin_create_or_update(resource_group_name, application_gateway_name, parameters, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

parameters
ApplicationGateway
Required

Parameters supplied to the create or update application gateway operation.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGateway or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified application gateway.

begin_delete(resource_group_name, application_gateway_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_start

Starts the specified application gateway.

begin_start(resource_group_name, application_gateway_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_stop

Stops the specified application gateway in a resource group.

begin_stop(resource_group_name, application_gateway_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates the specified application gateway tags.

begin_update_tags(resource_group_name, application_gateway_name, parameters, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

parameters
TagsObject
Required

Parameters supplied to update application gateway tags.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGateway or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified application gateway.

get(resource_group_name, application_gateway_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

application_gateway_name
str
Required

The name of the application gateway.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

ApplicationGateway, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get_ssl_predefined_policy

Gets Ssl predefined policy with the specified policy name.

get_ssl_predefined_policy(predefined_policy_name, **kwargs)

Parameters

predefined_policy_name
str
Required

Name of Ssl predefined policy.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

ApplicationGatewaySslPredefinedPolicy, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all application gateways in a resource group.

list(resource_group_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApplicationGatewayListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all the application gateways in a subscription.

list_all(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApplicationGatewayListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_request_headers

Lists all available request headers.

list_available_request_headers(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

list of str, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_response_headers

Lists all available response headers.

list_available_response_headers(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

list of str, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_server_variables

Lists all available server variables.

list_available_server_variables(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

list of str, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_ssl_options

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_options(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

ApplicationGatewayAvailableSslOptions, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_ssl_predefined_policies

Lists all SSL predefined policies for configuring Ssl policy.

list_available_ssl_predefined_policies(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApplicationGatewayAvailableSslPredefinedPolicies or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_available_waf_rule_sets

Lists all available web application firewall rule sets.

list_available_waf_rule_sets(**kwargs)

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

ApplicationGatewayAvailableWafRuleSetsResult, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2019_04_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2019_04_01\\models\\__init__.py'>