ApplicationGatewaysOperations class

Definition

ApplicationGatewaysOperations operations.

ApplicationGatewaysOperations(client, config, serializer, deserializer)
Inheritance
builtins.object
ApplicationGatewaysOperations

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

api_version
class
Client API version. Constant value: "2018-08-01".

Methods

backend_health(resource_group_name, application_gateway_name, expand=None, custom_headers=None, raw=False, polling=True, **operation_config)

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

create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates or updates the specified application gateway.

delete(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified application gateway.

get(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)

Gets the specified application gateway.

get_ssl_predefined_policy(predefined_policy_name, custom_headers=None, raw=False, **operation_config)

Gets Ssl predefined policy with the specified policy name.

list(resource_group_name, custom_headers=None, raw=False, **operation_config)

Lists all application gateways in a resource group.

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the application gateways in a subscription.

list_available_ssl_options(custom_headers=None, raw=False, **operation_config)

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_predefined_policies(custom_headers=None, raw=False, **operation_config)

Lists all SSL predefined policies for configuring Ssl policy.

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)

Lists all available web application firewall rule sets.

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Starts the specified application gateway.

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Stops the specified application gateway in a resource group.

update_tags(resource_group_name, application_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates the specified application gateway tags.

backend_health(resource_group_name, application_gateway_name, expand=None, custom_headers=None, raw=False, polling=True, **operation_config)

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

backend_health(resource_group_name, application_gateway_name, expand=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

expand
str

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns ApplicationGatewayBackendHealth or ClientRawResponse if raw==True

Return type

Exceptions

create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates or updates the specified application gateway.

create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

parameters
ApplicationGateway

Parameters supplied to the create or update application gateway operation.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns ApplicationGateway or ClientRawResponse if raw==True

Return type

Exceptions

delete(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified application gateway.

delete(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

get(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)

Gets the specified application gateway.

get(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ApplicationGateway or ClientRawResponse if raw=true

Return type

Exceptions

get_ssl_predefined_policy(predefined_policy_name, custom_headers=None, raw=False, **operation_config)

Gets Ssl predefined policy with the specified policy name.

get_ssl_predefined_policy(predefined_policy_name, custom_headers=None, raw=False, **operation_config)

Parameters

predefined_policy_name
str

Name of Ssl predefined policy.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ApplicationGatewaySslPredefinedPolicy or ClientRawResponse if raw=true

Return type

Exceptions

list(resource_group_name, custom_headers=None, raw=False, **operation_config)

Lists all application gateways in a resource group.

list(resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of ApplicationGateway

Return type

Exceptions

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the application gateways in a subscription.

list_all(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of ApplicationGateway

Return type

Exceptions

list_available_ssl_options(custom_headers=None, raw=False, **operation_config)

Lists available Ssl options for configuring Ssl policy.

list_available_ssl_options(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ApplicationGatewayAvailableSslOptions or ClientRawResponse if raw=true

Return type

Exceptions

list_available_ssl_predefined_policies(custom_headers=None, raw=False, **operation_config)

Lists all SSL predefined policies for configuring Ssl policy.

list_available_ssl_predefined_policies(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of ApplicationGatewaySslPredefinedPolicy

Return type

Exceptions

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)

Lists all available web application firewall rule sets.

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ApplicationGatewayAvailableWafRuleSetsResult or ClientRawResponse if raw=true

Return type

Exceptions

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Starts the specified application gateway.

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Stops the specified application gateway in a resource group.

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

update_tags(resource_group_name, application_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates the specified application gateway tags.

update_tags(resource_group_name, application_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

application_gateway_name
str

The name of the application gateway.

tags
dict[str or str]

Resource tags.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns ApplicationGateway or ClientRawResponse if raw==True

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.network.v2018_08_01.models' from 'c:\\program files (x86)\\microsoft visual studio\\shared\\python36_64\\lib\\site-packages\\azure\\mgmt\\network\\v2018_08_01\\models\\__init__.py'>