azure.mgmt.frontdoor.operations module

class azure.mgmt.frontdoor.operations.NetworkExperimentProfilesOperations(client, config, serializer, deserializer)[source]

Bases: object

NetworkExperimentProfilesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-11-01”.

create_or_update(profile_name, resource_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates an NetworkExperiment Profile.

Parameters

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • parameters (Profile) – An Network Experiment Profile

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns Profile or ClientRawResponse<Profile> if raw==True

Return type

AzureOperationPoller[Profile] or AzureOperationPoller[ClientRawResponse[Profile]]

Raises

ErrorResponseException

delete(resource_group_name, profile_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes an NetworkExperiment Profile by ProfileName.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

get(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an NetworkExperiment Profile by ProfileName.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Profile or ClientRawResponse if raw=true

Return type

Profile or ClientRawResponse

Raises

ErrorResponseException

list(custom_headers=None, raw=False, **operation_config)[source]

Gets a list of Network Experiment Profiles under a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Profile

Return type

ProfilePaged[Profile]

Raises

ErrorResponseException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a list of Network Experiment Profiles within a resource group under a subscription.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Profile

Return type

ProfilePaged[Profile]

Raises

ErrorResponseException

update(resource_group_name, profile_name, enabled_state=None, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates an NetworkExperimentProfiles by NetworkExperimentProfile name.

Updates an NetworkExperimentProfiles.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • enabled_state (str or State) – The enabled state of the Profile. Possible values include: ‘Enabled’, ‘Disabled’

  • tags (dict[str, str]) – Resource tags.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns Profile or ClientRawResponse<Profile> if raw==True

Return type

AzureOperationPoller[Profile] or AzureOperationPoller[ClientRawResponse[Profile]]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.PreconfiguredEndpointsOperations(client, config, serializer, deserializer)[source]

Bases: object

PreconfiguredEndpointsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-11-01”.

list(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a list of Preconfigured Endpoints.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of PreconfiguredEndpoint

Return type

PreconfiguredEndpointPaged[PreconfiguredEndpoint]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ExperimentsOperations(client, config, serializer, deserializer)[source]

Bases: object

ExperimentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-11-01”.

create_or_update(resource_group_name, profile_name, experiment_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates an Experiment.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • parameters (Experiment) – The Experiment resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns Experiment or ClientRawResponse<Experiment> if raw==True

Return type

AzureOperationPoller[Experiment] or AzureOperationPoller[ClientRawResponse[Experiment]]

Raises

ErrorResponseException

delete(resource_group_name, profile_name, experiment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes an Experiment.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

get(resource_group_name, profile_name, experiment_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an Experiment by ExperimentName.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Experiment or ClientRawResponse if raw=true

Return type

Experiment or ClientRawResponse

Raises

ErrorResponseException

list_by_profile(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a list of Experiments.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Experiment

Return type

ExperimentPaged[Experiment]

Raises

ErrorResponseException

update(resource_group_name, profile_name, experiment_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates an Experiment by Experiment id.

Updates an Experiment.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • parameters (ExperimentUpdateModel) – The Experiment Update Model

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns Experiment or ClientRawResponse<Experiment> if raw==True

Return type

AzureOperationPoller[Experiment] or AzureOperationPoller[ClientRawResponse[Experiment]]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ReportsOperations(client, config, serializer, deserializer)[source]

Bases: object

ReportsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-11-01”.

get_latency_scorecards(resource_group_name, profile_name, experiment_name, aggregation_interval, end_date_time_utc=None, country=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a Latency Scorecard for a given Experiment.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • aggregation_interval (str or LatencyScorecardAggregationInterval) – The aggregation interval of the Latency Scorecard. Possible values include: ‘Daily’, ‘Weekly’, ‘Monthly’

  • end_date_time_utc (str) – The end DateTime of the Latency Scorecard in UTC

  • country (str) – The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

LatencyScorecard or ClientRawResponse if raw=true

Return type

LatencyScorecard or ClientRawResponse

Raises

ErrorResponseException

get_timeseries(resource_group_name, profile_name, experiment_name, start_date_time_utc, end_date_time_utc, aggregation_interval, timeseries_type, endpoint=None, country=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a Timeseries for a given Experiment.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • profile_name (str) – The Profile identifier associated with the Tenant and Partner

  • experiment_name (str) – The Experiment identifier associated with the Experiment

  • start_date_time_utc (datetime) – The start DateTime of the Timeseries in UTC

  • end_date_time_utc (datetime) – The end DateTime of the Timeseries in UTC

  • aggregation_interval (str or TimeseriesAggregationInterval) – The aggregation interval of the Timeseries. Possible values include: ‘Hourly’, ‘Daily’

  • timeseries_type (str or TimeseriesType) – The type of Timeseries. Possible values include: ‘MeasurementCounts’, ‘LatencyP50’, ‘LatencyP75’, ‘LatencyP95’

  • endpoint (str) – The specific endpoint

  • country (str) – The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Timeseries or ClientRawResponse if raw=true

Return type

Timeseries or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontDoorsOperations(client, config, serializer, deserializer)[source]

Bases: object

FrontDoorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-05-01”.

create_or_update(resource_group_name, front_door_name, front_door_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates a new Front Door with a Front Door name under the specified subscription and resource group.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • front_door_parameters (FrontDoor) – Front Door properties needed to create a new Front Door.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns FrontDoor or ClientRawResponse<FrontDoor> if raw==True

Return type

AzureOperationPoller[FrontDoor] or AzureOperationPoller[ClientRawResponse[FrontDoor]]

Raises

ErrorResponseException

delete(resource_group_name, front_door_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes an existing Front Door with the specified parameters.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

get(resource_group_name, front_door_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Front Door with the specified Front Door name under the specified subscription and resource group.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

FrontDoor or ClientRawResponse if raw=true

Return type

FrontDoor or ClientRawResponse

Raises

ErrorResponseException

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the Front Doors within an Azure subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of FrontDoor

Return type

FrontDoorPaged[FrontDoor]

Raises

ErrorResponseException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the Front Doors within a resource group under a subscription.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of FrontDoor

Return type

FrontDoorPaged[FrontDoor]

Raises

ErrorResponseException

validate_custom_domain(resource_group_name, front_door_name, host_name, custom_headers=None, raw=False, **operation_config)[source]

Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • host_name (str) – The host name of the custom domain. Must be a domain name.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ValidateCustomDomainOutput or ClientRawResponse if raw=true

Return type

ValidateCustomDomainOutput or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontendEndpointsOperations(client, config, serializer, deserializer)[source]

Bases: object

FrontendEndpointsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-05-01”.

disable_https(resource_group_name, front_door_name, frontend_endpoint_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Disables a frontendEndpoint for HTTPS traffic.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • frontend_endpoint_name (str) – Name of the Frontend endpoint which is unique within the Front Door.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

enable_https(resource_group_name, front_door_name, frontend_endpoint_name, custom_https_configuration, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Enables a frontendEndpoint for HTTPS traffic.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • frontend_endpoint_name (str) – Name of the Frontend endpoint which is unique within the Front Door.

  • custom_https_configuration (CustomHttpsConfiguration) – The configuration specifying how to enable HTTPS

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

get(resource_group_name, front_door_name, frontend_endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Frontend endpoint with the specified name within the specified Front Door.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • frontend_endpoint_name (str) – Name of the Frontend endpoint which is unique within the Front Door.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

FrontendEndpoint or ClientRawResponse if raw=true

Return type

FrontendEndpoint or ClientRawResponse

Raises

ErrorResponseException

list_by_front_door(resource_group_name, front_door_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the frontend endpoints within a Front Door.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of FrontendEndpoint

Return type

FrontendEndpointPaged[FrontendEndpoint]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.EndpointsOperations(client, config, serializer, deserializer)[source]

Bases: object

EndpointsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-05-01”.

purge_content(resource_group_name, front_door_name, content_paths, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Removes a content from Front Door.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • front_door_name (str) – Name of the Front Door which is globally unique.

  • content_paths (list[str]) – The path to the content to be purged. Can describe a file path or a wild card directory.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.PoliciesOperations(client, config, serializer, deserializer)[source]

Bases: object

PoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-10-01”.

create_or_update(resource_group_name, policy_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update policy with specified rule set name within a resource group.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • policy_name (str) – The name of the Web Application Firewall Policy.

  • parameters (WebApplicationFirewallPolicy) – Policy to be created.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns WebApplicationFirewallPolicy or ClientRawResponse<WebApplicationFirewallPolicy> if raw==True

Return type

AzureOperationPoller[WebApplicationFirewallPolicy] or AzureOperationPoller[ClientRawResponse[WebApplicationFirewallPolicy]]

Raises

ErrorResponseException

delete(resource_group_name, policy_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes Policy.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • policy_name (str) – The name of the Web Application Firewall Policy.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, policy_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve protection policy with specified name within a resource group.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • policy_name (str) – The name of the Web Application Firewall Policy.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

WebApplicationFirewallPolicy or ClientRawResponse if raw=true

Return type

WebApplicationFirewallPolicy or ClientRawResponse

Raises

ErrorResponseException

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

Lists all of the protection policies within a resource group.

Parameters

  • resource_group_name (str) – Name of the Resource group within the Azure subscription.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of WebApplicationFirewallPolicy

Return type

WebApplicationFirewallPolicyPaged[WebApplicationFirewallPolicy]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ManagedRuleSetsOperations(client, config, serializer, deserializer)[source]

Bases: object

ManagedRuleSetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-10-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all available managed rule sets.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedRuleSetDefinition

Return type

ManagedRuleSetDefinitionPaged[ManagedRuleSetDefinition]

Raises

ErrorResponseException

models = <module 'azure.mgmt.frontdoor.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontDoorManagementClientOperationsMixin[source]

Bases: object

check_front_door_name_availability(name, type, custom_headers=None, raw=False, **operation_config)[source]

Check the availability of a Front Door resource name.

Parameters

  • name (str) – The resource name to validate.

  • type (str or ResourceType) – The type of the resource whose name is to be validated. Possible values include: ‘Microsoft.Network/frontDoors’, ‘Microsoft.Network/frontDoors/frontendEndpoints’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityOutput or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityOutput or ClientRawResponse

Raises

ErrorResponseException

check_front_door_name_availability_with_subscription(name, type, custom_headers=None, raw=False, **operation_config)[source]

Check the availability of a Front Door subdomain.

Parameters

  • name (str) – The resource name to validate.

  • type (str or ResourceType) – The type of the resource whose name is to be validated. Possible values include: ‘Microsoft.Network/frontDoors’, ‘Microsoft.Network/frontDoors/frontendEndpoints’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityOutput or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityOutput or ClientRawResponse

Raises

ErrorResponseException