azure.mgmt.frontdoor.operations module

class azure.mgmt.frontdoor.operations.EndpointsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s endpoints attribute.

begin_purge_content(resource_group_name: str, front_door_name: str, content_file_paths: _models.PurgeParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_purge_content(resource_group_name: str, front_door_name: str, content_file_paths: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Removes a content from Front Door.

Parameters

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

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

  • content_file_paths (PurgeParameters or IO) – The path to the content to be purged. Path can be a full URL, e.g. ‘/pictures/city.png’ which removes a single file, or a directory with a wildcard, e.g. ‘/pictures/*’ which removes all folders and files in the directory. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ExperimentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s experiments attribute.

begin_create_or_update(resource_group_name: str, profile_name: str, experiment_name: str, parameters: _models.Experiment, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Experiment][source]
begin_create_or_update(resource_group_name: str, profile_name: str, experiment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Experiment]

Creates or updates an Experiment.

Creates or updates an Experiment.

Parameters

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

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

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

  • parameters (Experiment or IO) – The Experiment resource. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Experiment]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, experiment_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an Experiment.

Deletes an Experiment.

Parameters

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

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

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, experiment_name: str, parameters: _models.ExperimentUpdateModel, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Experiment][source]
begin_update(resource_group_name: str, profile_name: str, experiment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Experiment]

Updates an Experiment by Experiment id.

Updates an Experiment.

Parameters

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

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

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

  • parameters (ExperimentUpdateModel or IO) – The Experiment Update Model. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Experiment]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, experiment_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.Experiment[source]

Gets an Experiment by ExperimentName.

Gets an Experiment by ExperimentName.

Parameters

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

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Experiment or the result of cls(response)

Return type

Experiment

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.Experiment][source]

Gets a list of Experiments.

Gets a list of Experiments.

Parameters

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Experiment]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontDoorNameAvailabilityOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s front_door_name_availability attribute.

check(check_front_door_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput[source]
check(check_front_door_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

Check the availability of a Front Door resource name.

Parameters

check_front_door_name_availability_input (CheckNameAvailabilityInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontDoorNameAvailabilityWithSubscriptionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s front_door_name_availability_with_subscription attribute.

check(check_front_door_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput[source]
check(check_front_door_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

Check the availability of a Front Door subdomain.

Parameters

check_front_door_name_availability_input (CheckNameAvailabilityInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontDoorsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s front_doors attribute.

begin_create_or_update(resource_group_name: str, front_door_name: str, front_door_parameters: _models.FrontDoor, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FrontDoor][source]
begin_create_or_update(resource_group_name: str, front_door_name: str, front_door_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FrontDoor]

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

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

  • front_door_parameters (FrontDoor or IO) – Front Door properties needed to create a new Front Door. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[FrontDoor]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, front_door_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Front Door with the specified parameters.

Parameters

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

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, front_door_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.FrontDoor[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. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FrontDoor or the result of cls(response)

Return type

FrontDoor

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.FrontDoor][source]

Lists all of the Front Doors within an Azure subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[FrontDoor]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.FrontDoor][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. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[FrontDoor]

Raises

HttpResponseError –

validate_custom_domain(resource_group_name: str, front_door_name: str, custom_domain_properties: _models.ValidateCustomDomainInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput[source]
validate_custom_domain(resource_group_name: str, front_door_name: str, custom_domain_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput

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

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

  • custom_domain_properties (ValidateCustomDomainInput or IO) – Custom domain to be validated. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

ValidateCustomDomainOutput or the result of cls(response)

Return type

ValidateCustomDomainOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.FrontendEndpointsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s frontend_endpoints attribute.

begin_disable_https(resource_group_name: str, front_door_name: str, frontend_endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Disables a frontendEndpoint for HTTPS traffic.

Parameters

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

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

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

begin_enable_https(resource_group_name: str, front_door_name: str, frontend_endpoint_name: str, custom_https_configuration: _models.CustomHttpsConfiguration, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_enable_https(resource_group_name: str, front_door_name: str, frontend_endpoint_name: str, custom_https_configuration: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Enables a frontendEndpoint for HTTPS traffic.

Parameters

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

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

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

  • custom_https_configuration (CustomHttpsConfiguration or IO) – The configuration specifying how to enable HTTPS. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, front_door_name: str, frontend_endpoint_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.FrontendEndpoint[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. Required.

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FrontendEndpoint or the result of cls(response)

Return type

FrontendEndpoint

Raises

HttpResponseError –

list_by_front_door(resource_group_name: str, front_door_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.FrontendEndpoint][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. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[FrontendEndpoint]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ManagedRuleSetsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s managed_rule_sets attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.ManagedRuleSetDefinition][source]

Lists all available managed rule sets.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ManagedRuleSetDefinition]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.NetworkExperimentProfilesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s network_experiment_profiles attribute.

begin_create_or_update(profile_name: str, resource_group_name: str, parameters: _models.Profile, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile][source]
begin_create_or_update(profile_name: str, resource_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

Creates an NetworkExperiment Profile.

Creates an NetworkExperiment Profile.

Parameters

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

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

  • parameters (Profile or IO) – An Network Experiment Profile. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Profile]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an NetworkExperiment Profile by ProfileName.

Deletes an NetworkExperiment Profile by ProfileName.

Parameters

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

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, parameters: _models.ProfileUpdateModel, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile][source]
begin_update(resource_group_name: str, profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

Updates an NetworkExperimentProfiles by NetworkExperimentProfile name.

Updates an NetworkExperimentProfiles.

Parameters

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

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

  • parameters (ProfileUpdateModel or IO) – The Profile Update Model. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Profile]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.Profile[source]

Gets an NetworkExperiment Profile by ProfileName.

Gets an NetworkExperiment Profile by ProfileName.

Parameters

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Profile or the result of cls(response)

Return type

Profile

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.Profile][source]

Gets a list of Network Experiment Profiles under a subscription.

Gets a list of Network Experiment Profiles under a subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Profile]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.Profile][source]

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Profile]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.PoliciesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s policies attribute.

begin_create_or_update(resource_group_name: str, policy_name: str, parameters: _models.WebApplicationFirewallPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WebApplicationFirewallPolicy][source]
begin_create_or_update(resource_group_name: str, policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WebApplicationFirewallPolicy]

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

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

  • parameters (WebApplicationFirewallPolicy or IO) – Policy to be created. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[WebApplicationFirewallPolicy]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, policy_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes Policy.

Parameters

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

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, policy_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WebApplicationFirewallPolicy][source]
begin_update(resource_group_name: str, policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WebApplicationFirewallPolicy]

Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.

Parameters

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

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

  • parameters (TagsObject or IO) – FrontdoorWebApplicationFirewallPolicy parameters to be patched. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[WebApplicationFirewallPolicy]

Raises

HttpResponseError –

get(resource_group_name: str, policy_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.WebApplicationFirewallPolicy[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. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WebApplicationFirewallPolicy or the result of cls(response)

Return type

WebApplicationFirewallPolicy

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.WebApplicationFirewallPolicy][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. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[WebApplicationFirewallPolicy]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.PreconfiguredEndpointsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s preconfigured_endpoints attribute.

list(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.PreconfiguredEndpoint][source]

Gets a list of Preconfigured Endpoints.

Gets a list of Preconfigured Endpoints.

Parameters

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PreconfiguredEndpoint]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.ReportsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s reports attribute.

get_latency_scorecards(resource_group_name: str, profile_name: str, experiment_name: str, aggregation_interval: Union[str, azure.mgmt.frontdoor.models._front_door_management_client_enums.LatencyScorecardAggregationInterval], end_date_time_utc: Optional[str] = None, country: Optional[str] = None, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.LatencyScorecard[source]

Gets a Latency Scorecard for a given Experiment.

Gets a Latency Scorecard for a given Experiment.

Parameters

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

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

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

  • aggregation_interval (str or LatencyScorecardAggregationInterval) – The aggregation interval of the Latency Scorecard. Known values are: “Daily”, “Weekly”, and “Monthly”. Required.

  • end_date_time_utc (str) – The end DateTime of the Latency Scorecard in UTC. Default value is None.

  • 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. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LatencyScorecard or the result of cls(response)

Return type

LatencyScorecard

Raises

HttpResponseError –

get_timeseries(resource_group_name: str, profile_name: str, experiment_name: str, start_date_time_utc: datetime.datetime, end_date_time_utc: datetime.datetime, aggregation_interval: Union[str, azure.mgmt.frontdoor.models._front_door_management_client_enums.TimeseriesAggregationInterval], timeseries_type: Union[str, azure.mgmt.frontdoor.models._front_door_management_client_enums.TimeseriesType], endpoint: Optional[str] = None, country: Optional[str] = None, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.Timeseries[source]

Gets a Timeseries for a given Experiment.

Gets a Timeseries for a given Experiment.

Parameters

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

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

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

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

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

  • aggregation_interval (str or TimeseriesAggregationInterval) – The aggregation interval of the Timeseries. Known values are: “Hourly” and “Daily”. Required.

  • timeseries_type (str or TimeseriesType) – The type of Timeseries. Known values are: “MeasurementCounts”, “LatencyP50”, “LatencyP75”, and “LatencyP95”. Required.

  • endpoint (str) – The specific endpoint. Default value is None.

  • 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. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Timeseries or the result of cls(response)

Return type

Timeseries

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>
class azure.mgmt.frontdoor.operations.RulesEnginesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through FrontDoorManagementClient’s rules_engines attribute.

begin_create_or_update(resource_group_name: str, front_door_name: str, rules_engine_name: str, rules_engine_parameters: _models.RulesEngine, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RulesEngine][source]
begin_create_or_update(resource_group_name: str, front_door_name: str, rules_engine_name: str, rules_engine_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RulesEngine]

Creates a new Rules Engine Configuration with the specified name within the specified Front Door.

Parameters

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

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

  • rules_engine_name (str) – Name of the Rules Engine which is unique within the Front Door. Required.

  • rules_engine_parameters (RulesEngine or IO) – Rules Engine Configuration properties needed to create a new Rules Engine Configuration. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[RulesEngine]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, front_door_name: str, rules_engine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Rules Engine Configuration with the specified parameters.

Parameters

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

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

  • rules_engine_name (str) – Name of the Rules Engine which is unique within the Front Door. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, front_door_name: str, rules_engine_name: str, **kwargs: Any) → azure.mgmt.frontdoor.models._models_py3.RulesEngine[source]

Gets a Rules Engine Configuration with the specified name within the specified Front Door.

Parameters

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

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

  • rules_engine_name (str) – Name of the Rules Engine which is unique within the Front Door. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RulesEngine or the result of cls(response)

Return type

RulesEngine

Raises

HttpResponseError –

list_by_front_door(resource_group_name: str, front_door_name: str, **kwargs: Any) → Iterable[azure.mgmt.frontdoor.models._models_py3.RulesEngine][source]

Lists all of the Rules Engine Configurations within a Front Door.

Parameters

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RulesEngine]

Raises

HttpResponseError –

models = <module 'azure.mgmt.frontdoor.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-frontdoor/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/frontdoor/models/__init__.py'>