ApplicationGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:application_gateways> attribute.

Constructor

ApplicationGatewaysOperations(*args, **kwargs)

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.
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.
update_tags	Updates the specified application gateway tags.

begin_backend_health

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

begin_backend_health(resource_group_name: str, application_gateway_name: str, *, expand: str | None = None, **kwargs: Any) -> LROPoller[ApplicationGatewayBackendHealth]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands BackendAddressPool and BackendHttpSettings referenced in backend health. Default value is None. Default value: None

Returns

Type	Description
LROPoller[ApplicationGatewayBackendHealth]	An instance of LROPoller that returns ApplicationGatewayBackendHealth. The ApplicationGatewayBackendHealth is compatible with MutableMapping

Exceptions

Type	Description
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: str, application_gateway_name: str, probe_request: _models.ApplicationGatewayOnDemandProbe, *, expand: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ApplicationGatewayBackendHealthOnDemand]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.
probe_request Required	ApplicationGatewayOnDemandProbe or <xref:JSON> or IO[bytes] Request body for on-demand test probe operation. Is one of the following types: ApplicationGatewayOnDemandProbe, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
expand	str Expands BackendAddressPool and BackendHttpSettings referenced in backend health. Default value is None. Default value: None

Returns

Type	Description
LROPoller[ApplicationGatewayBackendHealthOnDemand]	An instance of LROPoller that returns ApplicationGatewayBackendHealthOnDemand. The ApplicationGatewayBackendHealthOnDemand is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Creates or updates the specified application gateway.

begin_create_or_update(resource_group_name: str, application_gateway_name: str, parameters: _models.ApplicationGateway, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ApplicationGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.
parameters Required	ApplicationGateway or <xref:JSON> or IO[bytes] Parameters supplied to the create or update application gateway operation. Is one of the following types: ApplicationGateway, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[ApplicationGateway]	An instance of LROPoller that returns ApplicationGateway. The ApplicationGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified application gateway.

begin_delete(resource_group_name: str, application_gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_start

Starts the specified application gateway.

begin_start(resource_group_name: str, application_gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops the specified application gateway in a resource group.

begin_stop(resource_group_name: str, application_gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

get

Gets the specified application gateway.

get(resource_group_name: str, application_gateway_name: str, **kwargs: Any) -> ApplicationGateway

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.

Returns

Type	Description
ApplicationGateway	ApplicationGateway. The ApplicationGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_ssl_predefined_policy

Gets Ssl predefined policy with the specified policy name.

get_ssl_predefined_policy(predefined_policy_name: str, **kwargs: Any) -> ApplicationGatewaySslPredefinedPolicy

Parameters

Name	Description
predefined_policy_name Required	str The name of the ssl predefined policy. Required.

Returns

Type	Description
ApplicationGatewaySslPredefinedPolicy	ApplicationGatewaySslPredefinedPolicy. The ApplicationGatewaySslPredefinedPolicy is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists all application gateways in a resource group.

list(resource_group_name: str, **kwargs: Any) -> ItemPaged[ApplicationGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[ApplicationGateway]	An iterator like instance of ApplicationGateway

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the application gateways in a subscription.

list_all(**kwargs: Any) -> ItemPaged[ApplicationGateway]

Returns

Type	Description
ItemPaged[ApplicationGateway]	An iterator like instance of ApplicationGateway

Exceptions

Type	Description
HttpResponseError

list_available_request_headers

Lists all available request headers.

list_available_request_headers(**kwargs: Any) -> list[str]

Returns

Type	Description
list[str]	list of str

Exceptions

Type	Description
HttpResponseError

list_available_response_headers

Lists all available response headers.

list_available_response_headers(**kwargs: Any) -> list[str]

Returns

Type	Description
list[str]	list of str

Exceptions

Type	Description
HttpResponseError

list_available_server_variables

Lists all available server variables.

list_available_server_variables(**kwargs: Any) -> list[str]

Returns

Type	Description
list[str]	list of str

Exceptions

Type	Description
HttpResponseError

list_available_ssl_options

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_options(**kwargs: Any) -> ApplicationGatewayAvailableSslOptions

Returns

Type	Description
ApplicationGatewayAvailableSslOptions	ApplicationGatewayAvailableSslOptions. The ApplicationGatewayAvailableSslOptions is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_available_ssl_predefined_policies

Lists all SSL predefined policies for configuring Ssl policy.

list_available_ssl_predefined_policies(**kwargs: Any) -> ItemPaged[ApplicationGatewaySslPredefinedPolicy]

Returns

Type	Description
ItemPaged[ApplicationGatewaySslPredefinedPolicy]	An iterator like instance of ApplicationGatewaySslPredefinedPolicy

Exceptions

Type	Description
HttpResponseError

list_available_waf_rule_sets

Lists all available web application firewall rule sets.

list_available_waf_rule_sets(**kwargs: Any) -> ApplicationGatewayAvailableWafRuleSetsResult

Returns

Type	Description
ApplicationGatewayAvailableWafRuleSetsResult	ApplicationGatewayAvailableWafRuleSetsResult. The ApplicationGatewayAvailableWafRuleSetsResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

update_tags

Updates the specified application gateway tags.

update_tags(resource_group_name: str, application_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ApplicationGateway

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
application_gateway_name Required	str The name of the application gateway. Required.
parameters Required	TagsObject or <xref:JSON> or IO[bytes] Parameters supplied to update application gateway tags. Is one of the following types: TagsObject, JSON, IO[bytes] Required.

Returns

Type	Description
ApplicationGateway	ApplicationGateway. The ApplicationGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError