ApplicationGatewaysOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:application_gateways> attribute.

Inheritance: builtins.object

ApplicationGatewaysOperations

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. 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.

Returns

Type	Description
LROPoller[ApplicationGatewayBackendHealth]	An instance of LROPoller that returns either ApplicationGatewayBackendHealth or the result of cls(response)

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. Required.
application_gateway_name Required	str The name of the application gateway. Required.
probe_request Required	ApplicationGatewayOnDemandProbe or IO[bytes] Request body for on-demand test probe operation. Is either a ApplicationGatewayOnDemandProbe type or a IO[bytes] type. Required.

Keyword-Only Parameters

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

Returns

Type	Description
LROPoller[ApplicationGatewayBackendHealthOnDemand]	An instance of LROPoller that returns either ApplicationGatewayBackendHealthOnDemand or the result of cls(response)

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. Required.
application_gateway_name Required	str The name of the application gateway. Required.
parameters Required	ApplicationGateway or IO[bytes] Parameters supplied to the create or update application gateway operation. Is either a ApplicationGateway type or a IO[bytes] type. Required.

Keyword-Only Parameters

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

Returns

Type	Description
LROPoller[ApplicationGateway]	An instance of LROPoller that returns either ApplicationGateway or the result of cls(response)

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. 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.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

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. 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.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

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. 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.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

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. 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.

Returns

Type	Description
ApplicationGateway	ApplicationGateway or the result of cls(response)

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 Name of Ssl predefined policy. Required.

Keyword-Only Parameters

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

Returns

Type	Description
ApplicationGatewaySslPredefinedPolicy	ApplicationGatewaySslPredefinedPolicy or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all application gateways in a resource group.

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

Parameters

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

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[ApplicationGateway]	An iterator like instance of either ApplicationGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the application gateways in a subscription.

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

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[ApplicationGateway]	An iterator like instance of either ApplicationGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_available_request_headers

Lists all available request headers.

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

Keyword-Only Parameters

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

Returns

Type	Description
list[str]	list of str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_available_response_headers

Lists all available response headers.

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

Keyword-Only Parameters

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

Returns

Type	Description
list[str]	list of str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_available_server_variables

Lists all available server variables.

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

Keyword-Only Parameters

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

Returns

Type	Description
list[str]	list of str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_available_ssl_options

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_options(**kwargs: Any) -> ApplicationGatewayAvailableSslOptions

Keyword-Only Parameters

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

Returns

Type	Description
ApplicationGatewayAvailableSslOptions	ApplicationGatewayAvailableSslOptions or the result of cls(response)

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) -> Iterable[ApplicationGatewaySslPredefinedPolicy]

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[ApplicationGatewaySslPredefinedPolicy]	An iterator like instance of either ApplicationGatewaySslPredefinedPolicy or the result of cls(response)

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

Keyword-Only Parameters

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

Returns

Type	Description
ApplicationGatewayAvailableWafRuleSetsResult	ApplicationGatewayAvailableWafRuleSetsResult or the result of cls(response)

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. Required.
application_gateway_name Required	str The name of the application gateway. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update application gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Keyword-Only Parameters

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

Returns

Type	Description
ApplicationGateway	ApplicationGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>

Share via

ApplicationGatewaysOperations Class

Constructor

Methods

begin_backend_health

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_backend_health_on_demand

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_create_or_update

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_delete

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_start

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_stop

Parameters

Keyword-Only Parameters

Returns

Exceptions

get

Parameters

Keyword-Only Parameters

Returns

Exceptions

get_ssl_predefined_policy

Parameters

Keyword-Only Parameters

Returns

Exceptions

list

Parameters

Keyword-Only Parameters

Returns

Exceptions

list_all

Keyword-Only Parameters

Returns

Exceptions

list_available_request_headers

Keyword-Only Parameters

Returns

Exceptions

list_available_response_headers

Keyword-Only Parameters

Returns

Exceptions

list_available_server_variables

Keyword-Only Parameters

Returns

Exceptions

list_available_ssl_options

Keyword-Only Parameters

Returns

Exceptions

list_available_ssl_predefined_policies

Keyword-Only Parameters

Returns

Exceptions

list_available_waf_rule_sets

Keyword-Only Parameters

Returns

Exceptions

update_tags

Parameters

Keyword-Only Parameters