azure.mgmt.cdn.models module¶

class azure.mgmt.cdn.models.AFDDomain(*, tls_settings: Optional[_models.AFDDomainHttpsParameters] = None, azure_dns_zone: Optional[_models.ResourceReference] = None, pre_validated_custom_domain_resource_id: Optional[_models.ResourceReference] = None, host_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
profile_name (str) – The name of the profile which holds the domain.
tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
domain_validation_state (str or DomainValidationState) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: “Unknown”, “Submitting”, “Pending”, “Rejected”, “TimedOut”, “PendingRevalidation”, “Approved”, “RefreshingValidationToken”, and “InternalError”.
host_name (str) – The host name of the domain. Must be a domain name.
validation_properties (DomainValidationProperties) – Values the customer needs to validate domain ownership.

Keyword Arguments

tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.
host_name (str) – The host name of the domain. Must be a domain name.

class azure.mgmt.cdn.models.AFDDomainHttpsParameters(*, certificate_type: Union[str, _models.AfdCertificateType], minimum_tls_version: Optional[Union[str, _models.AfdMinimumTlsVersion]] = None, secret: Optional[_models.ResourceReference] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties to secure a domain.

All required parameters must be populated in order to send to Azure.

Variables

certificate_type (str or AfdCertificateType) – Defines the source of the SSL certificate. Required. Known values are: “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
minimum_tls_version (str or AfdMinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “TLS10” and “TLS12”.
secret (ResourceReference) – Resource reference to the secret. ie. subs/rg/profile/secret.

Keyword Arguments

certificate_type (str or AfdCertificateType) – Defines the source of the SSL certificate. Required. Known values are: “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
minimum_tls_version (str or AfdMinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “TLS10” and “TLS12”.
secret (ResourceReference) – Resource reference to the secret. ie. subs/rg/profile/secret.

class azure.mgmt.cdn.models.AFDDomainListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[AFDDomain]) – List of AzureFrontDoor domains within a profile.
next_link (str) – URL to get the next set of domain objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of domain objects if there are any.

class azure.mgmt.cdn.models.AFDDomainProperties(*, host_name: str, tls_settings: Optional[_models.AFDDomainHttpsParameters] = None, azure_dns_zone: Optional[_models.ResourceReference] = None, pre_validated_custom_domain_resource_id: Optional[_models.ResourceReference] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDDomainUpdatePropertiesParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the domain.
tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.
domain_validation_state (str or DomainValidationState) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: “Unknown”, “Submitting”, “Pending”, “Rejected”, “TimedOut”, “PendingRevalidation”, “Approved”, “RefreshingValidationToken”, and “InternalError”.
host_name (str) – The host name of the domain. Must be a domain name. Required.
validation_properties (DomainValidationProperties) – Values the customer needs to validate domain ownership.

Keyword Arguments

tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.
host_name (str) – The host name of the domain. Must be a domain name. Required.

class azure.mgmt.cdn.models.AFDDomainUpdateParameters(*, tls_settings: Optional[_models.AFDDomainHttpsParameters] = None, azure_dns_zone: Optional[_models.ResourceReference] = None, pre_validated_custom_domain_resource_id: Optional[_models.ResourceReference] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

profile_name (str) – The name of the profile which holds the domain.
tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.

Keyword Arguments

tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.

class azure.mgmt.cdn.models.AFDDomainUpdatePropertiesParameters(*, tls_settings: Optional[_models.AFDDomainHttpsParameters] = None, azure_dns_zone: Optional[_models.ResourceReference] = None, pre_validated_custom_domain_resource_id: Optional[_models.ResourceReference] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

profile_name (str) – The name of the profile which holds the domain.
tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.

Keyword Arguments

tls_settings (AFDDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
azure_dns_zone (ResourceReference) – Resource reference to the Azure DNS zone.
pre_validated_custom_domain_resource_id (ResourceReference) – Resource reference to the Azure resource where custom domain ownership was prevalidated.

class azure.mgmt.cdn.models.AFDEndpoint(*, location: str, tags: Optional[Dict[str, str]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, auto_generated_domain_name_label_scope: Optional[Union[str, _models.AutoGeneratedDomainNameLabelScope]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.TrackedResource

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
profile_name (str) – The name of the profile which holds the endpoint.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
host_name (str) – The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

class azure.mgmt.cdn.models.AFDEndpointListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[AFDEndpoint]) – List of AzureFrontDoor endpoints within a profile.
next_link (str) – URL to get the next set of endpoint objects if there is any.

Keyword Arguments

next_link (str) – URL to get the next set of endpoint objects if there is any.

class azure.mgmt.cdn.models.AFDEndpointProperties(*, enabled_state: Optional[Union[str, _models.EnabledState]] = None, auto_generated_domain_name_label_scope: Optional[Union[str, _models.AutoGeneratedDomainNameLabelScope]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDEndpointPropertiesUpdateParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties required to create an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the endpoint.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
host_name (str) – The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

Keyword Arguments

enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

class azure.mgmt.cdn.models.AFDEndpointPropertiesUpdateParameters(*, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object containing endpoint update parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

profile_name (str) – The name of the profile which holds the endpoint.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDEndpointProtocols(value)[source]¶

Bases: str, enum.Enum

Supported protocols for the customer’s endpoint.

HTTP = 'Http'¶

HTTPS = 'Https'¶

class azure.mgmt.cdn.models.AFDEndpointUpdateParameters(*, tags: Optional[Dict[str, str]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Properties required to create or update an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

tags (dict[str, str]) – Endpoint tags.
profile_name (str) – The name of the profile which holds the endpoint.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

tags (dict[str, str]) – Endpoint tags.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDOrigin(*, azure_origin: Optional[_models.ResourceReference] = None, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, shared_private_link_resource: Optional[_models.SharedPrivateLinkResourceProperties] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, enforce_certificate_name_check: bool = True, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
origin_group_name (str) – The name of the origin group which contains this origin.
azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.

Keyword Arguments

azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

class azure.mgmt.cdn.models.AFDOriginGroup(*, load_balancing_settings: Optional[_models.LoadBalancingSettingsParameters] = None, health_probe_settings: Optional[_models.HealthProbeParameters] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, session_affinity_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
profile_name (str) – The name of the profile which holds the origin group.
load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.

Keyword Arguments

load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDOriginGroupListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[AFDOriginGroup]) – List of CDN origin groups within an endpoint.
next_link (str) – URL to get the next set of origin objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of origin objects if there are any.

class azure.mgmt.cdn.models.AFDOriginGroupProperties(*, load_balancing_settings: Optional[_models.LoadBalancingSettingsParameters] = None, health_probe_settings: Optional[_models.HealthProbeParameters] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, session_affinity_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDOriginGroupUpdatePropertiesParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the origin group.
load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDOriginGroupUpdateParameters(*, load_balancing_settings: Optional[_models.LoadBalancingSettingsParameters] = None, health_probe_settings: Optional[_models.HealthProbeParameters] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, session_affinity_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

AFDOrigin group properties needed for origin group creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

profile_name (str) – The name of the profile which holds the origin group.
load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDOriginGroupUpdatePropertiesParameters(*, load_balancing_settings: Optional[_models.LoadBalancingSettingsParameters] = None, health_probe_settings: Optional[_models.HealthProbeParameters] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, session_affinity_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

profile_name (str) – The name of the profile which holds the origin group.
load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

load_balancing_settings (LoadBalancingSettingsParameters) – Load balancing settings for a backend pool.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
session_affinity_state (str or EnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.AFDOriginListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[AFDOrigin]) – List of CDN origins within an endpoint.
next_link (str) – URL to get the next set of origin objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of origin objects if there are any.

class azure.mgmt.cdn.models.AFDOriginProperties(*, azure_origin: Optional[_models.ResourceReference] = None, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, shared_private_link_resource: Optional[_models.SharedPrivateLinkResourceProperties] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, enforce_certificate_name_check: bool = True, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDOriginUpdatePropertiesParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
origin_group_name (str) – The name of the origin group which contains this origin.
azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

Keyword Arguments

azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

class azure.mgmt.cdn.models.AFDOriginUpdateParameters(*, azure_origin: Optional[_models.ResourceReference] = None, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, shared_private_link_resource: Optional[_models.SharedPrivateLinkResourceProperties] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, enforce_certificate_name_check: bool = True, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

AFDOrigin properties needed for origin update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

origin_group_name (str) – The name of the origin group which contains this origin.
azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

Keyword Arguments

azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

class azure.mgmt.cdn.models.AFDOriginUpdatePropertiesParameters(*, azure_origin: Optional[_models.ResourceReference] = None, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, shared_private_link_resource: Optional[_models.SharedPrivateLinkResourceProperties] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, enforce_certificate_name_check: bool = True, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

origin_group_name (str) – The name of the origin group which contains this origin.
azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

Keyword Arguments

azure_origin (ResourceReference) – Resource reference to the Azure origin resource.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
shared_private_link_resource (SharedPrivateLinkResourceProperties) – The properties of the private link resource for private origin.
enabled_state (str or EnabledState) – Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Known values are: “Enabled” and “Disabled”.
enforce_certificate_name_check (bool) – Whether to enable certificate name check at origin level.

class azure.mgmt.cdn.models.AFDStateProperties(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The tracking states for afd resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.

class azure.mgmt.cdn.models.ActionType(value)[source]¶

Bases: str, enum.Enum

Defines the action to take on rule match.

ALLOW = 'Allow'¶

BLOCK = 'Block'¶

LOG = 'Log'¶

REDIRECT = 'Redirect'¶

class azure.mgmt.cdn.models.ActivatedResourceReference(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Reference to another resource along with its state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
is_active (bool) – Whether the resource is active or inactive.

Keyword Arguments

id (str) – Resource ID.

class azure.mgmt.cdn.models.AfdCertificateType(value)[source]¶

Bases: str, enum.Enum

Defines the source of the SSL certificate.

AZURE_FIRST_PARTY_MANAGED_CERTIFICATE = 'AzureFirstPartyManagedCertificate'¶

CUSTOMER_CERTIFICATE = 'CustomerCertificate'¶

MANAGED_CERTIFICATE = 'ManagedCertificate'¶

class azure.mgmt.cdn.models.AfdErrorResponse(*, error: Optional[_models.ErrorDetail] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables: error (ErrorDetail) – The error object.
Keyword Arguments: error (ErrorDetail) – The error object.

class azure.mgmt.cdn.models.AfdMinimumTlsVersion(value)[source]¶

Bases: str, enum.Enum

TLS protocol version that will be used for Https.

TLS10 = 'TLS10'¶

TLS12 = 'TLS12'¶

class azure.mgmt.cdn.models.AfdProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cdn.models.AfdPurgeParameters(*, content_paths: List[str], domains: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Parameters required for content purge.

All required parameters must be populated in order to send to Azure.

Variables

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

Keyword Arguments

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

class azure.mgmt.cdn.models.AfdQueryStringCachingBehavior(value)[source]¶

Bases: str, enum.Enum

Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

IGNORE_QUERY_STRING = 'IgnoreQueryString'¶

IGNORE_SPECIFIED_QUERY_STRINGS = 'IgnoreSpecifiedQueryStrings'¶

INCLUDE_SPECIFIED_QUERY_STRINGS = 'IncludeSpecifiedQueryStrings'¶

USE_QUERY_STRING = 'UseQueryString'¶

class azure.mgmt.cdn.models.AfdRouteCacheConfiguration(*, query_string_caching_behavior: Optional[Union[str, _models.AfdQueryStringCachingBehavior]] = None, query_parameters: Optional[str] = None, compression_settings: Optional[_models.CompressionSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

Variables

query_string_caching_behavior (str or AfdQueryStringCachingBehavior) – Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. Known values are: “IgnoreQueryString”, “UseQueryString”, “IgnoreSpecifiedQueryStrings”, and “IncludeSpecifiedQueryStrings”.
query_parameters (str) – query parameters to include or exclude (comma separated).
compression_settings (CompressionSettings) – compression settings.

Keyword Arguments

query_string_caching_behavior (str or AfdQueryStringCachingBehavior) – Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. Known values are: “IgnoreQueryString”, “UseQueryString”, “IgnoreSpecifiedQueryStrings”, and “IncludeSpecifiedQueryStrings”.
query_parameters (str) – query parameters to include or exclude (comma separated).
compression_settings (CompressionSettings) – compression settings.

class azure.mgmt.cdn.models.Algorithm(value)[source]¶

Bases: str, enum.Enum

Algorithm to use for URL signing.

SHA256 = 'SHA256'¶

class azure.mgmt.cdn.models.AutoGeneratedDomainNameLabelScope(value)[source]¶

Bases: str, enum.Enum

Indicates the endpoint name reuse scope. The default value is TenantReuse.

NO_REUSE = 'NoReuse'¶

RESOURCE_GROUP_REUSE = 'ResourceGroupReuse'¶

SUBSCRIPTION_REUSE = 'SubscriptionReuse'¶

TENANT_REUSE = 'TenantReuse'¶

class azure.mgmt.cdn.models.AzureFirstPartyManagedCertificate(*, type: Optional[Union[str, _models.SecretType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Certificate

Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.

Keyword Arguments

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.

class azure.mgmt.cdn.models.AzureFirstPartyManagedCertificateParameters(**kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.SecretParameters

Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.

All required parameters must be populated in order to send to Azure.

Variables: type (str or SecretType) – The type of the secret resource. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.

class azure.mgmt.cdn.models.CacheBehavior(value)[source]¶

Bases: str, enum.Enum

Caching behavior for the requests.

BYPASS_CACHE = 'BypassCache'¶

OVERRIDE = 'Override'¶

SET_IF_MISSING = 'SetIfMissing'¶

class azure.mgmt.cdn.models.CacheConfiguration(*, query_string_caching_behavior: Optional[Union[str, _models.RuleQueryStringCachingBehavior]] = None, query_parameters: Optional[str] = None, is_compression_enabled: Optional[Union[str, _models.RuleIsCompressionEnabled]] = None, cache_behavior: Optional[Union[str, _models.RuleCacheBehavior]] = None, cache_duration: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

Variables

query_string_caching_behavior (str or RuleQueryStringCachingBehavior) – Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. Known values are: “IgnoreQueryString”, “UseQueryString”, “IgnoreSpecifiedQueryStrings”, and “IncludeSpecifiedQueryStrings”.
query_parameters (str) – query parameters to include or exclude (comma separated).
is_compression_enabled (str or RuleIsCompressionEnabled) – Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. Known values are: “Enabled” and “Disabled”.
cache_behavior (str or RuleCacheBehavior) – Caching behavior for the requests. Known values are: “HonorOrigin”, “OverrideAlways”, and “OverrideIfOriginMissing”.
cache_duration (str) – The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss.

Keyword Arguments

query_string_caching_behavior (str or RuleQueryStringCachingBehavior) – Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. Known values are: “IgnoreQueryString”, “UseQueryString”, “IgnoreSpecifiedQueryStrings”, and “IncludeSpecifiedQueryStrings”.
query_parameters (str) – query parameters to include or exclude (comma separated).
is_compression_enabled (str or RuleIsCompressionEnabled) – Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. Known values are: “Enabled” and “Disabled”.
cache_behavior (str or RuleCacheBehavior) – Caching behavior for the requests. Known values are: “HonorOrigin”, “OverrideAlways”, and “OverrideIfOriginMissing”.
cache_duration (str) – The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss.

class azure.mgmt.cdn.models.CacheExpirationActionParameters(*, type_name: Union[str, _models.CacheExpirationActionParametersTypeName], cache_behavior: Union[str, _models.CacheBehavior], cache_type: Union[str, _models.CacheType], cache_duration: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the cache expiration action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or CacheExpirationActionParametersTypeName) – Required. “DeliveryRuleCacheExpirationActionParameters”
cache_behavior (str or CacheBehavior) – Caching behavior for the requests. Required. Known values are: “BypassCache”, “Override”, and “SetIfMissing”.
cache_type (str or CacheType) – The level at which the content needs to be cached. Required. “All”
cache_duration (str) – The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss.

Keyword Arguments

type_name (str or CacheExpirationActionParametersTypeName) – Required. “DeliveryRuleCacheExpirationActionParameters”
cache_behavior (str or CacheBehavior) – Caching behavior for the requests. Required. Known values are: “BypassCache”, “Override”, and “SetIfMissing”.
cache_type (str or CacheType) – The level at which the content needs to be cached. Required. “All”
cache_duration (str) – The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss.

class azure.mgmt.cdn.models.CacheExpirationActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

CacheExpirationActionParametersTypeName.

DELIVERY_RULE_CACHE_EXPIRATION_ACTION_PARAMETERS = 'DeliveryRuleCacheExpirationActionParameters'¶

class azure.mgmt.cdn.models.CacheKeyQueryStringActionParameters(*, type_name: Union[str, _models.CacheKeyQueryStringActionParametersTypeName], query_string_behavior: Union[str, _models.QueryStringBehavior], query_parameters: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the cache-key query string action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or CacheKeyQueryStringActionParametersTypeName) – Required. “DeliveryRuleCacheKeyQueryStringBehaviorActionParameters”
query_string_behavior (str or QueryStringBehavior) – Caching behavior for the requests. Required. Known values are: “Include”, “IncludeAll”, “Exclude”, and “ExcludeAll”.
query_parameters (str) – query parameters to include or exclude (comma separated).

Keyword Arguments

type_name (str or CacheKeyQueryStringActionParametersTypeName) – Required. “DeliveryRuleCacheKeyQueryStringBehaviorActionParameters”
query_string_behavior (str or QueryStringBehavior) – Caching behavior for the requests. Required. Known values are: “Include”, “IncludeAll”, “Exclude”, and “ExcludeAll”.
query_parameters (str) – query parameters to include or exclude (comma separated).

class azure.mgmt.cdn.models.CacheKeyQueryStringActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

CacheKeyQueryStringActionParametersTypeName.

DELIVERY_RULE_CACHE_KEY_QUERY_STRING_BEHAVIOR_ACTION_PARAMETERS = 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters'¶

class azure.mgmt.cdn.models.CacheType(value)[source]¶

Bases: str, enum.Enum

The level at which the content needs to be cached.

ALL = 'All'¶

class azure.mgmt.cdn.models.CdnCertificateSourceParameters(*, type_name: Union[str, _models.CdnCertificateSourceParametersTypeName], certificate_type: Union[str, _models.CertificateType], **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for using CDN managed certificate for securing custom domain.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or CdnCertificateSourceParametersTypeName) – Required. “CdnCertificateSourceParameters”
certificate_type (str or CertificateType) – Type of certificate used. Required. Known values are: “Shared” and “Dedicated”.

Keyword Arguments

type_name (str or CdnCertificateSourceParametersTypeName) – Required. “CdnCertificateSourceParameters”
certificate_type (str or CertificateType) – Type of certificate used. Required. Known values are: “Shared” and “Dedicated”.

class azure.mgmt.cdn.models.CdnCertificateSourceParametersTypeName(value)[source]¶

Bases: str, enum.Enum

CdnCertificateSourceParametersTypeName.

CDN_CERTIFICATE_SOURCE_PARAMETERS = 'CdnCertificateSourceParameters'¶

class azure.mgmt.cdn.models.CdnEndpoint(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the ARM Resource ID for the linked endpoints.

Variables: id (str) – ARM Resource ID string.
Keyword Arguments: id (str) – ARM Resource ID string.

class azure.mgmt.cdn.models.CdnManagedHttpsParameters(*, protocol_type: Union[str, _models.ProtocolType], certificate_source_parameters: _models.CdnCertificateSourceParameters, minimum_tls_version: Optional[Union[str, _models.MinimumTlsVersion]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.CustomDomainHttpsParameters

Defines the certificate source parameters using CDN managed certificate for enabling SSL.

All required parameters must be populated in order to send to Azure.

Variables

certificate_source (str or CertificateSource) – Defines the source of the SSL certificate. Required. Known values are: “AzureKeyVault” and “Cdn”.
protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.
certificate_source_parameters (CdnCertificateSourceParameters) – Defines the certificate source parameters using CDN managed certificate for enabling SSL. Required.

Keyword Arguments

protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.
certificate_source_parameters (CdnCertificateSourceParameters) – Defines the certificate source parameters using CDN managed certificate for enabling SSL. Required.

class azure.mgmt.cdn.models.CdnWebApplicationFirewallPolicy(*, location: str, sku: _models.Sku, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, policy_settings: Optional[_models.PolicySettings] = None, rate_limit_rules: Optional[_models.RateLimitRuleList] = None, custom_rules: Optional[_models.CustomRuleList] = None, managed_rules: Optional[_models.ManagedRuleSetList] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.TrackedResource

Defines web application firewall policy for Azure CDN.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
sku (Sku) – The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. Required.
policy_settings (PolicySettings) – Describes policySettings for policy.
rate_limit_rules (RateLimitRuleList) – Describes rate limit rules inside the policy.
custom_rules (CustomRuleList) – Describes custom rules inside the policy.
managed_rules (ManagedRuleSetList) – Describes managed rules inside the policy.
endpoint_links (list[CdnEndpoint]) – Describes Azure CDN endpoints associated with this Web Application Firewall policy.
provisioning_state (str or ProvisioningState) – Provisioning state of the WebApplicationFirewallPolicy. Known values are: “Creating”, “Succeeded”, and “Failed”.
resource_state (str or PolicyResourceState) – Resource status of the policy. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Deleting”.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
sku (Sku) – The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. Required.
policy_settings (PolicySettings) – Describes policySettings for policy.
rate_limit_rules (RateLimitRuleList) – Describes rate limit rules inside the policy.
custom_rules (CustomRuleList) – Describes custom rules inside the policy.
managed_rules (ManagedRuleSetList) – Describes managed rules inside the policy.

class azure.mgmt.cdn.models.CdnWebApplicationFirewallPolicyList(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[CdnWebApplicationFirewallPolicy]) – List of Azure CDN WebApplicationFirewallPolicies within a resource group.
next_link (str) – URL to get the next set of WebApplicationFirewallPolicy objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of WebApplicationFirewallPolicy objects if there are any.

class azure.mgmt.cdn.models.CdnWebApplicationFirewallPolicyPatchParameters(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Properties required to update a CdnWebApplicationFirewallPolicy.

Variables: tags (dict[str, str]) – CdnWebApplicationFirewallPolicy tags.
Keyword Arguments: tags (dict[str, str]) – CdnWebApplicationFirewallPolicy tags.

class azure.mgmt.cdn.models.Certificate(*, type: Optional[Union[str, _models.SecretType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.

Keyword Arguments

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.

class azure.mgmt.cdn.models.CertificateSource(value)[source]¶

Bases: str, enum.Enum

Defines the source of the SSL certificate.

AZURE_KEY_VAULT = 'AzureKeyVault'¶

CDN = 'Cdn'¶

class azure.mgmt.cdn.models.CertificateType(value)[source]¶

Bases: str, enum.Enum

Type of certificate used.

DEDICATED = 'Dedicated'¶

SHARED = 'Shared'¶

class azure.mgmt.cdn.models.CheckEndpointNameAvailabilityInput(*, name: str, type: Union[str, _models.ResourceType], auto_generated_domain_name_label_scope: Optional[Union[str, _models.AutoGeneratedDomainNameLabelScope]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of CheckNameAvailability API.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Cdn/Profiles/Endpoints” and “Microsoft.Cdn/Profiles/AfdEndpoints”.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

Keyword Arguments

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Cdn/Profiles/Endpoints” and “Microsoft.Cdn/Profiles/AfdEndpoints”.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

class azure.mgmt.cdn.models.CheckEndpointNameAvailabilityOutput(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name_available (bool) – Indicates whether the name is available.
available_hostname (str) – Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string.
reason (str) – The reason why the name is not available.
message (str) – The detailed error message describing why the name is not available.

class azure.mgmt.cdn.models.CheckHostNameAvailabilityInput(*, host_name: str, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of CheckHostNameAvailability API.

All required parameters must be populated in order to send to Azure.

Variables: host_name (str) – The host name to validate. Required.
Keyword Arguments: host_name (str) – The host name to validate. Required.

class azure.mgmt.cdn.models.CheckNameAvailabilityInput(*, name: str, type: Union[str, _models.ResourceType], **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of CheckNameAvailability API.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Cdn/Profiles/Endpoints” and “Microsoft.Cdn/Profiles/AfdEndpoints”.

Keyword Arguments

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Cdn/Profiles/Endpoints” and “Microsoft.Cdn/Profiles/AfdEndpoints”.

class azure.mgmt.cdn.models.CheckNameAvailabilityOutput(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name_available (bool) – Indicates whether the name is available.
reason (str) – The reason why the name is not available.
message (str) – The detailed error message describing why the name is not available.

class azure.mgmt.cdn.models.CidrIpAddress(*, base_ip_address: Optional[str] = None, prefix_length: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

CIDR Ip address.

Variables

base_ip_address (str) – Ip address itself.
prefix_length (int) – The length of the prefix of the ip address.

Keyword Arguments

base_ip_address (str) – Ip address itself.
prefix_length (int) – The length of the prefix of the ip address.

class azure.mgmt.cdn.models.ClientPortMatchConditionParameters(*, type_name: Union[str, _models.ClientPortMatchConditionParametersTypeName], operator: Union[str, _models.ClientPortOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for ClientPort match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or ClientPortMatchConditionParametersTypeName) – Required. “DeliveryRuleClientPortConditionParameters”
operator (str or ClientPortOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or ClientPortMatchConditionParametersTypeName) – Required. “DeliveryRuleClientPortConditionParameters”
operator (str or ClientPortOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.ClientPortMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

ClientPortMatchConditionParametersTypeName.

DELIVERY_RULE_CLIENT_PORT_CONDITION_PARAMETERS = 'DeliveryRuleClientPortConditionParameters'¶

class azure.mgmt.cdn.models.ClientPortOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems(*, date_time: Optional[datetime.datetime] = None, value: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems.

Variables

date_time (datetime) –
value (float) –

Keyword Arguments

date_time (datetime) –
value (float) –

class azure.mgmt.cdn.models.Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems(*, date_time: Optional[datetime.datetime] = None, value: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems.

Variables

date_time (datetime) –
value (float) –

Keyword Arguments

date_time (datetime) –
value (float) –

class azure.mgmt.cdn.models.ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems(*, metric: Optional[str] = None, value: Optional[int] = None, percentage: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems.

Variables

metric (str) –
value (int) –
percentage (float) –

Keyword Arguments

metric (str) –
value (int) –
percentage (float) –

class azure.mgmt.cdn.models.CompressionSettings(*, content_types_to_compress: Optional[List[str]] = None, is_compression_enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

settings for compression.

Variables

content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
is_compression_enabled (bool) – Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

Keyword Arguments

content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
is_compression_enabled (bool) – Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

class azure.mgmt.cdn.models.ContinentsResponse(*, continents: Optional[List[_models.ContinentsResponseContinentsItem]] = None, country_or_regions: Optional[List[_models.ContinentsResponseCountryOrRegionsItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Continents Response.

Variables

continents (list[ContinentsResponseContinentsItem]) –
country_or_regions (list[ContinentsResponseCountryOrRegionsItem]) –

Keyword Arguments

continents (list[ContinentsResponseContinentsItem]) –
country_or_regions (list[ContinentsResponseCountryOrRegionsItem]) –

class azure.mgmt.cdn.models.ContinentsResponseContinentsItem(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ContinentsResponseContinentsItem.

Variables: id (str) –
Keyword Arguments: id (str) –

class azure.mgmt.cdn.models.ContinentsResponseCountryOrRegionsItem(*, id: Optional[str] = None, continent_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ContinentsResponseCountryOrRegionsItem.

Variables

id (str) –
continent_id (str) –

Keyword Arguments

id (str) –
continent_id (str) –

class azure.mgmt.cdn.models.CookiesMatchConditionParameters(*, type_name: Union[str, _models.CookiesMatchConditionParametersTypeName], operator: Union[str, _models.CookiesOperator], selector: Optional[str] = None, negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for Cookies match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or CookiesMatchConditionParametersTypeName) – Required. “DeliveryRuleCookiesConditionParameters”
selector (str) – Name of Cookies to be matched.
operator (str or CookiesOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or CookiesMatchConditionParametersTypeName) – Required. “DeliveryRuleCookiesConditionParameters”
selector (str) – Name of Cookies to be matched.
operator (str or CookiesOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.CookiesMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

CookiesMatchConditionParametersTypeName.

DELIVERY_RULE_COOKIES_CONDITION_PARAMETERS = 'DeliveryRuleCookiesConditionParameters'¶

class azure.mgmt.cdn.models.CookiesOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.CustomDomain(*, host_name: Optional[str] = None, custom_https_parameters: Optional[_models.CustomDomainHttpsParameters] = None, validation_data: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
host_name (str) – The host name of the custom domain. Must be a domain name.
resource_state (str or CustomDomainResourceState) – Resource status of the custom domain. Known values are: “Creating”, “Active”, and “Deleting”.
custom_https_provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of the custom domain. Known values are: “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Failed”.
custom_https_provisioning_substate (str or CustomHttpsProvisioningSubstate) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: “SubmittingDomainControlValidationRequest”, “PendingDomainControlValidationREquestApproval”, “DomainControlValidationRequestApproved”, “DomainControlValidationRequestRejected”, “DomainControlValidationRequestTimedOut”, “IssuingCertificate”, “DeployingCertificate”, “CertificateDeployed”, “DeletingCertificate”, and “CertificateDeleted”.
custom_https_parameters (CustomDomainHttpsParameters) – Certificate parameters for securing custom HTTPS.
validation_data (str) – Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.
provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of Custom Https of the custom domain. Known values are: “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Failed”.

Keyword Arguments

host_name (str) – The host name of the custom domain. Must be a domain name.
custom_https_parameters (CustomDomainHttpsParameters) – Certificate parameters for securing custom HTTPS.
validation_data (str) – Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

class azure.mgmt.cdn.models.CustomDomainHttpsParameters(*, protocol_type: Union[str, _models.ProtocolType], minimum_tls_version: Optional[Union[str, _models.MinimumTlsVersion]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties to secure a custom domain.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: UserManagedHttpsParameters, CdnManagedHttpsParameters

All required parameters must be populated in order to send to Azure.

Variables

certificate_source (str or CertificateSource) – Defines the source of the SSL certificate. Required. Known values are: “AzureKeyVault” and “Cdn”.
protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.

Keyword Arguments

protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.

class azure.mgmt.cdn.models.CustomDomainListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[CustomDomain]) – List of CDN CustomDomains within an endpoint.
next_link (str) – URL to get the next set of custom domain objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of custom domain objects if there are any.

class azure.mgmt.cdn.models.CustomDomainParameters(*, host_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The customDomain JSON object required for custom domain creation or update.

Variables: host_name (str) – The host name of the custom domain. Must be a domain name.
Keyword Arguments: host_name (str) – The host name of the custom domain. Must be a domain name.

class azure.mgmt.cdn.models.CustomDomainResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the custom domain.

ACTIVE = 'Active'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

class azure.mgmt.cdn.models.CustomHttpsProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the custom domain.

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

FAILED = 'Failed'¶

class azure.mgmt.cdn.models.CustomHttpsProvisioningSubstate(value)[source]¶

Bases: str, enum.Enum

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

CERTIFICATE_DELETED = 'CertificateDeleted'¶

CERTIFICATE_DEPLOYED = 'CertificateDeployed'¶

DELETING_CERTIFICATE = 'DeletingCertificate'¶

DEPLOYING_CERTIFICATE = 'DeployingCertificate'¶

DOMAIN_CONTROL_VALIDATION_REQUEST_APPROVED = 'DomainControlValidationRequestApproved'¶

DOMAIN_CONTROL_VALIDATION_REQUEST_REJECTED = 'DomainControlValidationRequestRejected'¶

DOMAIN_CONTROL_VALIDATION_REQUEST_TIMED_OUT = 'DomainControlValidationRequestTimedOut'¶

ISSUING_CERTIFICATE = 'IssuingCertificate'¶

PENDING_DOMAIN_CONTROL_VALIDATION_R_EQUEST_APPROVAL = 'PendingDomainControlValidationREquestApproval'¶

SUBMITTING_DOMAIN_CONTROL_VALIDATION_REQUEST = 'SubmittingDomainControlValidationRequest'¶

class azure.mgmt.cdn.models.CustomRule(*, name: str, priority: int, match_conditions: List[_models.MatchCondition], action: Union[str, _models.ActionType], enabled_state: Optional[Union[str, _models.CustomRuleEnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the common attributes for a custom rule that can be included in a waf policy.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Defines the name of the custom rule. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
priority (int) – Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions (list[MatchCondition]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

Keyword Arguments

name (str) – Defines the name of the custom rule. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
priority (int) – Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions (list[MatchCondition]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

class azure.mgmt.cdn.models.CustomRuleEnabledState(value)[source]¶

Bases: str, enum.Enum

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.CustomRuleList(*, rules: Optional[List[_models.CustomRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines contents of custom rules.

Variables: rules (list[CustomRule]) – List of rules.
Keyword Arguments: rules (list[CustomRule]) – List of rules.

class azure.mgmt.cdn.models.CustomerCertificate(*, type: Optional[Union[str, _models.SecretType]] = None, secret_source: Optional[_models.ResourceReference] = None, secret_version: Optional[str] = None, use_latest_version: Optional[bool] = None, subject_alternative_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Certificate

Customer Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}.
secret_version (str) – Certificate version.
certificate_authority (str) – Certificate issuing authority.
use_latest_version (bool) – Whether to use the latest version for the certificate.
subject_alternative_names (list[str]) – The list of SANs.
thumbprint (str) – Certificate thumbprint.

Keyword Arguments

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}.
secret_version (str) – Certificate version.
use_latest_version (bool) – Whether to use the latest version for the certificate.
subject_alternative_names (list[str]) – The list of SANs.

class azure.mgmt.cdn.models.CustomerCertificateParameters(*, secret_source: _models.ResourceReference, secret_version: Optional[str] = None, use_latest_version: Optional[bool] = None, subject_alternative_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.SecretParameters

Customer Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

type (str or SecretType) – The type of the secret resource. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}. Required.
secret_version (str) – Version of the secret to be used.
use_latest_version (bool) – Whether to use the latest version for the certificate.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.
certificate_authority (str) – Certificate issuing authority.
subject_alternative_names (list[str]) – The list of SANs.
thumbprint (str) – Certificate thumbprint.

Keyword Arguments

secret_source (ResourceReference) – Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}. Required.
secret_version (str) – Version of the secret to be used.
use_latest_version (bool) – Whether to use the latest version for the certificate.
subject_alternative_names (list[str]) – The list of SANs.

class azure.mgmt.cdn.models.DeepCreatedCustomDomain(*, name: str, host_name: Optional[str] = None, validation_data: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Custom domains created on the CDN endpoint.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Custom domain name. Required.
host_name (str) – The host name of the custom domain. Must be a domain name.
validation_data (str) – Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

Keyword Arguments

name (str) – Custom domain name. Required.
host_name (str) – The host name of the custom domain. Must be a domain name.
validation_data (str) – Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

class azure.mgmt.cdn.models.DeepCreatedOrigin(*, name: str, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, enabled: Optional[bool] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The main origin of CDN content which is added when creating a CDN endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Origin name which must be unique within the endpoint. Required.
host_name (str) – The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not. By default, origin is always enabled.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.
private_endpoint_status (str or PrivateEndpointStatus) – The approval status for the connection to the Private Link. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.

Keyword Arguments

name (str) – Origin name which must be unique within the endpoint. Required.
host_name (str) – The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not. By default, origin is always enabled.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

class azure.mgmt.cdn.models.DeepCreatedOriginGroup(*, name: str, health_probe_settings: Optional[_models.HealthProbeParameters] = None, origins: Optional[List[_models.ResourceReference]] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, response_based_origin_error_detection_settings: Optional[_models.ResponseBasedOriginErrorDetectionParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Origin group name which must be unique within the endpoint. Required.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.

Keyword Arguments

name (str) – Origin group name which must be unique within the endpoint. Required.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.

class azure.mgmt.cdn.models.DeleteRule(value)[source]¶

Bases: str, enum.Enum

Describes the action that shall be taken when the certificate is removed from Key Vault.

NO_ACTION = 'NoAction'¶

class azure.mgmt.cdn.models.DeliveryRule(*, order: int, actions: List[_models.DeliveryRuleAction], name: Optional[str] = None, conditions: Optional[List[_models.DeliveryRuleCondition]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

A rule that specifies a set of actions and conditions.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Name of the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. Required.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied. Required.

Keyword Arguments

name (str) – Name of the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. Required.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied. Required.

class azure.mgmt.cdn.models.DeliveryRuleAction(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

An action for the delivery rule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeliveryRuleCacheExpirationAction, DeliveryRuleCacheKeyQueryStringAction, DeliveryRuleRequestHeaderAction, DeliveryRuleResponseHeaderAction, OriginGroupOverrideAction, DeliveryRuleRouteConfigurationOverrideAction, UrlRedirectAction, UrlRewriteAction, UrlSigningAction

All required parameters must be populated in order to send to Azure.

Variables: name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.

class azure.mgmt.cdn.models.DeliveryRuleActionEnum(value)[source]¶

Bases: str, enum.Enum

The name of the action for the delivery rule.

CACHE_EXPIRATION = 'CacheExpiration'¶

CACHE_KEY_QUERY_STRING = 'CacheKeyQueryString'¶

MODIFY_REQUEST_HEADER = 'ModifyRequestHeader'¶

MODIFY_RESPONSE_HEADER = 'ModifyResponseHeader'¶

ORIGIN_GROUP_OVERRIDE = 'OriginGroupOverride'¶

ROUTE_CONFIGURATION_OVERRIDE = 'RouteConfigurationOverride'¶

URL_REDIRECT = 'UrlRedirect'¶

URL_REWRITE = 'UrlRewrite'¶

URL_SIGNING = 'UrlSigning'¶

class azure.mgmt.cdn.models.DeliveryRuleCacheExpirationAction(*, parameters: _models.CacheExpirationActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the cache expiration action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (CacheExpirationActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (CacheExpirationActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.DeliveryRuleCacheKeyQueryStringAction(*, parameters: _models.CacheKeyQueryStringActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the cache-key query string action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (CacheKeyQueryStringActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (CacheKeyQueryStringActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.DeliveryRuleClientPortCondition(*, parameters: _models.ClientPortMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the ClientPort condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (ClientPortMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (ClientPortMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleCondition(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

A condition for the delivery rule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeliveryRuleClientPortCondition, DeliveryRuleCookiesCondition, DeliveryRuleHostNameCondition, DeliveryRuleHttpVersionCondition, DeliveryRuleIsDeviceCondition, DeliveryRulePostArgsCondition, DeliveryRuleQueryStringCondition, DeliveryRuleRemoteAddressCondition, DeliveryRuleRequestBodyCondition, DeliveryRuleRequestHeaderCondition, DeliveryRuleRequestMethodCondition, DeliveryRuleRequestSchemeCondition, DeliveryRuleRequestUriCondition, DeliveryRuleServerPortCondition, DeliveryRuleSocketAddrCondition, DeliveryRuleSslProtocolCondition, DeliveryRuleUrlFileExtensionCondition, DeliveryRuleUrlFileNameCondition, DeliveryRuleUrlPathCondition

All required parameters must be populated in order to send to Azure.

Variables: name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.

class azure.mgmt.cdn.models.DeliveryRuleCookiesCondition(*, parameters: _models.CookiesMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the Cookies condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (CookiesMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (CookiesMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleHostNameCondition(*, parameters: _models.HostNameMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the HostName condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (HostNameMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (HostNameMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleHttpVersionCondition(*, parameters: _models.HttpVersionMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the HttpVersion condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (HttpVersionMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (HttpVersionMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleIsDeviceCondition(*, parameters: _models.IsDeviceMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the IsDevice condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (IsDeviceMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (IsDeviceMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRulePostArgsCondition(*, parameters: _models.PostArgsMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the PostArgs condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (PostArgsMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (PostArgsMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleQueryStringCondition(*, parameters: _models.QueryStringMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the QueryString condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (QueryStringMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (QueryStringMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRemoteAddressCondition(*, parameters: _models.RemoteAddressMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RemoteAddress condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RemoteAddressMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RemoteAddressMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestBodyCondition(*, parameters: _models.RequestBodyMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RequestBody condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RequestBodyMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RequestBodyMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestHeaderAction(*, parameters: _models.HeaderActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the request header action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (HeaderActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (HeaderActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestHeaderCondition(*, parameters: _models.RequestHeaderMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RequestHeader condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RequestHeaderMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RequestHeaderMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestMethodCondition(*, parameters: _models.RequestMethodMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RequestMethod condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RequestMethodMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RequestMethodMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestSchemeCondition(*, parameters: _models.RequestSchemeMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RequestScheme condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RequestSchemeMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RequestSchemeMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleRequestUriCondition(*, parameters: _models.RequestUriMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the RequestUri condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (RequestUriMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (RequestUriMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleResponseHeaderAction(*, parameters: _models.HeaderActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the response header action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (HeaderActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (HeaderActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.DeliveryRuleRouteConfigurationOverrideAction(*, parameters: _models.RouteConfigurationOverrideActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (RouteConfigurationOverrideActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (RouteConfigurationOverrideActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.DeliveryRuleServerPortCondition(*, parameters: _models.ServerPortMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the ServerPort condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (ServerPortMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (ServerPortMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleSocketAddrCondition(*, parameters: _models.SocketAddrMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the SocketAddress condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (SocketAddrMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (SocketAddrMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleSslProtocolCondition(*, parameters: _models.SslProtocolMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the SslProtocol condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (SslProtocolMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (SslProtocolMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleUrlFileExtensionCondition(*, parameters: _models.UrlFileExtensionMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the UrlFileExtension condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (UrlFileExtensionMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (UrlFileExtensionMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleUrlFileNameCondition(*, parameters: _models.UrlFileNameMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the UrlFileName condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (UrlFileNameMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (UrlFileNameMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeliveryRuleUrlPathCondition(*, parameters: _models.UrlPathMatchConditionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleCondition

Defines the UrlPath condition for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or MatchVariable) – The name of the condition for the delivery rule. Required. Known values are: “RemoteAddress”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “RequestScheme”, “UrlPath”, “UrlFileExtension”, “UrlFileName”, “HttpVersion”, “Cookies”, “IsDevice”, “SocketAddr”, “ClientPort”, “ServerPort”, “HostName”, and “SslProtocol”.
parameters (UrlPathMatchConditionParameters) – Defines the parameters for the condition. Required.

Keyword Arguments

parameters (UrlPathMatchConditionParameters) – Defines the parameters for the condition. Required.

class azure.mgmt.cdn.models.DeploymentStatus(value)[source]¶

Bases: str, enum.Enum

DeploymentStatus.

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

NOT_STARTED = 'NotStarted'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cdn.models.DestinationProtocol(value)[source]¶

Bases: str, enum.Enum

Protocol to use for the redirect. The default value is MatchRequest.

HTTP = 'Http'¶

HTTPS = 'Https'¶

MATCH_REQUEST = 'MatchRequest'¶

class azure.mgmt.cdn.models.DimensionProperties(*, name: Optional[str] = None, display_name: Optional[str] = None, internal_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Type of operation: get, read, delete, etc.

Variables

name (str) – Name of dimension.
display_name (str) – Display name of dimension.
internal_name (str) – Internal name of dimension.

Keyword Arguments

name (str) – Name of dimension.
display_name (str) – Display name of dimension.
internal_name (str) – Internal name of dimension.

class azure.mgmt.cdn.models.DomainValidationProperties(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties to validate a domain.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

validation_token (str) – Challenge used for DNS TXT record or file based validation.
expiration_date (str) – The date time that the token expires.

class azure.mgmt.cdn.models.DomainValidationState(value)[source]¶

Bases: str, enum.Enum

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.

APPROVED = 'Approved'¶

INTERNAL_ERROR = 'InternalError'¶

PENDING = 'Pending'¶

PENDING_REVALIDATION = 'PendingRevalidation'¶

REFRESHING_VALIDATION_TOKEN = 'RefreshingValidationToken'¶

REJECTED = 'Rejected'¶

SUBMITTING = 'Submitting'¶

TIMED_OUT = 'TimedOut'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.cdn.models.EdgeNode(*, ip_address_groups: Optional[List[_models.IpAddressGroup]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
ip_address_groups (list[IpAddressGroup]) – List of ip address groups.

Keyword Arguments

ip_address_groups (list[IpAddressGroup]) – List of ip address groups.

class azure.mgmt.cdn.models.EdgenodeResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[EdgeNode]) – Edge node of CDN service.
next_link (str) – URL to get the next set of edgenode list results if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of edgenode list results if there are any.

class azure.mgmt.cdn.models.EnabledState(value)[source]¶

Bases: str, enum.Enum

Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.Endpoint(*, location: str, tags: Optional[Dict[str, str]] = None, origin_path: Optional[str] = None, content_types_to_compress: Optional[List[str]] = None, origin_host_header: Optional[str] = None, is_compression_enabled: Optional[bool] = None, is_http_allowed: Optional[bool] = None, is_https_allowed: Optional[bool] = None, query_string_caching_behavior: Optional[Union[str, _models.QueryStringCachingBehavior]] = None, optimization_type: Optional[Union[str, _models.OptimizationType]] = None, probe_path: Optional[str] = None, geo_filters: Optional[List[_models.GeoFilter]] = None, default_origin_group: Optional[_models.ResourceReference] = None, url_signing_keys: Optional[List[_models.UrlSigningKey]] = None, delivery_policy: Optional[_models.EndpointPropertiesUpdateParametersDeliveryPolicy] = None, web_application_firewall_policy_link: Optional[_models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink] = None, origins: Optional[List[_models.DeepCreatedOrigin]] = None, origin_groups: Optional[List[_models.DeepCreatedOriginGroup]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.TrackedResource

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).
host_name (str) – The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
origins (list[DeepCreatedOrigin]) – The source of the content being delivered via CDN.
origin_groups (list[DeepCreatedOriginGroup]) – The origin groups comprising of origins that are used for load balancing the traffic based on availability.
custom_domains (list[DeepCreatedCustomDomain]) – The custom domains under the endpoint.
resource_state (str or EndpointResourceState) – Resource status of the endpoint. Known values are: “Creating”, “Deleting”, “Running”, “Starting”, “Stopped”, and “Stopping”.
provisioning_state (str or EndpointProvisioningState) – Provisioning status of the endpoint. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).
origins (list[DeepCreatedOrigin]) – The source of the content being delivered via CDN.
origin_groups (list[DeepCreatedOriginGroup]) – The origin groups comprising of origins that are used for load balancing the traffic based on availability.

class azure.mgmt.cdn.models.EndpointListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Endpoint]) – List of CDN endpoints within a profile.
next_link (str) – URL to get the next set of endpoint objects if there is any.

Keyword Arguments

next_link (str) – URL to get the next set of endpoint objects if there is any.

class azure.mgmt.cdn.models.EndpointProperties(*, origins: List[_models.DeepCreatedOrigin], origin_path: Optional[str] = None, content_types_to_compress: Optional[List[str]] = None, origin_host_header: Optional[str] = None, is_compression_enabled: Optional[bool] = None, is_http_allowed: Optional[bool] = None, is_https_allowed: Optional[bool] = None, query_string_caching_behavior: Optional[Union[str, _models.QueryStringCachingBehavior]] = None, optimization_type: Optional[Union[str, _models.OptimizationType]] = None, probe_path: Optional[str] = None, geo_filters: Optional[List[_models.GeoFilter]] = None, default_origin_group: Optional[_models.ResourceReference] = None, url_signing_keys: Optional[List[_models.UrlSigningKey]] = None, delivery_policy: Optional[_models.EndpointPropertiesUpdateParametersDeliveryPolicy] = None, web_application_firewall_policy_link: Optional[_models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink] = None, origin_groups: Optional[List[_models.DeepCreatedOriginGroup]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.EndpointPropertiesUpdateParameters

The JSON object that contains the properties required to create an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).
host_name (str) – The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
origins (list[DeepCreatedOrigin]) – The source of the content being delivered via CDN. Required.
origin_groups (list[DeepCreatedOriginGroup]) – The origin groups comprising of origins that are used for load balancing the traffic based on availability.
custom_domains (list[DeepCreatedCustomDomain]) – The custom domains under the endpoint.
resource_state (str or EndpointResourceState) – Resource status of the endpoint. Known values are: “Creating”, “Deleting”, “Running”, “Starting”, “Stopped”, and “Stopping”.
provisioning_state (str or EndpointProvisioningState) – Provisioning status of the endpoint. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.

Keyword Arguments

origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).
origins (list[DeepCreatedOrigin]) – The source of the content being delivered via CDN. Required.
origin_groups (list[DeepCreatedOriginGroup]) – The origin groups comprising of origins that are used for load balancing the traffic based on availability.

class azure.mgmt.cdn.models.EndpointPropertiesUpdateParameters(*, origin_path: Optional[str] = None, content_types_to_compress: Optional[List[str]] = None, origin_host_header: Optional[str] = None, is_compression_enabled: Optional[bool] = None, is_http_allowed: Optional[bool] = None, is_https_allowed: Optional[bool] = None, query_string_caching_behavior: Optional[Union[str, _models.QueryStringCachingBehavior]] = None, optimization_type: Optional[Union[str, _models.OptimizationType]] = None, probe_path: Optional[str] = None, geo_filters: Optional[List[_models.GeoFilter]] = None, default_origin_group: Optional[_models.ResourceReference] = None, url_signing_keys: Optional[List[_models.UrlSigningKey]] = None, delivery_policy: Optional[_models.EndpointPropertiesUpdateParametersDeliveryPolicy] = None, web_application_firewall_policy_link: Optional[_models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object containing endpoint update parameters.

Variables

origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).

Keyword Arguments

origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).

class azure.mgmt.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy(*, rules: List[_models.DeliveryRule], description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

A policy that specifies the delivery rules to be used for an endpoint.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – User-friendly description of the policy.
rules (list[DeliveryRule]) – A list of the delivery rules. Required.

Keyword Arguments

description (str) – User-friendly description of the policy.
rules (list[DeliveryRule]) – A list of the delivery rules. Required.

class azure.mgmt.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the Web Application Firewall policy for the endpoint (if applicable).

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.cdn.models.EndpointProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the endpoint.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cdn.models.EndpointResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the endpoint.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

RUNNING = 'Running'¶

STARTING = 'Starting'¶

STOPPED = 'Stopped'¶

STOPPING = 'Stopping'¶

class azure.mgmt.cdn.models.EndpointUpdateParameters(*, tags: Optional[Dict[str, str]] = None, origin_path: Optional[str] = None, content_types_to_compress: Optional[List[str]] = None, origin_host_header: Optional[str] = None, is_compression_enabled: Optional[bool] = None, is_http_allowed: Optional[bool] = None, is_https_allowed: Optional[bool] = None, query_string_caching_behavior: Optional[Union[str, _models.QueryStringCachingBehavior]] = None, optimization_type: Optional[Union[str, _models.OptimizationType]] = None, probe_path: Optional[str] = None, geo_filters: Optional[List[_models.GeoFilter]] = None, default_origin_group: Optional[_models.ResourceReference] = None, url_signing_keys: Optional[List[_models.UrlSigningKey]] = None, delivery_policy: Optional[_models.EndpointPropertiesUpdateParametersDeliveryPolicy] = None, web_application_firewall_policy_link: Optional[_models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Properties required to create or update an endpoint.

Variables

tags (dict[str, str]) – Endpoint tags.
origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).

Keyword Arguments

tags (dict[str, str]) – Endpoint tags.
origin_path (str) – A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress (list[str]) – List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header (str) – The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
is_compression_enabled (bool) – Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed (bool) – Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed (bool) – Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior (str or QueryStringCachingBehavior) – Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: “IgnoreQueryString”, “BypassCaching”, “UseQueryString”, and “NotSet”.
optimization_type (str or OptimizationType) – Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: “GeneralWebDelivery”, “GeneralMediaStreaming”, “VideoOnDemandMediaStreaming”, “LargeFileDownload”, and “DynamicSiteAcceleration”.
probe_path (str) – Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group (ResourceReference) – A reference to the origin group.
url_signing_keys (list[UrlSigningKey]) – List of keys used to validate the signed URL hashes.
delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link (EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for the endpoint (if applicable).

class azure.mgmt.cdn.models.ErrorAdditionalInfo(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.cdn.models.ErrorDetail(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.cdn.models.ErrorResponse(*, error: Optional[_models.ErrorDetail] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.

Variables: error (ErrorDetail) – The error object.
Keyword Arguments: error (ErrorDetail) – The error object.

class azure.mgmt.cdn.models.ForwardingProtocol(value)[source]¶

Bases: str, enum.Enum

Protocol this rule will use when forwarding traffic to backends.

HTTPS_ONLY = 'HttpsOnly'¶

HTTP_ONLY = 'HttpOnly'¶

MATCH_REQUEST = 'MatchRequest'¶

class azure.mgmt.cdn.models.GeoFilter(*, relative_path: str, action: Union[str, _models.GeoFilterActions], country_codes: List[str], **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Rules defining user’s geo access within a CDN endpoint.

All required parameters must be populated in order to send to Azure.

Variables

relative_path (str) – Relative path applicable to geo filter. (e.g. ‘/mypictures’, ‘/mypicture/kitty.jpg’, and etc.). Required.
action (str or GeoFilterActions) – Action of the geo filter, i.e. allow or block access. Required. Known values are: “Block” and “Allow”.
country_codes (list[str]) – Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. Required.

Keyword Arguments

relative_path (str) – Relative path applicable to geo filter. (e.g. ‘/mypictures’, ‘/mypicture/kitty.jpg’, and etc.). Required.
action (str or GeoFilterActions) – Action of the geo filter, i.e. allow or block access. Required. Known values are: “Block” and “Allow”.
country_codes (list[str]) – Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. Required.

class azure.mgmt.cdn.models.GeoFilterActions(value)[source]¶

Bases: str, enum.Enum

Action of the geo filter, i.e. allow or block access.

ALLOW = 'Allow'¶

BLOCK = 'Block'¶

class azure.mgmt.cdn.models.HeaderAction(value)[source]¶

Bases: str, enum.Enum

Action to perform.

APPEND = 'Append'¶

DELETE = 'Delete'¶

OVERWRITE = 'Overwrite'¶

class azure.mgmt.cdn.models.HeaderActionParameters(*, type_name: Union[str, _models.HeaderActionParametersTypeName], header_action: Union[str, _models.HeaderAction], header_name: str, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the request header action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or HeaderActionParametersTypeName) – Required. “DeliveryRuleHeaderActionParameters”
header_action (str or HeaderAction) – Action to perform. Required. Known values are: “Append”, “Overwrite”, and “Delete”.
header_name (str) – Name of the header to modify. Required.
value (str) – Value for the specified action.

Keyword Arguments

type_name (str or HeaderActionParametersTypeName) – Required. “DeliveryRuleHeaderActionParameters”
header_action (str or HeaderAction) – Action to perform. Required. Known values are: “Append”, “Overwrite”, and “Delete”.
header_name (str) – Name of the header to modify. Required.
value (str) – Value for the specified action.

class azure.mgmt.cdn.models.HeaderActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

HeaderActionParametersTypeName.

DELIVERY_RULE_HEADER_ACTION_PARAMETERS = 'DeliveryRuleHeaderActionParameters'¶

class azure.mgmt.cdn.models.HealthProbeParameters(*, probe_path: Optional[str] = None, probe_request_type: Optional[Union[str, _models.HealthProbeRequestType]] = None, probe_protocol: Optional[Union[str, _models.ProbeProtocol]] = None, probe_interval_in_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties to send health probes to origin.

Variables

probe_path (str) – The path relative to the origin that is used to determine the health of the origin.
probe_request_type (str or HealthProbeRequestType) – The type of health probe request that is made. Known values are: “NotSet”, “GET”, and “HEAD”.
probe_protocol (str or ProbeProtocol) – Protocol to use for health probe. Known values are: “NotSet”, “Http”, and “Https”.
probe_interval_in_seconds (int) – The number of seconds between health probes.Default is 240sec.

Keyword Arguments

probe_path (str) – The path relative to the origin that is used to determine the health of the origin.
probe_request_type (str or HealthProbeRequestType) – The type of health probe request that is made. Known values are: “NotSet”, “GET”, and “HEAD”.
probe_protocol (str or ProbeProtocol) – Protocol to use for health probe. Known values are: “NotSet”, “Http”, and “Https”.
probe_interval_in_seconds (int) – The number of seconds between health probes.Default is 240sec.

class azure.mgmt.cdn.models.HealthProbeRequestType(value)[source]¶

Bases: str, enum.Enum

The type of health probe request that is made.

GET = 'GET'¶

HEAD = 'HEAD'¶

NOT_SET = 'NotSet'¶

class azure.mgmt.cdn.models.HostNameMatchConditionParameters(*, type_name: Union[str, _models.HostNameMatchConditionParametersTypeName], operator: Union[str, _models.HostNameOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for HostName match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or HostNameMatchConditionParametersTypeName) – Required. “DeliveryRuleHostNameConditionParameters”
operator (str or HostNameOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or HostNameMatchConditionParametersTypeName) – Required. “DeliveryRuleHostNameConditionParameters”
operator (str or HostNameOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.HostNameMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

HostNameMatchConditionParametersTypeName.

DELIVERY_RULE_HOST_NAME_CONDITION_PARAMETERS = 'DeliveryRuleHostNameConditionParameters'¶

class azure.mgmt.cdn.models.HostNameOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.HttpErrorRangeParameters(*, begin: Optional[int] = None, end: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that represents the range for http status codes.

Variables

begin (int) – The inclusive start of the http status code range.
end (int) – The inclusive end of the http status code range.

Keyword Arguments

begin (int) – The inclusive start of the http status code range.
end (int) – The inclusive end of the http status code range.

class azure.mgmt.cdn.models.HttpVersionMatchConditionParameters(*, type_name: Union[str, _models.HttpVersionMatchConditionParametersTypeName], operator: Union[str, _models.HttpVersionOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for HttpVersion match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or HttpVersionMatchConditionParametersTypeName) – Required. “DeliveryRuleHttpVersionConditionParameters”
operator (str or HttpVersionOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or HttpVersionMatchConditionParametersTypeName) – Required. “DeliveryRuleHttpVersionConditionParameters”
operator (str or HttpVersionOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.HttpVersionMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

HttpVersionMatchConditionParametersTypeName.

DELIVERY_RULE_HTTP_VERSION_CONDITION_PARAMETERS = 'DeliveryRuleHttpVersionConditionParameters'¶

class azure.mgmt.cdn.models.HttpVersionOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

EQUAL = 'Equal'¶

class azure.mgmt.cdn.models.HttpsRedirect(value)[source]¶

Bases: str, enum.Enum

Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.IdentityType(value)[source]¶

Bases: str, enum.Enum

The type of identity that creates/modifies resources.

APPLICATION = 'application'¶

KEY = 'key'¶

MANAGED_IDENTITY = 'managedIdentity'¶

USER = 'user'¶

class azure.mgmt.cdn.models.IpAddressGroup(*, delivery_region: Optional[str] = None, ipv4_addresses: Optional[List[_models.CidrIpAddress]] = None, ipv6_addresses: Optional[List[_models.CidrIpAddress]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

CDN Ip address group.

Variables

delivery_region (str) – The delivery region of the ip address group.
ipv4_addresses (list[CidrIpAddress]) – The list of ip v4 addresses.
ipv6_addresses (list[CidrIpAddress]) – The list of ip v6 addresses.

Keyword Arguments

delivery_region (str) – The delivery region of the ip address group.
ipv4_addresses (list[CidrIpAddress]) – The list of ip v4 addresses.
ipv6_addresses (list[CidrIpAddress]) – The list of ip v6 addresses.

class azure.mgmt.cdn.models.IsDeviceMatchConditionParameters(*, type_name: Union[str, _models.IsDeviceMatchConditionParametersTypeName], operator: Union[str, _models.IsDeviceOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[Union[str, _models.IsDeviceMatchConditionParametersMatchValuesItem]]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for IsDevice match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or IsDeviceMatchConditionParametersTypeName) – Required. “DeliveryRuleIsDeviceConditionParameters”
operator (str or IsDeviceOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str or IsDeviceMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or IsDeviceMatchConditionParametersTypeName) – Required. “DeliveryRuleIsDeviceConditionParameters”
operator (str or IsDeviceOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str or IsDeviceMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.IsDeviceMatchConditionParametersMatchValuesItem(value)[source]¶

Bases: str, enum.Enum

IsDeviceMatchConditionParametersMatchValuesItem.

DESKTOP = 'Desktop'¶

MOBILE = 'Mobile'¶

class azure.mgmt.cdn.models.IsDeviceMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

IsDeviceMatchConditionParametersTypeName.

DELIVERY_RULE_IS_DEVICE_CONDITION_PARAMETERS = 'DeliveryRuleIsDeviceConditionParameters'¶

class azure.mgmt.cdn.models.IsDeviceOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

EQUAL = 'Equal'¶

class azure.mgmt.cdn.models.KeyVaultCertificateSourceParameters(*, type_name: Union[str, _models.KeyVaultCertificateSourceParametersTypeName], subscription_id: str, resource_group_name: str, vault_name: str, secret_name: str, update_rule: Union[str, _models.UpdateRule], delete_rule: Union[str, _models.DeleteRule], secret_version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes the parameters for using a user’s KeyVault certificate for securing custom domain.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or KeyVaultCertificateSourceParametersTypeName) – Required. “KeyVaultCertificateSourceParameters”
subscription_id (str) – Subscription Id of the user’s Key Vault containing the SSL certificate. Required.
resource_group_name (str) – Resource group of the user’s Key Vault containing the SSL certificate. Required.
vault_name (str) – The name of the user’s Key Vault containing the SSL certificate. Required.
secret_name (str) – The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. Required.
secret_version (str) – The version(GUID) of Key Vault Secret in Key Vault.
update_rule (str or UpdateRule) – Describes the action that shall be taken when the certificate is updated in Key Vault. Required. “NoAction”
delete_rule (str or DeleteRule) – Describes the action that shall be taken when the certificate is removed from Key Vault. Required. “NoAction”

Keyword Arguments

type_name (str or KeyVaultCertificateSourceParametersTypeName) – Required. “KeyVaultCertificateSourceParameters”
subscription_id (str) – Subscription Id of the user’s Key Vault containing the SSL certificate. Required.
resource_group_name (str) – Resource group of the user’s Key Vault containing the SSL certificate. Required.
vault_name (str) – The name of the user’s Key Vault containing the SSL certificate. Required.
secret_name (str) – The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. Required.
secret_version (str) – The version(GUID) of Key Vault Secret in Key Vault.
update_rule (str or UpdateRule) – Describes the action that shall be taken when the certificate is updated in Key Vault. Required. “NoAction”
delete_rule (str or DeleteRule) – Describes the action that shall be taken when the certificate is removed from Key Vault. Required. “NoAction”

class azure.mgmt.cdn.models.KeyVaultCertificateSourceParametersTypeName(value)[source]¶

Bases: str, enum.Enum

KeyVaultCertificateSourceParametersTypeName.

KEY_VAULT_CERTIFICATE_SOURCE_PARAMETERS = 'KeyVaultCertificateSourceParameters'¶

class azure.mgmt.cdn.models.KeyVaultSigningKeyParameters(*, type_name: Union[str, _models.KeyVaultSigningKeyParametersTypeName], subscription_id: str, resource_group_name: str, vault_name: str, secret_name: str, secret_version: str, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes the parameters for using a user’s KeyVault for URL Signing Key.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or KeyVaultSigningKeyParametersTypeName) – Required. “KeyVaultSigningKeyParameters”
subscription_id (str) – Subscription Id of the user’s Key Vault containing the secret. Required.
resource_group_name (str) – Resource group of the user’s Key Vault containing the secret. Required.
vault_name (str) – The name of the user’s Key Vault containing the secret. Required.
secret_name (str) – The name of secret in Key Vault. Required.
secret_version (str) – The version(GUID) of secret in Key Vault. Required.

Keyword Arguments

type_name (str or KeyVaultSigningKeyParametersTypeName) – Required. “KeyVaultSigningKeyParameters”
subscription_id (str) – Subscription Id of the user’s Key Vault containing the secret. Required.
resource_group_name (str) – Resource group of the user’s Key Vault containing the secret. Required.
vault_name (str) – The name of the user’s Key Vault containing the secret. Required.
secret_name (str) – The name of secret in Key Vault. Required.
secret_version (str) – The version(GUID) of secret in Key Vault. Required.

class azure.mgmt.cdn.models.KeyVaultSigningKeyParametersTypeName(value)[source]¶

Bases: str, enum.Enum

KeyVaultSigningKeyParametersTypeName.

KEY_VAULT_SIGNING_KEY_PARAMETERS = 'KeyVaultSigningKeyParameters'¶

class azure.mgmt.cdn.models.LinkToDefaultDomain(value)[source]¶

Bases: str, enum.Enum

whether this route will be linked to the default endpoint domain.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.LoadBalancingSettingsParameters(*, sample_size: Optional[int] = None, successful_samples_required: Optional[int] = None, additional_latency_in_milliseconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Round-Robin load balancing settings for a backend pool.

Variables

sample_size (int) – The number of samples to consider for load balancing decisions.
successful_samples_required (int) – The number of samples within the sample period that must succeed.
additional_latency_in_milliseconds (int) – The additional latency in milliseconds for probes to fall into the lowest latency bucket.

Keyword Arguments

sample_size (int) – The number of samples to consider for load balancing decisions.
successful_samples_required (int) – The number of samples within the sample period that must succeed.
additional_latency_in_milliseconds (int) – The additional latency in milliseconds for probes to fall into the lowest latency bucket.

class azure.mgmt.cdn.models.LoadParameters(*, content_paths: List[str], **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Parameters required for content load.

All required parameters must be populated in order to send to Azure.

Variables: content_paths (list[str]) – The path to the content to be loaded. Path should be a relative file URL of the origin. Required.
Keyword Arguments: content_paths (list[str]) – The path to the content to be loaded. Path should be a relative file URL of the origin. Required.

class azure.mgmt.cdn.models.LogMetric(value)[source]¶

Bases: str, enum.Enum

LogMetric.

CLIENT_REQUEST_BANDWIDTH = 'clientRequestBandwidth'¶

CLIENT_REQUEST_COUNT = 'clientRequestCount'¶

CLIENT_REQUEST_TRAFFIC = 'clientRequestTraffic'¶

ORIGIN_REQUEST_BANDWIDTH = 'originRequestBandwidth'¶

ORIGIN_REQUEST_TRAFFIC = 'originRequestTraffic'¶

TOTAL_LATENCY = 'totalLatency'¶

class azure.mgmt.cdn.models.LogMetricsGranularity(value)[source]¶

Bases: str, enum.Enum

LogMetricsGranularity.

P1_D = 'P1D'¶

PT1_H = 'PT1H'¶

PT5_M = 'PT5M'¶

class azure.mgmt.cdn.models.LogMetricsGroupBy(value)[source]¶

Bases: str, enum.Enum

LogMetricsGroupBy.

CACHE_STATUS = 'cacheStatus'¶

COUNTRY_OR_REGION = 'countryOrRegion'¶

CUSTOM_DOMAIN = 'customDomain'¶

HTTP_STATUS_CODE = 'httpStatusCode'¶

PROTOCOL = 'protocol'¶

class azure.mgmt.cdn.models.LogRanking(value)[source]¶

Bases: str, enum.Enum

LogRanking.

BROWSER = 'browser'¶

COUNTRY_OR_REGION = 'countryOrRegion'¶

REFERRER = 'referrer'¶

URL = 'url'¶

USER_AGENT = 'userAgent'¶

class azure.mgmt.cdn.models.LogRankingMetric(value)[source]¶

Bases: str, enum.Enum

LogRankingMetric.

CLIENT_REQUEST_COUNT = 'clientRequestCount'¶

CLIENT_REQUEST_TRAFFIC = 'clientRequestTraffic'¶

ERROR_COUNT = 'errorCount'¶

HIT_COUNT = 'hitCount'¶

MISS_COUNT = 'missCount'¶

USER_ERROR_COUNT = 'userErrorCount'¶

class azure.mgmt.cdn.models.LogSpecification(*, name: Optional[str] = None, display_name: Optional[str] = None, blob_duration: Optional[str] = None, log_filter_pattern: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Log specification of operation.

Variables

name (str) – Name of log specification.
display_name (str) – Display name of log specification.
blob_duration (str) – Blob duration of specification.
log_filter_pattern (str) – Pattern to filter based on name.

Keyword Arguments

name (str) – Name of log specification.
display_name (str) – Display name of log specification.
blob_duration (str) – Blob duration of specification.
log_filter_pattern (str) – Pattern to filter based on name.

class azure.mgmt.cdn.models.ManagedCertificate(*, type: Optional[Union[str, _models.SecretType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Certificate

Managed Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.

Keyword Arguments

type (str or SecretType) – The type of the secret resource. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.

class azure.mgmt.cdn.models.ManagedCertificateParameters(**kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.SecretParameters

Managed Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

type (str or SecretType) – The type of the secret resource. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
subject (str) – Subject name in the certificate.
expiration_date (str) – Certificate expiration date.

class azure.mgmt.cdn.models.ManagedRuleDefinition(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes a managed rule definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

rule_id (str) – Identifier for the managed rule.
description (str) – Describes the functionality of the managed rule.

class azure.mgmt.cdn.models.ManagedRuleEnabledState(value)[source]¶

Bases: str, enum.Enum

Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.ManagedRuleGroupDefinition(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes a managed rule group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

rule_group_name (str) – Name of the managed rule group.
description (str) – Description of the managed rule group.
rules (list[ManagedRuleDefinition]) – List of rules within the managed rule group.

class azure.mgmt.cdn.models.ManagedRuleGroupOverride(*, rule_group_name: str, rules: Optional[List[_models.ManagedRuleOverride]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines a managed rule group override setting.

All required parameters must be populated in order to send to Azure.

Variables

rule_group_name (str) – Describes the managed rule group within the rule set to override. Required.
rules (list[ManagedRuleOverride]) – List of rules that will be enabled. If none specified, all rules in the group will be disabled.

Keyword Arguments

rule_group_name (str) – Describes the managed rule group within the rule set to override. Required.
rules (list[ManagedRuleOverride]) – List of rules that will be enabled. If none specified, all rules in the group will be disabled.

class azure.mgmt.cdn.models.ManagedRuleOverride(*, rule_id: str, enabled_state: Optional[Union[str, _models.ManagedRuleEnabledState]] = None, action: Optional[Union[str, _models.ActionType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines a managed rule group override setting.

All required parameters must be populated in order to send to Azure.

Variables

rule_id (str) – Identifier for the managed rule. Required.
enabled_state (str or ManagedRuleEnabledState) – Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Known values are: “Disabled” and “Enabled”.
action (str or ActionType) – Describes the override action to be applied when rule matches. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

Keyword Arguments

rule_id (str) – Identifier for the managed rule. Required.
enabled_state (str or ManagedRuleEnabledState) – Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Known values are: “Disabled” and “Enabled”.
action (str or ActionType) – Describes the override action to be applied when rule matches. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

class azure.mgmt.cdn.models.ManagedRuleSet(*, rule_set_type: str, rule_set_version: str, anomaly_score: Optional[int] = None, rule_group_overrides: Optional[List[_models.ManagedRuleGroupOverride]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines a managed rule set.

All required parameters must be populated in order to send to Azure.

Variables

rule_set_type (str) – Defines the rule set type to use. Required.
rule_set_version (str) – Defines the version of the rule set to use. Required.
anomaly_score (int) – Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.
rule_group_overrides (list[ManagedRuleGroupOverride]) – Defines the rule overrides to apply to the rule set.

Keyword Arguments

rule_set_type (str) – Defines the rule set type to use. Required.
rule_set_version (str) – Defines the version of the rule set to use. Required.
anomaly_score (int) – Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.
rule_group_overrides (list[ManagedRuleGroupOverride]) – Defines the rule overrides to apply to the rule set.

class azure.mgmt.cdn.models.ManagedRuleSetDefinition(*, sku: Optional[_models.Sku] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Resource

Describes a managed rule set definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
sku (Sku) – The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.
provisioning_state (str) – Provisioning state of the managed rule set.
rule_set_type (str) – Type of the managed rule set.
rule_set_version (str) – Version of the managed rule set type.
rule_groups (list[ManagedRuleGroupDefinition]) – Rule groups of the managed rule set.

Keyword Arguments

sku (Sku) – The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.

class azure.mgmt.cdn.models.ManagedRuleSetDefinitionList(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

List of managed rule set definitions available for use in a policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedRuleSetDefinition]) – List of managed rule set definitions.
next_link (str) – URL to retrieve next set of managed rule set definitions.

Keyword Arguments

next_link (str) – URL to retrieve next set of managed rule set definitions.

class azure.mgmt.cdn.models.ManagedRuleSetList(*, managed_rule_sets: Optional[List[_models.ManagedRuleSet]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the list of managed rule sets for the policy.

Variables: managed_rule_sets (list[ManagedRuleSet]) – List of rule sets.
Keyword Arguments: managed_rule_sets (list[ManagedRuleSet]) – List of rule sets.

class azure.mgmt.cdn.models.MatchCondition(*, match_variable: Union[str, _models.WafMatchVariable], operator: Union[str, _models.Operator], match_value: List[str], selector: Optional[str] = None, negate_condition: Optional[bool] = None, transforms: Optional[List[Union[str, _models.TransformType]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Define match conditions.

All required parameters must be populated in order to send to Azure.

Variables

match_variable (str or WafMatchVariable) – Match variable to compare against. Required. Known values are: “RemoteAddr”, “SocketAddr”, “RequestMethod”, “RequestHeader”, “RequestUri”, “QueryString”, “RequestBody”, “Cookies”, and “PostArgs”.
selector (str) – Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.
operator (str or Operator) – Describes operator to be matched. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, “EndsWith”, and “RegEx”.
negate_condition (bool) – Describes if the result of this condition should be negated.
match_value (list[str]) – List of possible match values. Required.
transforms (list[str or TransformType]) – List of transforms.

Keyword Arguments

match_variable (str or WafMatchVariable) – Match variable to compare against. Required. Known values are: “RemoteAddr”, “SocketAddr”, “RequestMethod”, “RequestHeader”, “RequestUri”, “QueryString”, “RequestBody”, “Cookies”, and “PostArgs”.
selector (str) – Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.
operator (str or Operator) – Describes operator to be matched. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, “EndsWith”, and “RegEx”.
negate_condition (bool) – Describes if the result of this condition should be negated.
match_value (list[str]) – List of possible match values. Required.
transforms (list[str or TransformType]) – List of transforms.

class azure.mgmt.cdn.models.MatchProcessingBehavior(value)[source]¶

Bases: str, enum.Enum

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

CONTINUE = 'Continue'¶

STOP = 'Stop'¶

class azure.mgmt.cdn.models.MatchVariable(value)[source]¶

Bases: str, enum.Enum

The name of the condition for the delivery rule.

CLIENT_PORT = 'ClientPort'¶

COOKIES = 'Cookies'¶

HOST_NAME = 'HostName'¶

HTTP_VERSION = 'HttpVersion'¶

IS_DEVICE = 'IsDevice'¶

POST_ARGS = 'PostArgs'¶

QUERY_STRING = 'QueryString'¶

REMOTE_ADDRESS = 'RemoteAddress'¶

REQUEST_BODY = 'RequestBody'¶

REQUEST_HEADER = 'RequestHeader'¶

REQUEST_METHOD = 'RequestMethod'¶

REQUEST_SCHEME = 'RequestScheme'¶

REQUEST_URI = 'RequestUri'¶

SERVER_PORT = 'ServerPort'¶

SOCKET_ADDR = 'SocketAddr'¶

SSL_PROTOCOL = 'SslProtocol'¶

URL_FILE_EXTENSION = 'UrlFileExtension'¶

URL_FILE_NAME = 'UrlFileName'¶

URL_PATH = 'UrlPath'¶

class azure.mgmt.cdn.models.MetricAvailability(*, time_grain: Optional[str] = None, blob_duration: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Retention policy of a resource metric.

Variables

time_grain (str) –
blob_duration (str) –

Keyword Arguments

time_grain (str) –
blob_duration (str) –

class azure.mgmt.cdn.models.MetricSpecification(*, name: Optional[str] = None, display_name: Optional[str] = None, display_description: Optional[str] = None, unit: Optional[str] = None, aggregation_type: Optional[str] = None, availabilities: Optional[List[_models.MetricAvailability]] = None, supported_time_grain_types: Optional[List[str]] = None, dimensions: Optional[List[_models.DimensionProperties]] = None, fill_gap_with_zero: Optional[bool] = None, metric_filter_pattern: Optional[str] = None, is_internal: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Metric specification of operation.

Variables

name (str) – Name of metric specification.
display_name (str) – Display name of metric specification.
display_description (str) – Display description of metric specification.
unit (str) – The metric unit. Possible values include: ‘Bytes’, ‘Count’, ‘Milliseconds’.
aggregation_type (str) – The metric aggregation type. Possible values include: ‘Average’, ‘Count’, ‘Total’.
availabilities (list[MetricAvailability]) – Retention policies of a resource metric.
supported_time_grain_types (list[str]) – The supported time grain types for the metrics.
dimensions (list[DimensionProperties]) – The dimensions of metric.
fill_gap_with_zero (bool) – Property to specify whether to fill gap with zero.
metric_filter_pattern (str) – Pattern to filter based on name.
is_internal (bool) – Property to specify metric is internal or not.

Keyword Arguments

name (str) – Name of metric specification.
display_name (str) – Display name of metric specification.
display_description (str) – Display description of metric specification.
unit (str) – The metric unit. Possible values include: ‘Bytes’, ‘Count’, ‘Milliseconds’.
aggregation_type (str) – The metric aggregation type. Possible values include: ‘Average’, ‘Count’, ‘Total’.
availabilities (list[MetricAvailability]) – Retention policies of a resource metric.
supported_time_grain_types (list[str]) – The supported time grain types for the metrics.
dimensions (list[DimensionProperties]) – The dimensions of metric.
fill_gap_with_zero (bool) – Property to specify whether to fill gap with zero.
metric_filter_pattern (str) – Pattern to filter based on name.
is_internal (bool) – Property to specify metric is internal or not.

class azure.mgmt.cdn.models.MetricsResponse(*, date_time_begin: Optional[datetime.datetime] = None, date_time_end: Optional[datetime.datetime] = None, granularity: Optional[Union[str, _models.MetricsResponseGranularity]] = None, series: Optional[List[_models.MetricsResponseSeriesItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Metrics Response.

Variables

date_time_begin (datetime) –
date_time_end (datetime) –
granularity (str or MetricsResponseGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”.
series (list[MetricsResponseSeriesItem]) –

Keyword Arguments

date_time_begin (datetime) –
date_time_end (datetime) –
granularity (str or MetricsResponseGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”.
series (list[MetricsResponseSeriesItem]) –

class azure.mgmt.cdn.models.MetricsResponseGranularity(value)[source]¶

Bases: str, enum.Enum

MetricsResponseGranularity.

P1_D = 'P1D'¶

PT1_H = 'PT1H'¶

PT5_M = 'PT5M'¶

class azure.mgmt.cdn.models.MetricsResponseSeriesItem(*, metric: Optional[str] = None, unit: Optional[Union[str, _models.MetricsResponseSeriesItemUnit]] = None, groups: Optional[List[_models.MetricsResponseSeriesPropertiesItemsItem]] = None, data: Optional[List[_models.Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

MetricsResponseSeriesItem.

Variables

metric (str) –
unit (str or MetricsResponseSeriesItemUnit) – Known values are: “count”, “bytes”, “bitsPerSecond”, and “milliSeconds”.
groups (list[MetricsResponseSeriesPropertiesItemsItem]) –
data (list[Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems]) –

Keyword Arguments

metric (str) –
unit (str or MetricsResponseSeriesItemUnit) – Known values are: “count”, “bytes”, “bitsPerSecond”, and “milliSeconds”.
groups (list[MetricsResponseSeriesPropertiesItemsItem]) –
data (list[Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems]) –

class azure.mgmt.cdn.models.MetricsResponseSeriesItemUnit(value)[source]¶

Bases: str, enum.Enum

MetricsResponseSeriesItemUnit.

BITS_PER_SECOND = 'bitsPerSecond'¶

BYTES = 'bytes'¶

COUNT = 'count'¶

MILLI_SECONDS = 'milliSeconds'¶

class azure.mgmt.cdn.models.MetricsResponseSeriesPropertiesItemsItem(*, name: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

MetricsResponseSeriesPropertiesItemsItem.

Variables

name (str) –
value (str) –

Keyword Arguments

name (str) –
value (str) –

class azure.mgmt.cdn.models.MinimumTlsVersion(value)[source]¶

Bases: str, enum.Enum

TLS protocol version that will be used for Https.

NONE = 'None'¶

TLS10 = 'TLS10'¶

TLS12 = 'TLS12'¶

class azure.mgmt.cdn.models.Operation(*, is_data_action: Optional[bool] = None, display: Optional[_models.OperationDisplay] = None, service_specification: Optional[_models.ServiceSpecification] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

CDN REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Indicates whether the operation is a data action.
display (OperationDisplay) – The object that represents the operation.
origin (str) – The origin of operations.
service_specification (ServiceSpecification) – One property of operation, include metric specifications.

Keyword Arguments

is_data_action (bool) – Indicates whether the operation is a data action.
display (OperationDisplay) – The object that represents the operation.
service_specification (ServiceSpecification) – One property of operation, include metric specifications.

class azure.mgmt.cdn.models.OperationDisplay(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – Service provider: Microsoft.Cdn.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of operation.

class azure.mgmt.cdn.models.OperationsListResult(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.

Variables

value (list[Operation]) – List of CDN operations supported by the CDN resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments

value (list[Operation]) – List of CDN operations supported by the CDN resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.cdn.models.Operator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GEO_MATCH = 'GeoMatch'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

IP_MATCH = 'IPMatch'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.OptimizationType(value)[source]¶

Bases: str, enum.Enum

Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.

DYNAMIC_SITE_ACCELERATION = 'DynamicSiteAcceleration'¶

GENERAL_MEDIA_STREAMING = 'GeneralMediaStreaming'¶

GENERAL_WEB_DELIVERY = 'GeneralWebDelivery'¶

LARGE_FILE_DOWNLOAD = 'LargeFileDownload'¶

VIDEO_ON_DEMAND_MEDIA_STREAMING = 'VideoOnDemandMediaStreaming'¶

class azure.mgmt.cdn.models.Origin(*, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, enabled: Optional[bool] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.
resource_state (str or OriginResourceState) – Resource status of the origin. Known values are: “Creating”, “Active”, and “Deleting”.
provisioning_state (str or OriginProvisioningState) – Provisioning status of the origin. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
private_endpoint_status (str or PrivateEndpointStatus) – The approval status for the connection to the Private Link. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.

Keyword Arguments

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

class azure.mgmt.cdn.models.OriginGroup(*, health_probe_settings: Optional[_models.HealthProbeParameters] = None, origins: Optional[List[_models.ResourceReference]] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, response_based_origin_error_detection_settings: Optional[_models.ResponseBasedOriginErrorDetectionParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
resource_state (str or OriginGroupResourceState) – Resource status of the origin group. Known values are: “Creating”, “Active”, and “Deleting”.
provisioning_state (str or OriginGroupProvisioningState) – Provisioning status of the origin group. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.

Keyword Arguments

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

class azure.mgmt.cdn.models.OriginGroupListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[OriginGroup]) – List of CDN origin groups within an endpoint.
next_link (str) – URL to get the next set of origin objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of origin objects if there are any.

class azure.mgmt.cdn.models.OriginGroupOverride(*, origin_group: Optional[_models.ResourceReference] = None, forwarding_protocol: Optional[Union[str, _models.ForwardingProtocol]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the origin group override configuration.

Variables

origin_group (ResourceReference) – defines the OriginGroup that would override the DefaultOriginGroup on route.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.

Keyword Arguments

origin_group (ResourceReference) – defines the OriginGroup that would override the DefaultOriginGroup on route.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.

class azure.mgmt.cdn.models.OriginGroupOverrideAction(*, parameters: _models.OriginGroupOverrideActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the origin group override action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (OriginGroupOverrideActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (OriginGroupOverrideActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.OriginGroupOverrideActionParameters(*, type_name: Union[str, _models.OriginGroupOverrideActionParametersTypeName], origin_group: _models.ResourceReference, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the origin group override action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or OriginGroupOverrideActionParametersTypeName) – Required. “DeliveryRuleOriginGroupOverrideActionParameters”
origin_group (ResourceReference) – defines the OriginGroup that would override the DefaultOriginGroup. Required.

Keyword Arguments

type_name (str or OriginGroupOverrideActionParametersTypeName) – Required. “DeliveryRuleOriginGroupOverrideActionParameters”
origin_group (ResourceReference) – defines the OriginGroup that would override the DefaultOriginGroup. Required.

class azure.mgmt.cdn.models.OriginGroupOverrideActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

OriginGroupOverrideActionParametersTypeName.

DELIVERY_RULE_ORIGIN_GROUP_OVERRIDE_ACTION_PARAMETERS = 'DeliveryRuleOriginGroupOverrideActionParameters'¶

class azure.mgmt.cdn.models.OriginGroupProperties(*, health_probe_settings: Optional[_models.HealthProbeParameters] = None, origins: Optional[List[_models.ResourceReference]] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, response_based_origin_error_detection_settings: Optional[_models.ResponseBasedOriginErrorDetectionParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.OriginGroupUpdatePropertiesParameters

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
resource_state (str or OriginGroupResourceState) – Resource status of the origin group. Known values are: “Creating”, “Active”, and “Deleting”.
provisioning_state (str or OriginGroupProvisioningState) – Provisioning status of the origin group. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.

Keyword Arguments

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

class azure.mgmt.cdn.models.OriginGroupProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the origin group.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cdn.models.OriginGroupResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the origin group.

ACTIVE = 'Active'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

class azure.mgmt.cdn.models.OriginGroupUpdateParameters(*, health_probe_settings: Optional[_models.HealthProbeParameters] = None, origins: Optional[List[_models.ResourceReference]] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, response_based_origin_error_detection_settings: Optional[_models.ResponseBasedOriginErrorDetectionParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Origin group properties needed for origin group creation or update.

Variables

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

Keyword Arguments

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

class azure.mgmt.cdn.models.OriginGroupUpdatePropertiesParameters(*, health_probe_settings: Optional[_models.HealthProbeParameters] = None, origins: Optional[List[_models.ResourceReference]] = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: Optional[int] = None, response_based_origin_error_detection_settings: Optional[_models.ResponseBasedOriginErrorDetectionParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the origin group.

Variables

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

Keyword Arguments

health_probe_settings (HealthProbeParameters) – Health probe settings to the origin that is used to determine the health of the origin.
origins (list[ResourceReference]) – The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes (int) – Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
response_based_origin_error_detection_settings (ResponseBasedOriginErrorDetectionParameters) – The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

class azure.mgmt.cdn.models.OriginListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Origin]) – List of CDN origins within an endpoint.
next_link (str) – URL to get the next set of origin objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of origin objects if there are any.

class azure.mgmt.cdn.models.OriginProperties(*, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, enabled: Optional[bool] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.OriginUpdatePropertiesParameters

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.
resource_state (str or OriginResourceState) – Resource status of the origin. Known values are: “Creating”, “Active”, and “Deleting”.
provisioning_state (str or OriginProvisioningState) – Provisioning status of the origin. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
private_endpoint_status (str or PrivateEndpointStatus) – The approval status for the connection to the Private Link. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.

Keyword Arguments

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

class azure.mgmt.cdn.models.OriginProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the origin.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cdn.models.OriginResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the origin.

ACTIVE = 'Active'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

class azure.mgmt.cdn.models.OriginUpdateParameters(*, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, enabled: Optional[bool] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Origin properties needed for origin update.

Variables

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

Keyword Arguments

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

class azure.mgmt.cdn.models.OriginUpdatePropertiesParameters(*, host_name: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, origin_host_header: Optional[str] = None, priority: Optional[int] = None, weight: Optional[int] = None, enabled: Optional[bool] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the origin.

Variables

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

Keyword Arguments

host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
http_port (int) – The value of the HTTP port. Must be between 1 and 65535.
https_port (int) – The value of the HTTPS port. Must be between 1 and 65535.
origin_host_header (str) – The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
priority (int) – Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
weight (int) – Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
enabled (bool) – Origin is enabled for load balancing or not.
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this origin is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.

class azure.mgmt.cdn.models.ParamIndicator(value)[source]¶

Bases: str, enum.Enum

Indicates the purpose of the parameter.

EXPIRES = 'Expires'¶

KEY_ID = 'KeyId'¶

SIGNATURE = 'Signature'¶

class azure.mgmt.cdn.models.PolicyEnabledState(value)[source]¶

Bases: str, enum.Enum

describes if the policy is in enabled state or disabled state.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.PolicyMode(value)[source]¶

Bases: str, enum.Enum

Describes if it is in detection mode or prevention mode at policy level.

DETECTION = 'Detection'¶

PREVENTION = 'Prevention'¶

class azure.mgmt.cdn.models.PolicyResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the policy.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

class azure.mgmt.cdn.models.PolicySettings(*, enabled_state: Optional[Union[str, _models.PolicyEnabledState]] = None, mode: Optional[Union[str, _models.PolicyMode]] = None, default_redirect_url: Optional[str] = None, default_custom_block_response_status_code: Optional[Union[int, _models.PolicySettingsDefaultCustomBlockResponseStatusCode]] = None, default_custom_block_response_body: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines contents of a web application firewall global configuration.

Variables

enabled_state (str or PolicyEnabledState) – describes if the policy is in enabled state or disabled state. Known values are: “Disabled” and “Enabled”.
mode (str or PolicyMode) – Describes if it is in detection mode or prevention mode at policy level. Known values are: “Prevention” and “Detection”.
default_redirect_url (str) – If action type is redirect, this field represents the default redirect URL for the client.
default_custom_block_response_status_code (int or PolicySettingsDefaultCustomBlockResponseStatusCode) – If the action type is block, this field defines the default customer overridable http response status code. Known values are: 200, 403, 405, 406, and 429.
default_custom_block_response_body (str) – If the action type is block, customer can override the response body. The body must be specified in base64 encoding.

Keyword Arguments

enabled_state (str or PolicyEnabledState) – describes if the policy is in enabled state or disabled state. Known values are: “Disabled” and “Enabled”.
mode (str or PolicyMode) – Describes if it is in detection mode or prevention mode at policy level. Known values are: “Prevention” and “Detection”.
default_redirect_url (str) – If action type is redirect, this field represents the default redirect URL for the client.
default_custom_block_response_status_code (int or PolicySettingsDefaultCustomBlockResponseStatusCode) – If the action type is block, this field defines the default customer overridable http response status code. Known values are: 200, 403, 405, 406, and 429.
default_custom_block_response_body (str) – If the action type is block, customer can override the response body. The body must be specified in base64 encoding.

class azure.mgmt.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode(value)[source]¶

Bases: int, enum.Enum

If the action type is block, this field defines the default customer overridable http response status code.

FOUR_HUNDRED_FIVE = 405¶

FOUR_HUNDRED_SIX = 406¶

FOUR_HUNDRED_THREE = 403¶

FOUR_HUNDRED_TWENTY_NINE = 429¶

TWO_HUNDRED = 200¶

class azure.mgmt.cdn.models.PostArgsMatchConditionParameters(*, type_name: Union[str, _models.PostArgsMatchConditionParametersTypeName], operator: Union[str, _models.PostArgsOperator], selector: Optional[str] = None, negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for PostArgs match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or PostArgsMatchConditionParametersTypeName) – Required. “DeliveryRulePostArgsConditionParameters”
selector (str) – Name of PostArg to be matched.
operator (str or PostArgsOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or PostArgsMatchConditionParametersTypeName) – Required. “DeliveryRulePostArgsConditionParameters”
selector (str) – Name of PostArg to be matched.
operator (str or PostArgsOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.PostArgsMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

PostArgsMatchConditionParametersTypeName.

DELIVERY_RULE_POST_ARGS_CONDITION_PARAMETERS = 'DeliveryRulePostArgsConditionParameters'¶

class azure.mgmt.cdn.models.PostArgsOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.PrivateEndpointStatus(value)[source]¶

Bases: str, enum.Enum

The approval status for the connection to the Private Link.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

TIMEOUT = 'Timeout'¶

class azure.mgmt.cdn.models.ProbeProtocol(value)[source]¶

Bases: str, enum.Enum

Protocol to use for health probe.

HTTP = 'Http'¶

HTTPS = 'Https'¶

NOT_SET = 'NotSet'¶

class azure.mgmt.cdn.models.Profile(*, location: str, sku: _models.Sku, tags: Optional[Dict[str, str]] = None, origin_response_timeout_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.TrackedResource

A profile is a logical grouping of endpoints that share the same settings.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
kind (str) – Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
resource_state (str or ProfileResourceState) – Resource status of the profile. Known values are: “Creating”, “Active”, “Deleting”, and “Disabled”.
provisioning_state (str or ProfileProvisioningState) – Provisioning status of the profile. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
front_door_id (str) – The Id of the frontdoor.
origin_response_timeout_seconds (int) – Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
origin_response_timeout_seconds (int) – Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

class azure.mgmt.cdn.models.ProfileListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Profile]) – List of CDN profiles within a resource group.
next_link (str) – URL to get the next set of profile objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of profile objects if there are any.

class azure.mgmt.cdn.models.ProfileProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the profile.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cdn.models.ProfileResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the profile.

ACTIVE = 'Active'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

class azure.mgmt.cdn.models.ProfileUpdateParameters(*, tags: Optional[Dict[str, str]] = None, origin_response_timeout_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Properties required to update a profile.

Variables

tags (dict[str, str]) – Profile tags.
origin_response_timeout_seconds (int) – Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

Keyword Arguments

tags (dict[str, str]) – Profile tags.
origin_response_timeout_seconds (int) – Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

class azure.mgmt.cdn.models.ProtocolType(value)[source]¶

Bases: str, enum.Enum

Defines the TLS extension protocol that is used for secure delivery.

IP_BASED = 'IPBased'¶

SERVER_NAME_INDICATION = 'ServerNameIndication'¶

class azure.mgmt.cdn.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning state of the WebApplicationFirewallPolicy.

CREATING = 'Creating'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cdn.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.

class azure.mgmt.cdn.models.PurgeParameters(*, content_paths: List[str], **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Parameters required for content purge.

All required parameters must be populated in order to send to Azure.

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

class azure.mgmt.cdn.models.QueryStringBehavior(value)[source]¶

Bases: str, enum.Enum

Caching behavior for the requests.

EXCLUDE = 'Exclude'¶

EXCLUDE_ALL = 'ExcludeAll'¶

INCLUDE = 'Include'¶

INCLUDE_ALL = 'IncludeAll'¶

class azure.mgmt.cdn.models.QueryStringCachingBehavior(value)[source]¶

Bases: str, enum.Enum

Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

BYPASS_CACHING = 'BypassCaching'¶

IGNORE_QUERY_STRING = 'IgnoreQueryString'¶

NOT_SET = 'NotSet'¶

USE_QUERY_STRING = 'UseQueryString'¶

class azure.mgmt.cdn.models.QueryStringMatchConditionParameters(*, type_name: Union[str, _models.QueryStringMatchConditionParametersTypeName], operator: Union[str, _models.QueryStringOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for QueryString match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or QueryStringMatchConditionParametersTypeName) – Required. “DeliveryRuleQueryStringConditionParameters”
operator (str or QueryStringOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or QueryStringMatchConditionParametersTypeName) – Required. “DeliveryRuleQueryStringConditionParameters”
operator (str or QueryStringOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.QueryStringMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

QueryStringMatchConditionParametersTypeName.

DELIVERY_RULE_QUERY_STRING_CONDITION_PARAMETERS = 'DeliveryRuleQueryStringConditionParameters'¶

class azure.mgmt.cdn.models.QueryStringOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.RankingsResponse(*, date_time_begin: Optional[datetime.datetime] = None, date_time_end: Optional[datetime.datetime] = None, tables: Optional[List[_models.RankingsResponseTablesItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Rankings Response.

Variables

date_time_begin (datetime) –
date_time_end (datetime) –
tables (list[RankingsResponseTablesItem]) –

Keyword Arguments

date_time_begin (datetime) –
date_time_end (datetime) –
tables (list[RankingsResponseTablesItem]) –

class azure.mgmt.cdn.models.RankingsResponseTablesItem(*, ranking: Optional[str] = None, data: Optional[List[_models.RankingsResponseTablesPropertiesItemsItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

RankingsResponseTablesItem.

Variables

ranking (str) –
data (list[RankingsResponseTablesPropertiesItemsItem]) –

Keyword Arguments

ranking (str) –
data (list[RankingsResponseTablesPropertiesItemsItem]) –

class azure.mgmt.cdn.models.RankingsResponseTablesPropertiesItemsItem(*, name: Optional[str] = None, metrics: Optional[List[_models.RankingsResponseTablesPropertiesItemsMetricsItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

RankingsResponseTablesPropertiesItemsItem.

Variables

name (str) –
metrics (list[RankingsResponseTablesPropertiesItemsMetricsItem]) –

Keyword Arguments

name (str) –
metrics (list[RankingsResponseTablesPropertiesItemsMetricsItem]) –

class azure.mgmt.cdn.models.RankingsResponseTablesPropertiesItemsMetricsItem(*, metric: Optional[str] = None, value: Optional[int] = None, percentage: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

RankingsResponseTablesPropertiesItemsMetricsItem.

Variables

metric (str) –
value (int) –
percentage (float) –

Keyword Arguments

metric (str) –
value (int) –
percentage (float) –

class azure.mgmt.cdn.models.RateLimitRule(*, name: str, priority: int, match_conditions: List[_models.MatchCondition], action: Union[str, _models.ActionType], rate_limit_threshold: int, rate_limit_duration_in_minutes: int, enabled_state: Optional[Union[str, _models.CustomRuleEnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.CustomRule

Defines a rate limiting rule that can be included in a waf policy.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Defines the name of the custom rule. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
priority (int) – Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions (list[MatchCondition]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.
rate_limit_threshold (int) – Defines rate limit threshold. Required.
rate_limit_duration_in_minutes (int) – Defines rate limit duration. Default is 1 minute. Required.

Keyword Arguments

name (str) – Defines the name of the custom rule. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
priority (int) – Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions (list[MatchCondition]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.
rate_limit_threshold (int) – Defines rate limit threshold. Required.
rate_limit_duration_in_minutes (int) – Defines rate limit duration. Default is 1 minute. Required.

class azure.mgmt.cdn.models.RateLimitRuleList(*, rules: Optional[List[_models.RateLimitRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines contents of rate limit rules.

Variables: rules (list[RateLimitRule]) – List of rules.
Keyword Arguments: rules (list[RateLimitRule]) – List of rules.

class azure.mgmt.cdn.models.RedirectType(value)[source]¶

Bases: str, enum.Enum

The redirect type the rule will use when redirecting traffic.

FOUND = 'Found'¶

MOVED = 'Moved'¶

PERMANENT_REDIRECT = 'PermanentRedirect'¶

TEMPORARY_REDIRECT = 'TemporaryRedirect'¶

class azure.mgmt.cdn.models.RemoteAddressMatchConditionParameters(*, type_name: Union[str, _models.RemoteAddressMatchConditionParametersTypeName], operator: Union[str, _models.RemoteAddressOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RemoteAddress match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RemoteAddressMatchConditionParametersTypeName) – Required. “DeliveryRuleRemoteAddressConditionParameters”
operator (str or RemoteAddressOperator) – Describes operator to be matched. Required. Known values are: “Any”, “IPMatch”, and “GeoMatch”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or RemoteAddressMatchConditionParametersTypeName) – Required. “DeliveryRuleRemoteAddressConditionParameters”
operator (str or RemoteAddressOperator) – Describes operator to be matched. Required. Known values are: “Any”, “IPMatch”, and “GeoMatch”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.RemoteAddressMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RemoteAddressMatchConditionParametersTypeName.

DELIVERY_RULE_REMOTE_ADDRESS_CONDITION_PARAMETERS = 'DeliveryRuleRemoteAddressConditionParameters'¶

class azure.mgmt.cdn.models.RemoteAddressOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

GEO_MATCH = 'GeoMatch'¶

IP_MATCH = 'IPMatch'¶

class azure.mgmt.cdn.models.RequestBodyMatchConditionParameters(*, type_name: Union[str, _models.RequestBodyMatchConditionParametersTypeName], operator: Union[str, _models.RequestBodyOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RequestBody match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RequestBodyMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestBodyConditionParameters”
operator (str or RequestBodyOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or RequestBodyMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestBodyConditionParameters”
operator (str or RequestBodyOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.RequestBodyMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RequestBodyMatchConditionParametersTypeName.

DELIVERY_RULE_REQUEST_BODY_CONDITION_PARAMETERS = 'DeliveryRuleRequestBodyConditionParameters'¶

class azure.mgmt.cdn.models.RequestBodyOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.RequestHeaderMatchConditionParameters(*, type_name: Union[str, _models.RequestHeaderMatchConditionParametersTypeName], operator: Union[str, _models.RequestHeaderOperator], selector: Optional[str] = None, negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RequestHeader match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RequestHeaderMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestHeaderConditionParameters”
selector (str) – Name of Header to be matched.
operator (str or RequestHeaderOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or RequestHeaderMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestHeaderConditionParameters”
selector (str) – Name of Header to be matched.
operator (str or RequestHeaderOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.RequestHeaderMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RequestHeaderMatchConditionParametersTypeName.

DELIVERY_RULE_REQUEST_HEADER_CONDITION_PARAMETERS = 'DeliveryRuleRequestHeaderConditionParameters'¶

class azure.mgmt.cdn.models.RequestHeaderOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.RequestMethodMatchConditionParameters(*, type_name: Union[str, _models.RequestMethodMatchConditionParametersTypeName], operator: Union[str, _models.RequestMethodOperator], negate_condition: Optional[bool] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, match_values: Optional[List[Union[str, _models.RequestMethodMatchConditionParametersMatchValuesItem]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RequestMethod match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RequestMethodMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestMethodConditionParameters”
operator (str or RequestMethodOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
transforms (list[str or Transform]) – List of transforms.
match_values (list[str or RequestMethodMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.

Keyword Arguments

type_name (str or RequestMethodMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestMethodConditionParameters”
operator (str or RequestMethodOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
transforms (list[str or Transform]) – List of transforms.
match_values (list[str or RequestMethodMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.

class azure.mgmt.cdn.models.RequestMethodMatchConditionParametersMatchValuesItem(value)[source]¶

Bases: str, enum.Enum

RequestMethodMatchConditionParametersMatchValuesItem.

DELETE = 'DELETE'¶

GET = 'GET'¶

HEAD = 'HEAD'¶

OPTIONS = 'OPTIONS'¶

POST = 'POST'¶

PUT = 'PUT'¶

TRACE = 'TRACE'¶

class azure.mgmt.cdn.models.RequestMethodMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RequestMethodMatchConditionParametersTypeName.

DELIVERY_RULE_REQUEST_METHOD_CONDITION_PARAMETERS = 'DeliveryRuleRequestMethodConditionParameters'¶

class azure.mgmt.cdn.models.RequestMethodOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

EQUAL = 'Equal'¶

class azure.mgmt.cdn.models.RequestSchemeMatchConditionParameters(*, type_name: Union[str, _models.RequestSchemeMatchConditionParametersTypeName], operator: Union[str, _models.RequestSchemeMatchConditionParametersOperator], negate_condition: Optional[bool] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, match_values: Optional[List[Union[str, _models.RequestSchemeMatchConditionParametersMatchValuesItem]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RequestScheme match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RequestSchemeMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestSchemeConditionParameters”
operator (str or RequestSchemeMatchConditionParametersOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
transforms (list[str or Transform]) – List of transforms.
match_values (list[str or RequestSchemeMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.

Keyword Arguments

type_name (str or RequestSchemeMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestSchemeConditionParameters”
operator (str or RequestSchemeMatchConditionParametersOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
transforms (list[str or Transform]) – List of transforms.
match_values (list[str or RequestSchemeMatchConditionParametersMatchValuesItem]) – The match value for the condition of the delivery rule.

class azure.mgmt.cdn.models.RequestSchemeMatchConditionParametersMatchValuesItem(value)[source]¶

Bases: str, enum.Enum

RequestSchemeMatchConditionParametersMatchValuesItem.

HTTP = 'HTTP'¶

HTTPS = 'HTTPS'¶

class azure.mgmt.cdn.models.RequestSchemeMatchConditionParametersOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

EQUAL = 'Equal'¶

class azure.mgmt.cdn.models.RequestSchemeMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RequestSchemeMatchConditionParametersTypeName.

DELIVERY_RULE_REQUEST_SCHEME_CONDITION_PARAMETERS = 'DeliveryRuleRequestSchemeConditionParameters'¶

class azure.mgmt.cdn.models.RequestUriMatchConditionParameters(*, type_name: Union[str, _models.RequestUriMatchConditionParametersTypeName], operator: Union[str, _models.RequestUriOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for RequestUri match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RequestUriMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestUriConditionParameters”
operator (str or RequestUriOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or RequestUriMatchConditionParametersTypeName) – Required. “DeliveryRuleRequestUriConditionParameters”
operator (str or RequestUriOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.RequestUriMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RequestUriMatchConditionParametersTypeName.

DELIVERY_RULE_REQUEST_URI_CONDITION_PARAMETERS = 'DeliveryRuleRequestUriConditionParameters'¶

class azure.mgmt.cdn.models.RequestUriOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The core properties of ARM resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.

class azure.mgmt.cdn.models.ResourceReference(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Reference to another resource.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.cdn.models.ResourceType(value)[source]¶

Bases: str, enum.Enum

Type of CDN resource used in CheckNameAvailability.

MICROSOFT_CDN_PROFILES_AFD_ENDPOINTS = 'Microsoft.Cdn/Profiles/AfdEndpoints'¶

MICROSOFT_CDN_PROFILES_ENDPOINTS = 'Microsoft.Cdn/Profiles/Endpoints'¶

class azure.mgmt.cdn.models.ResourceUsage(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of check resource usage API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

resource_type (str) – Resource type for which the usage is provided.
unit (str or ResourceUsageUnit) – Unit of the usage. e.g. count. “count”
current_value (int) – Actual value of usage on the specified resource type.
limit (int) – Quota of the specified resource type.

class azure.mgmt.cdn.models.ResourceUsageListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of check resource usage API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ResourceUsage]) – List of resource usages.
next_link (str) – URL to get the next set of custom domain objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of custom domain objects if there are any.

class azure.mgmt.cdn.models.ResourceUsageUnit(value)[source]¶

Bases: str, enum.Enum

Unit of the usage. e.g. count.

COUNT = 'count'¶

class azure.mgmt.cdn.models.ResourcesResponse(*, endpoints: Optional[List[_models.ResourcesResponseEndpointsItem]] = None, custom_domains: Optional[List[_models.ResourcesResponseCustomDomainsItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Resources Response.

Variables

endpoints (list[ResourcesResponseEndpointsItem]) –
custom_domains (list[ResourcesResponseCustomDomainsItem]) –

Keyword Arguments

endpoints (list[ResourcesResponseEndpointsItem]) –
custom_domains (list[ResourcesResponseCustomDomainsItem]) –

class azure.mgmt.cdn.models.ResourcesResponseCustomDomainsItem(*, id: Optional[str] = None, name: Optional[str] = None, endpoint_id: Optional[str] = None, history: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ResourcesResponseCustomDomainsItem.

Variables

id (str) –
name (str) –
endpoint_id (str) –
history (bool) –

Keyword Arguments

id (str) –
name (str) –
endpoint_id (str) –
history (bool) –

class azure.mgmt.cdn.models.ResourcesResponseEndpointsItem(*, id: Optional[str] = None, name: Optional[str] = None, history: Optional[bool] = None, custom_domains: Optional[List[_models.ResourcesResponseEndpointsPropertiesItemsItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ResourcesResponseEndpointsItem.

Variables

id (str) –
name (str) –
history (bool) –
custom_domains (list[ResourcesResponseEndpointsPropertiesItemsItem]) –

Keyword Arguments

id (str) –
name (str) –
history (bool) –
custom_domains (list[ResourcesResponseEndpointsPropertiesItemsItem]) –

class azure.mgmt.cdn.models.ResourcesResponseEndpointsPropertiesItemsItem(*, id: Optional[str] = None, name: Optional[str] = None, endpoint_id: Optional[str] = None, history: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

ResourcesResponseEndpointsPropertiesItemsItem.

Variables

id (str) –
name (str) –
endpoint_id (str) –
history (bool) –

Keyword Arguments

id (str) –
name (str) –
endpoint_id (str) –
history (bool) –

class azure.mgmt.cdn.models.ResponseBasedDetectedErrorTypes(value)[source]¶

Bases: str, enum.Enum

Type of response errors for real user requests for which origin will be deemed unhealthy.

NONE = 'None'¶

TCP_AND_HTTP_ERRORS = 'TcpAndHttpErrors'¶

TCP_ERRORS_ONLY = 'TcpErrorsOnly'¶

class azure.mgmt.cdn.models.ResponseBasedOriginErrorDetectionParameters(*, response_based_detected_error_types: Optional[Union[str, _models.ResponseBasedDetectedErrorTypes]] = None, response_based_failover_threshold_percentage: Optional[int] = None, http_error_ranges: Optional[List[_models.HttpErrorRangeParameters]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties to determine origin health using real requests/responses.

Variables

response_based_detected_error_types (str or ResponseBasedDetectedErrorTypes) – Type of response errors for real user requests for which origin will be deemed unhealthy. Known values are: “None”, “TcpErrorsOnly”, and “TcpAndHttpErrors”.
response_based_failover_threshold_percentage (int) – The percentage of failed requests in the sample where failover should trigger.
http_error_ranges (list[HttpErrorRangeParameters]) – The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

Keyword Arguments

response_based_detected_error_types (str or ResponseBasedDetectedErrorTypes) – Type of response errors for real user requests for which origin will be deemed unhealthy. Known values are: “None”, “TcpErrorsOnly”, and “TcpAndHttpErrors”.
response_based_failover_threshold_percentage (int) – The percentage of failed requests in the sample where failover should trigger.
http_error_ranges (list[HttpErrorRangeParameters]) – The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

class azure.mgmt.cdn.models.Route(*, custom_domains: Optional[List[_models.ActivatedResourceReference]] = None, origin_group: Optional[_models.ResourceReference] = None, origin_path: Optional[str] = None, rule_sets: Optional[List[_models.ResourceReference]] = None, supported_protocols: Optional[List[Union[str, _models.AFDEndpointProtocols]]] = None, patterns_to_match: Optional[List[str]] = None, cache_configuration: Optional[_models.AfdRouteCacheConfiguration] = None, forwarding_protocol: Optional[Union[str, _models.ForwardingProtocol]] = None, link_to_default_domain: Optional[Union[str, _models.LinkToDefaultDomain]] = None, https_redirect: Optional[Union[str, _models.HttpsRedirect]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly Routes name mapping to the any Routes or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
endpoint_name (str) – The name of the endpoint which holds the route.
custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.

Keyword Arguments

custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.RouteConfigurationOverrideActionParameters(*, type_name: Union[str, _models.RouteConfigurationOverrideActionParametersTypeName], origin_group_override: Optional[_models.OriginGroupOverride] = None, cache_configuration: Optional[_models.CacheConfiguration] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the route configuration override action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or RouteConfigurationOverrideActionParametersTypeName) – Required. “DeliveryRuleRouteConfigurationOverrideActionParameters”
origin_group_override (OriginGroupOverride) – A reference to the origin group override configuration. Leave empty to use the default origin group on route.
cache_configuration (CacheConfiguration) – The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.

Keyword Arguments

type_name (str or RouteConfigurationOverrideActionParametersTypeName) – Required. “DeliveryRuleRouteConfigurationOverrideActionParameters”
origin_group_override (OriginGroupOverride) – A reference to the origin group override configuration. Leave empty to use the default origin group on route.
cache_configuration (CacheConfiguration) – The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.

class azure.mgmt.cdn.models.RouteConfigurationOverrideActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

RouteConfigurationOverrideActionParametersTypeName.

DELIVERY_RULE_ROUTE_CONFIGURATION_OVERRIDE_ACTION_PARAMETERS = 'DeliveryRuleRouteConfigurationOverrideActionParameters'¶

class azure.mgmt.cdn.models.RouteListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Route]) – List of AzureFrontDoor routes within a profile.
next_link (str) – URL to get the next set of route objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of route objects if there are any.

class azure.mgmt.cdn.models.RouteProperties(*, custom_domains: Optional[List[_models.ActivatedResourceReference]] = None, origin_group: Optional[_models.ResourceReference] = None, origin_path: Optional[str] = None, rule_sets: Optional[List[_models.ResourceReference]] = None, supported_protocols: Optional[List[Union[str, _models.AFDEndpointProtocols]]] = None, patterns_to_match: Optional[List[str]] = None, cache_configuration: Optional[_models.AfdRouteCacheConfiguration] = None, forwarding_protocol: Optional[Union[str, _models.ForwardingProtocol]] = None, link_to_default_domain: Optional[Union[str, _models.LinkToDefaultDomain]] = None, https_redirect: Optional[Union[str, _models.HttpsRedirect]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.RouteUpdatePropertiesParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the Routes to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
endpoint_name (str) – The name of the endpoint which holds the route.
custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.RouteUpdateParameters(*, custom_domains: Optional[List[_models.ActivatedResourceReference]] = None, origin_group: Optional[_models.ResourceReference] = None, origin_path: Optional[str] = None, rule_sets: Optional[List[_models.ResourceReference]] = None, supported_protocols: Optional[List[Union[str, _models.AFDEndpointProtocols]]] = None, patterns_to_match: Optional[List[str]] = None, cache_configuration: Optional[_models.AfdRouteCacheConfiguration] = None, forwarding_protocol: Optional[Union[str, _models.ForwardingProtocol]] = None, link_to_default_domain: Optional[Union[str, _models.LinkToDefaultDomain]] = None, https_redirect: Optional[Union[str, _models.HttpsRedirect]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

endpoint_name (str) – The name of the endpoint which holds the route.
custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.RouteUpdatePropertiesParameters(*, custom_domains: Optional[List[_models.ActivatedResourceReference]] = None, origin_group: Optional[_models.ResourceReference] = None, origin_path: Optional[str] = None, rule_sets: Optional[List[_models.ResourceReference]] = None, supported_protocols: Optional[List[Union[str, _models.AFDEndpointProtocols]]] = None, patterns_to_match: Optional[List[str]] = None, cache_configuration: Optional[_models.AfdRouteCacheConfiguration] = None, forwarding_protocol: Optional[Union[str, _models.ForwardingProtocol]] = None, link_to_default_domain: Optional[Union[str, _models.LinkToDefaultDomain]] = None, https_redirect: Optional[Union[str, _models.HttpsRedirect]] = None, enabled_state: Optional[Union[str, _models.EnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

endpoint_name (str) – The name of the endpoint which holds the route.
custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

custom_domains (list[ActivatedResourceReference]) – Domains referenced by this endpoint.
origin_group (ResourceReference) – A reference to the origin group.
origin_path (str) – A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
rule_sets (list[ResourceReference]) – rule sets referenced by this endpoint.
supported_protocols (list[str or AFDEndpointProtocols]) – List of supported protocols for this route.
patterns_to_match (list[str]) – The route patterns of the rule.
cache_configuration (AfdRouteCacheConfiguration) – The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
forwarding_protocol (str or ForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
link_to_default_domain (str or LinkToDefaultDomain) – whether this route will be linked to the default endpoint domain. Known values are: “Enabled” and “Disabled”.
https_redirect (str or HttpsRedirect) – Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: “Enabled” and “Disabled”.
enabled_state (str or EnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.cdn.models.Rule(*, order: Optional[int] = None, conditions: Optional[List[_models.DeliveryRuleCondition]] = None, actions: Optional[List[_models.DeliveryRuleAction]] = None, match_processing_behavior: Optional[Union[str, _models.MatchProcessingBehavior]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly Rules name mapping to the any Rules or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
rule_set_name (str) – The name of the rule set containing the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.

Keyword Arguments

order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

class azure.mgmt.cdn.models.RuleCacheBehavior(value)[source]¶

Bases: str, enum.Enum

Caching behavior for the requests.

HONOR_ORIGIN = 'HonorOrigin'¶

OVERRIDE_ALWAYS = 'OverrideAlways'¶

OVERRIDE_IF_ORIGIN_MISSING = 'OverrideIfOriginMissing'¶

class azure.mgmt.cdn.models.RuleIsCompressionEnabled(value)[source]¶

Bases: str, enum.Enum

Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cdn.models.RuleListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Rule]) – List of AzureFrontDoor rules within a rule set.
next_link (str) – URL to get the next set of rule objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of rule objects if there are any.

class azure.mgmt.cdn.models.RuleProperties(*, order: Optional[int] = None, conditions: Optional[List[_models.DeliveryRuleCondition]] = None, actions: Optional[List[_models.DeliveryRuleAction]] = None, match_processing_behavior: Optional[Union[str, _models.MatchProcessingBehavior]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.RuleUpdatePropertiesParameters, azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the Rules to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
rule_set_name (str) – The name of the rule set containing the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

Keyword Arguments

order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

class azure.mgmt.cdn.models.RuleQueryStringCachingBehavior(value)[source]¶

Bases: str, enum.Enum

Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

IGNORE_QUERY_STRING = 'IgnoreQueryString'¶

IGNORE_SPECIFIED_QUERY_STRINGS = 'IgnoreSpecifiedQueryStrings'¶

INCLUDE_SPECIFIED_QUERY_STRINGS = 'IncludeSpecifiedQueryStrings'¶

USE_QUERY_STRING = 'UseQueryString'¶

class azure.mgmt.cdn.models.RuleSet(**kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly RuleSet name mapping to the any RuleSet or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the rule set.

class azure.mgmt.cdn.models.RuleSetListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RuleSet]) – List of AzureFrontDoor rule sets within a profile.
next_link (str) – URL to get the next set of rule set objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of rule set objects if there are any.

class azure.mgmt.cdn.models.RuleSetProperties(**kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the Rule Set to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the rule set.

class azure.mgmt.cdn.models.RuleUpdateParameters(*, order: Optional[int] = None, conditions: Optional[List[_models.DeliveryRuleCondition]] = None, actions: Optional[List[_models.DeliveryRuleAction]] = None, match_processing_behavior: Optional[Union[str, _models.MatchProcessingBehavior]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

rule_set_name (str) – The name of the rule set containing the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

Keyword Arguments

order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

class azure.mgmt.cdn.models.RuleUpdatePropertiesParameters(*, order: Optional[int] = None, conditions: Optional[List[_models.DeliveryRuleCondition]] = None, actions: Optional[List[_models.DeliveryRuleAction]] = None, match_processing_behavior: Optional[Union[str, _models.MatchProcessingBehavior]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object that contains the properties of the rule to update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

rule_set_name (str) – The name of the rule set containing the rule.
order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

Keyword Arguments

order (int) – The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed.
actions (list[DeliveryRuleAction]) – A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

class azure.mgmt.cdn.models.Secret(*, parameters: Optional[_models.SecretParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

Friendly Secret name mapping to the any Secret or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the secret.
parameters (SecretParameters) – object which contains secret parameters.

Keyword Arguments

parameters (SecretParameters) – object which contains secret parameters.

class azure.mgmt.cdn.models.SecretListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Secret]) – List of AzureFrontDoor secrets within a profile.
next_link (str) – URL to get the next set of Secret objects if there are any.

Keyword Arguments

next_link (str) – URL to get the next set of Secret objects if there are any.

class azure.mgmt.cdn.models.SecretParameters(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The json object containing secret parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFirstPartyManagedCertificateParameters, CustomerCertificateParameters, ManagedCertificateParameters, UrlSigningKeyParameters

All required parameters must be populated in order to send to Azure.

Variables: type (str or SecretType) – The type of the secret resource. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.

class azure.mgmt.cdn.models.SecretProperties(*, parameters: Optional[_models.SecretParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDStateProperties

The JSON object that contains the properties of the Secret to create.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the secret.
parameters (SecretParameters) – object which contains secret parameters.

Keyword Arguments

parameters (SecretParameters) – object which contains secret parameters.

class azure.mgmt.cdn.models.SecretType(value)[source]¶

Bases: str, enum.Enum

The type of the secret resource.

AZURE_FIRST_PARTY_MANAGED_CERTIFICATE = 'AzureFirstPartyManagedCertificate'¶

CUSTOMER_CERTIFICATE = 'CustomerCertificate'¶

MANAGED_CERTIFICATE = 'ManagedCertificate'¶

URL_SIGNING_KEY = 'UrlSigningKey'¶

class azure.mgmt.cdn.models.SecurityPolicy(*, parameters: Optional[_models.SecurityPolicyPropertiesParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.ProxyResource

SecurityPolicy association for AzureFrontDoor profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the security policy.
parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.

Keyword Arguments

parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.

class azure.mgmt.cdn.models.SecurityPolicyListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SecurityPolicy]) – List of Security policies within a profile.
next_link (str) – URL to get the next set of security policy objects if there is any.

Keyword Arguments

next_link (str) – URL to get the next set of security policy objects if there is any.

class azure.mgmt.cdn.models.SecurityPolicyProperties(*, parameters: Optional[_models.SecurityPolicyPropertiesParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.AFDStateProperties

The json object that contains properties required to create a security policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or AfdProvisioningState) – Provisioning status. Known values are: “Succeeded”, “Failed”, “Updating”, “Deleting”, and “Creating”.
deployment_status (str or DeploymentStatus) – Known values are: “NotStarted”, “InProgress”, “Succeeded”, and “Failed”.
profile_name (str) – The name of the profile which holds the security policy.
parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.

Keyword Arguments

parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.

class azure.mgmt.cdn.models.SecurityPolicyPropertiesParameters(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The json object containing security policy parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SecurityPolicyWebApplicationFirewallParameters

All required parameters must be populated in order to send to Azure.

Variables: type (str or SecurityPolicyType) – The type of the Security policy to create. Required. “WebApplicationFirewall”

class azure.mgmt.cdn.models.SecurityPolicyType(value)[source]¶

Bases: str, enum.Enum

The type of the Security policy to create.

WEB_APPLICATION_FIREWALL = 'WebApplicationFirewall'¶

class azure.mgmt.cdn.models.SecurityPolicyUpdateParameters(*, parameters: Optional[_models.SecurityPolicyPropertiesParameters] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The JSON object containing security policy update parameters.

Variables: parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.
Keyword Arguments: parameters (SecurityPolicyPropertiesParameters) – object which contains security policy parameters.

class azure.mgmt.cdn.models.SecurityPolicyWebApplicationFirewallAssociation(*, domains: Optional[List[_models.ActivatedResourceReference]] = None, patterns_to_match: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

settings for security policy patterns to match.

Variables

domains (list[ActivatedResourceReference]) – List of domains.
patterns_to_match (list[str]) – List of paths.

Keyword Arguments

domains (list[ActivatedResourceReference]) – List of domains.
patterns_to_match (list[str]) – List of paths.

class azure.mgmt.cdn.models.SecurityPolicyWebApplicationFirewallParameters(*, waf_policy: Optional[_models.ResourceReference] = None, associations: Optional[List[_models.SecurityPolicyWebApplicationFirewallAssociation]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.SecurityPolicyPropertiesParameters

The json object containing security policy waf parameters.

All required parameters must be populated in order to send to Azure.

Variables

type (str or SecurityPolicyType) – The type of the Security policy to create. Required. “WebApplicationFirewall”
waf_policy (ResourceReference) – Resource ID.
associations (list[SecurityPolicyWebApplicationFirewallAssociation]) – Waf associations.

Keyword Arguments

waf_policy (ResourceReference) – Resource ID.
associations (list[SecurityPolicyWebApplicationFirewallAssociation]) – Waf associations.

class azure.mgmt.cdn.models.ServerPortMatchConditionParameters(*, type_name: Union[str, _models.ServerPortMatchConditionParametersTypeName], operator: Union[str, _models.ServerPortOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for ServerPort match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or ServerPortMatchConditionParametersTypeName) – Required. “DeliveryRuleServerPortConditionParameters”
operator (str or ServerPortOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or ServerPortMatchConditionParametersTypeName) – Required. “DeliveryRuleServerPortConditionParameters”
operator (str or ServerPortOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.ServerPortMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

ServerPortMatchConditionParametersTypeName.

DELIVERY_RULE_SERVER_PORT_CONDITION_PARAMETERS = 'DeliveryRuleServerPortConditionParameters'¶

class azure.mgmt.cdn.models.ServerPortOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.ServiceSpecification(*, log_specifications: Optional[List[_models.LogSpecification]] = None, metric_specifications: Optional[List[_models.MetricSpecification]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

One property of operation, include log specifications.

Variables

log_specifications (list[LogSpecification]) – Log specifications of operation.
metric_specifications (list[MetricSpecification]) – Metric specifications of operation.

Keyword Arguments

log_specifications (list[LogSpecification]) – Log specifications of operation.
metric_specifications (list[MetricSpecification]) – Metric specifications of operation.

class azure.mgmt.cdn.models.SharedPrivateLinkResourceProperties(*, private_link: Optional[_models.ResourceReference] = None, private_link_location: Optional[str] = None, group_id: Optional[str] = None, request_message: Optional[str] = None, status: Optional[Union[str, _models.SharedPrivateLinkResourceStatus]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.

Variables

private_link (ResourceReference) – The resource id of the resource the shared private link resource is for.
private_link_location (str) – The location of the shared private link resource.
group_id (str) – The group id from the provider of resource the shared private link resource is for.
request_message (str) – The request message for requesting approval of the shared private link resource.
status (str or SharedPrivateLinkResourceStatus) – Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.

Keyword Arguments

private_link (ResourceReference) – The resource id of the resource the shared private link resource is for.
private_link_location (str) – The location of the shared private link resource.
group_id (str) – The group id from the provider of resource the shared private link resource is for.
request_message (str) – The request message for requesting approval of the shared private link resource.
status (str or SharedPrivateLinkResourceStatus) – Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.

class azure.mgmt.cdn.models.SharedPrivateLinkResourceStatus(value)[source]¶

Bases: str, enum.Enum

Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

TIMEOUT = 'Timeout'¶

class azure.mgmt.cdn.models.Sku(*, name: Optional[Union[str, _models.SkuName]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.

ivar name

Name of the pricing tier. Known values are: “Standard_Verizon”, “Premium_Verizon”, “Custom_Verizon”, “Standard_Akamai”, “Standard_ChinaCdn”, “Standard_Microsoft”, “Standard_AzureFrontDoor”, “Premium_AzureFrontDoor”, “Standard_955BandWidth_ChinaCdn”, “Standard_AvgBandWidth_ChinaCdn”, “StandardPlus_ChinaCdn”, “StandardPlus_955BandWidth_ChinaCdn”, and “StandardPlus_AvgBandWidth_ChinaCdn”.

vartype name

str or ~azure.mgmt.cdn.models.SkuName

Keyword Arguments: name (str or SkuName) – Name of the pricing tier. Known values are: “Standard_Verizon”, “Premium_Verizon”, “Custom_Verizon”, “Standard_Akamai”, “Standard_ChinaCdn”, “Standard_Microsoft”, “Standard_AzureFrontDoor”, “Premium_AzureFrontDoor”, “Standard_955BandWidth_ChinaCdn”, “Standard_AvgBandWidth_ChinaCdn”, “StandardPlus_ChinaCdn”, “StandardPlus_955BandWidth_ChinaCdn”, and “StandardPlus_AvgBandWidth_ChinaCdn”.

class azure.mgmt.cdn.models.SkuName(value)[source]¶

Bases: str, enum.Enum

Name of the pricing tier.

CUSTOM_VERIZON = 'Custom_Verizon'¶

PREMIUM_AZURE_FRONT_DOOR = 'Premium_AzureFrontDoor'¶

PREMIUM_VERIZON = 'Premium_Verizon'¶

STANDARD955_BAND_WIDTH_CHINA_CDN = 'Standard_955BandWidth_ChinaCdn'¶

STANDARD_AKAMAI = 'Standard_Akamai'¶

STANDARD_AVG_BAND_WIDTH_CHINA_CDN = 'Standard_AvgBandWidth_ChinaCdn'¶

STANDARD_AZURE_FRONT_DOOR = 'Standard_AzureFrontDoor'¶

STANDARD_CHINA_CDN = 'Standard_ChinaCdn'¶

STANDARD_MICROSOFT = 'Standard_Microsoft'¶

STANDARD_PLUS955_BAND_WIDTH_CHINA_CDN = 'StandardPlus_955BandWidth_ChinaCdn'¶

STANDARD_PLUS_AVG_BAND_WIDTH_CHINA_CDN = 'StandardPlus_AvgBandWidth_ChinaCdn'¶

STANDARD_PLUS_CHINA_CDN = 'StandardPlus_ChinaCdn'¶

STANDARD_VERIZON = 'Standard_Verizon'¶

class azure.mgmt.cdn.models.SocketAddrMatchConditionParameters(*, type_name: Union[str, _models.SocketAddrMatchConditionParametersTypeName], operator: Union[str, _models.SocketAddrOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for SocketAddress match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or SocketAddrMatchConditionParametersTypeName) – Required. “DeliveryRuleSocketAddrConditionParameters”
operator (str or SocketAddrOperator) – Describes operator to be matched. Required. Known values are: “Any” and “IPMatch”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or SocketAddrMatchConditionParametersTypeName) – Required. “DeliveryRuleSocketAddrConditionParameters”
operator (str or SocketAddrOperator) – Describes operator to be matched. Required. Known values are: “Any” and “IPMatch”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.SocketAddrMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

SocketAddrMatchConditionParametersTypeName.

DELIVERY_RULE_SOCKET_ADDR_CONDITION_PARAMETERS = 'DeliveryRuleSocketAddrConditionParameters'¶

class azure.mgmt.cdn.models.SocketAddrOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

IP_MATCH = 'IPMatch'¶

class azure.mgmt.cdn.models.SslProtocol(value)[source]¶

Bases: str, enum.Enum

The protocol of an established TLS connection.

TL_SV1 = 'TLSv1'¶

TL_SV1_1 = 'TLSv1.1'¶

TL_SV1_2 = 'TLSv1.2'¶

class azure.mgmt.cdn.models.SslProtocolMatchConditionParameters(*, type_name: Union[str, _models.SslProtocolMatchConditionParametersTypeName], operator: Union[str, _models.SslProtocolOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[Union[str, _models.SslProtocol]]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for SslProtocol match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or SslProtocolMatchConditionParametersTypeName) – Required. “DeliveryRuleSslProtocolConditionParameters”
operator (str or SslProtocolOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str or SslProtocol]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or SslProtocolMatchConditionParametersTypeName) – Required. “DeliveryRuleSslProtocolConditionParameters”
operator (str or SslProtocolOperator) – Describes operator to be matched. Required. “Equal”
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str or SslProtocol]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.SslProtocolMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

SslProtocolMatchConditionParametersTypeName.

DELIVERY_RULE_SSL_PROTOCOL_CONDITION_PARAMETERS = 'DeliveryRuleSslProtocolConditionParameters'¶

class azure.mgmt.cdn.models.SslProtocolOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

EQUAL = 'Equal'¶

class azure.mgmt.cdn.models.SsoUri(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The URI required to login to the supplemental portal from the Azure portal.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: sso_uri_value (str) – The URI used to login to the supplemental portal.

class azure.mgmt.cdn.models.Status(value)[source]¶

Bases: str, enum.Enum

The validation status.

ACCESS_DENIED = 'AccessDenied'¶

CERTIFICATE_EXPIRED = 'CertificateExpired'¶

INVALID = 'Invalid'¶

VALID = 'Valid'¶

class azure.mgmt.cdn.models.SupportedOptimizationTypesListResult(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The result of the GetSupportedOptimizationTypes API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: supported_optimization_types (list[str or OptimizationType]) – Supported optimization types for a profile.

class azure.mgmt.cdn.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.IdentityType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.IdentityType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Read only system data.

Variables

created_by (str) – An identifier for the identity that created the resource.
created_by_type (str or IdentityType) – The type of identity that created the resource. Known values are: “user”, “application”, “managedIdentity”, and “key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – An identifier for the identity that last modified the resource.
last_modified_by_type (str or IdentityType) – The type of identity that last modified the resource. Known values are: “user”, “application”, “managedIdentity”, and “key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – An identifier for the identity that created the resource.
created_by_type (str or IdentityType) – The type of identity that created the resource. Known values are: “user”, “application”, “managedIdentity”, and “key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – An identifier for the identity that last modified the resource.
last_modified_by_type (str or IdentityType) – The type of identity that last modified the resource. Known values are: “user”, “application”, “managedIdentity”, and “key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.cdn.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.Resource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – Read only system data.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.cdn.models.Transform(value)[source]¶

Bases: str, enum.Enum

Describes what transforms are applied before matching.

LOWERCASE = 'Lowercase'¶

REMOVE_NULLS = 'RemoveNulls'¶

TRIM = 'Trim'¶

UPPERCASE = 'Uppercase'¶

URL_DECODE = 'UrlDecode'¶

URL_ENCODE = 'UrlEncode'¶

class azure.mgmt.cdn.models.TransformType(value)[source]¶

Bases: str, enum.Enum

Describes what transforms were applied before matching.

LOWERCASE = 'Lowercase'¶

REMOVE_NULLS = 'RemoveNulls'¶

TRIM = 'Trim'¶

UPPERCASE = 'Uppercase'¶

URL_DECODE = 'UrlDecode'¶

URL_ENCODE = 'UrlEncode'¶

class azure.mgmt.cdn.models.UpdateRule(value)[source]¶

Bases: str, enum.Enum

Describes the action that shall be taken when the certificate is updated in Key Vault.

NO_ACTION = 'NoAction'¶

class azure.mgmt.cdn.models.UrlFileExtensionMatchConditionParameters(*, type_name: Union[str, _models.UrlFileExtensionMatchConditionParametersTypeName], operator: Union[str, _models.UrlFileExtensionOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for UrlFileExtension match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlFileExtensionMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlFileExtensionMatchConditionParameters”
operator (str or UrlFileExtensionOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or UrlFileExtensionMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlFileExtensionMatchConditionParameters”
operator (str or UrlFileExtensionOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.UrlFileExtensionMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlFileExtensionMatchConditionParametersTypeName.

DELIVERY_RULE_URL_FILE_EXTENSION_MATCH_CONDITION_PARAMETERS = 'DeliveryRuleUrlFileExtensionMatchConditionParameters'¶

class azure.mgmt.cdn.models.UrlFileExtensionOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.UrlFileNameMatchConditionParameters(*, type_name: Union[str, _models.UrlFileNameMatchConditionParametersTypeName], operator: Union[str, _models.UrlFileNameOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for UrlFilename match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlFileNameMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlFilenameConditionParameters”
operator (str or UrlFileNameOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or UrlFileNameMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlFilenameConditionParameters”
operator (str or UrlFileNameOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.UrlFileNameMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlFileNameMatchConditionParametersTypeName.

DELIVERY_RULE_URL_FILENAME_CONDITION_PARAMETERS = 'DeliveryRuleUrlFilenameConditionParameters'¶

class azure.mgmt.cdn.models.UrlFileNameOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

class azure.mgmt.cdn.models.UrlPathMatchConditionParameters(*, type_name: Union[str, _models.UrlPathMatchConditionParametersTypeName], operator: Union[str, _models.UrlPathOperator], negate_condition: Optional[bool] = None, match_values: Optional[List[str]] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for UrlPath match conditions.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlPathMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlPathMatchConditionParameters”
operator (str or UrlPathOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, “Wildcard”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

type_name (str or UrlPathMatchConditionParametersTypeName) – Required. “DeliveryRuleUrlPathMatchConditionParameters”
operator (str or UrlPathOperator) – Describes operator to be matched. Required. Known values are: “Any”, “Equal”, “Contains”, “BeginsWith”, “EndsWith”, “LessThan”, “LessThanOrEqual”, “GreaterThan”, “GreaterThanOrEqual”, “Wildcard”, and “RegEx”.
negate_condition (bool) – Describes if this is negate condition or not.
match_values (list[str]) – The match value for the condition of the delivery rule.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.cdn.models.UrlPathMatchConditionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlPathMatchConditionParametersTypeName.

DELIVERY_RULE_URL_PATH_MATCH_CONDITION_PARAMETERS = 'DeliveryRuleUrlPathMatchConditionParameters'¶

class azure.mgmt.cdn.models.UrlPathOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to be matched.

ANY = 'Any'¶

BEGINS_WITH = 'BeginsWith'¶

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUAL = 'Equal'¶

GREATER_THAN = 'GreaterThan'¶

GREATER_THAN_OR_EQUAL = 'GreaterThanOrEqual'¶

LESS_THAN = 'LessThan'¶

LESS_THAN_OR_EQUAL = 'LessThanOrEqual'¶

REG_EX = 'RegEx'¶

WILDCARD = 'Wildcard'¶

class azure.mgmt.cdn.models.UrlRedirectAction(*, parameters: _models.UrlRedirectActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the url redirect action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (UrlRedirectActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (UrlRedirectActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.UrlRedirectActionParameters(*, type_name: Union[str, _models.UrlRedirectActionParametersTypeName], redirect_type: Union[str, _models.RedirectType], destination_protocol: Optional[Union[str, _models.DestinationProtocol]] = None, custom_path: Optional[str] = None, custom_hostname: Optional[str] = None, custom_query_string: Optional[str] = None, custom_fragment: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the url redirect action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlRedirectActionParametersTypeName) – Required. “DeliveryRuleUrlRedirectActionParameters”
redirect_type (str or RedirectType) – The redirect type the rule will use when redirecting traffic. Required. Known values are: “Moved”, “Found”, “TemporaryRedirect”, and “PermanentRedirect”.
destination_protocol (str or DestinationProtocol) – Protocol to use for the redirect. The default value is MatchRequest. Known values are: “MatchRequest”, “Http”, and “Https”.
custom_path (str) – The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
custom_hostname (str) – Host to redirect. Leave empty to use the incoming host as the destination host.
custom_query_string (str) – The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>`=:code:`<value> format. ? and & will be added automatically so do not include them.
custom_fragment (str) – Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

Keyword Arguments

type_name (str or UrlRedirectActionParametersTypeName) – Required. “DeliveryRuleUrlRedirectActionParameters”
redirect_type (str or RedirectType) – The redirect type the rule will use when redirecting traffic. Required. Known values are: “Moved”, “Found”, “TemporaryRedirect”, and “PermanentRedirect”.
destination_protocol (str or DestinationProtocol) – Protocol to use for the redirect. The default value is MatchRequest. Known values are: “MatchRequest”, “Http”, and “Https”.
custom_path (str) – The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
custom_hostname (str) – Host to redirect. Leave empty to use the incoming host as the destination host.
custom_query_string (str) – The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>`=:code:`<value> format. ? and & will be added automatically so do not include them.
custom_fragment (str) – Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

class azure.mgmt.cdn.models.UrlRedirectActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlRedirectActionParametersTypeName.

DELIVERY_RULE_URL_REDIRECT_ACTION_PARAMETERS = 'DeliveryRuleUrlRedirectActionParameters'¶

class azure.mgmt.cdn.models.UrlRewriteAction(*, parameters: _models.UrlRewriteActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the url rewrite action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (UrlRewriteActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (UrlRewriteActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.UrlRewriteActionParameters(*, type_name: Union[str, _models.UrlRewriteActionParametersTypeName], source_pattern: str, destination: str, preserve_unmatched_path: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the url rewrite action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlRewriteActionParametersTypeName) – Required. “DeliveryRuleUrlRewriteActionParameters”
source_pattern (str) – define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. Required.
destination (str) – Define the relative URL to which the above requests will be rewritten by. Required.
preserve_unmatched_path (bool) – Whether to preserve unmatched path. Default value is true.

Keyword Arguments

type_name (str or UrlRewriteActionParametersTypeName) – Required. “DeliveryRuleUrlRewriteActionParameters”
source_pattern (str) – define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. Required.
destination (str) – Define the relative URL to which the above requests will be rewritten by. Required.
preserve_unmatched_path (bool) – Whether to preserve unmatched path. Default value is true.

class azure.mgmt.cdn.models.UrlRewriteActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlRewriteActionParametersTypeName.

DELIVERY_RULE_URL_REWRITE_ACTION_PARAMETERS = 'DeliveryRuleUrlRewriteActionParameters'¶

class azure.mgmt.cdn.models.UrlSigningAction(*, parameters: _models.UrlSigningActionParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.DeliveryRuleAction

Defines the url signing action for the delivery rule.

All required parameters must be populated in order to send to Azure.

Variables

name (str or DeliveryRuleActionEnum) – The name of the action for the delivery rule. Required. Known values are: “CacheExpiration”, “CacheKeyQueryString”, “ModifyRequestHeader”, “ModifyResponseHeader”, “UrlRedirect”, “UrlRewrite”, “UrlSigning”, “OriginGroupOverride”, and “RouteConfigurationOverride”.
parameters (UrlSigningActionParameters) – Defines the parameters for the action. Required.

Keyword Arguments

parameters (UrlSigningActionParameters) – Defines the parameters for the action. Required.

class azure.mgmt.cdn.models.UrlSigningActionParameters(*, type_name: Union[str, _models.UrlSigningActionParametersTypeName], algorithm: Optional[Union[str, _models.Algorithm]] = None, parameter_name_override: Optional[List[_models.UrlSigningParamIdentifier]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines the parameters for the Url Signing action.

All required parameters must be populated in order to send to Azure.

Variables

type_name (str or UrlSigningActionParametersTypeName) – Required. “DeliveryRuleUrlSigningActionParameters”
algorithm (str or Algorithm) – Algorithm to use for URL signing. “SHA256”
parameter_name_override (list[UrlSigningParamIdentifier]) – Defines which query string parameters in the url to be considered for expires, key id etc.

Keyword Arguments

type_name (str or UrlSigningActionParametersTypeName) – Required. “DeliveryRuleUrlSigningActionParameters”
algorithm (str or Algorithm) – Algorithm to use for URL signing. “SHA256”
parameter_name_override (list[UrlSigningParamIdentifier]) – Defines which query string parameters in the url to be considered for expires, key id etc.

class azure.mgmt.cdn.models.UrlSigningActionParametersTypeName(value)[source]¶

Bases: str, enum.Enum

UrlSigningActionParametersTypeName.

DELIVERY_RULE_URL_SIGNING_ACTION_PARAMETERS = 'DeliveryRuleUrlSigningActionParameters'¶

class azure.mgmt.cdn.models.UrlSigningKey(*, key_id: str, key_source_parameters: _models.KeyVaultSigningKeyParameters, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Url signing key.

All required parameters must be populated in order to send to Azure.

Variables

key_id (str) – Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.
key_source_parameters (KeyVaultSigningKeyParameters) – Defines the parameters for using customer key vault for Url Signing Key. Required.

Keyword Arguments

key_id (str) – Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.
key_source_parameters (KeyVaultSigningKeyParameters) – Defines the parameters for using customer key vault for Url Signing Key. Required.

class azure.mgmt.cdn.models.UrlSigningKeyParameters(*, key_id: str, secret_source: _models.ResourceReference, secret_version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.SecretParameters

Url signing key parameters.

All required parameters must be populated in order to send to Azure.

Variables

type (str or SecretType) – The type of the secret resource. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
key_id (str) – Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}. Required.
secret_version (str) – Version of the secret to be used.

Keyword Arguments

key_id (str) – Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}. Required.
secret_version (str) – Version of the secret to be used.

class azure.mgmt.cdn.models.UrlSigningParamIdentifier(*, param_indicator: Union[str, _models.ParamIndicator], param_name: str, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Defines how to identify a parameter for a specific purpose e.g. expires.

All required parameters must be populated in order to send to Azure.

Variables

param_indicator (str or ParamIndicator) – Indicates the purpose of the parameter. Required. Known values are: “Expires”, “KeyId”, and “Signature”.
param_name (str) – Parameter name. Required.

Keyword Arguments

param_indicator (str or ParamIndicator) – Indicates the purpose of the parameter. Required. Known values are: “Expires”, “KeyId”, and “Signature”.
param_name (str) – Parameter name. Required.

class azure.mgmt.cdn.models.Usage(*, unit: Union[str, _models.UsageUnit], current_value: int, limit: int, name: _models.UsageName, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Describes resource usage.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource identifier.
unit (str or UsageUnit) – An enum describing the unit of measurement. Required. “Count”
current_value (int) – The current value of the usage. Required.
limit (int) – The limit of usage. Required.
name (UsageName) – The name of the type of usage. Required.

Keyword Arguments

unit (str or UsageUnit) – An enum describing the unit of measurement. Required. “Count”
current_value (int) – The current value of the usage. Required.
limit (int) – The limit of usage. Required.
name (UsageName) – The name of the type of usage. Required.

class azure.mgmt.cdn.models.UsageName(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The usage names.

Variables

value (str) – A string describing the resource name.
localized_value (str) – A localized string describing the resource name.

Keyword Arguments

value (str) – A string describing the resource name.
localized_value (str) – A localized string describing the resource name.

class azure.mgmt.cdn.models.UsageUnit(value)[source]¶

Bases: str, enum.Enum

An enum describing the unit of measurement.

COUNT = 'Count'¶

class azure.mgmt.cdn.models.UsagesListResult(*, value: Optional[List[_models.Usage]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The list usages operation response.

Variables

value (list[Usage]) – The list of resource usages.
next_link (str) – URL to get the next set of results.

Keyword Arguments

value (list[Usage]) – The list of resource usages.
next_link (str) – URL to get the next set of results.

class azure.mgmt.cdn.models.UserManagedHttpsParameters(*, protocol_type: Union[str, _models.ProtocolType], certificate_source_parameters: _models.KeyVaultCertificateSourceParameters, minimum_tls_version: Optional[Union[str, _models.MinimumTlsVersion]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn.models._models_py3.CustomDomainHttpsParameters

Defines the certificate source parameters using user’s keyvault certificate for enabling SSL.

All required parameters must be populated in order to send to Azure.

Variables

certificate_source (str or CertificateSource) – Defines the source of the SSL certificate. Required. Known values are: “AzureKeyVault” and “Cdn”.
protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.
certificate_source_parameters (KeyVaultCertificateSourceParameters) – Defines the certificate source parameters using user’s keyvault certificate for enabling SSL. Required.

Keyword Arguments

protocol_type (str or ProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. Known values are: “ServerNameIndication” and “IPBased”.
minimum_tls_version (str or MinimumTlsVersion) – TLS protocol version that will be used for Https. Known values are: “None”, “TLS10”, and “TLS12”.
certificate_source_parameters (KeyVaultCertificateSourceParameters) – Defines the certificate source parameters using user’s keyvault certificate for enabling SSL. Required.

class azure.mgmt.cdn.models.ValidateCustomDomainInput(*, host_name: str, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of the custom domain to be validated for DNS mapping.

All required parameters must be populated in order to send to Azure.

Variables: host_name (str) – The host name of the custom domain. Must be a domain name. Required.
Keyword Arguments: host_name (str) – The host name of the custom domain. Must be a domain name. Required.

class azure.mgmt.cdn.models.ValidateCustomDomainOutput(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of custom domain validation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

custom_domain_validated (bool) – Indicates whether the custom domain is valid or not.
reason (str) – The reason why the custom domain is not valid.
message (str) – Error message describing why the custom domain is not valid.

class azure.mgmt.cdn.models.ValidateProbeInput(*, probe_url: str, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of the validate probe API.

All required parameters must be populated in order to send to Azure.

Variables: probe_url (str) – The probe URL to validate. Required.
Keyword Arguments: probe_url (str) – The probe URL to validate. Required.

class azure.mgmt.cdn.models.ValidateProbeOutput(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of the validate probe API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

is_valid (bool) – Indicates whether the probe URL is accepted or not.
error_code (str) – Specifies the error code when the probe url is not accepted.
message (str) – The detailed error message describing why the probe URL is not accepted.

class azure.mgmt.cdn.models.ValidateSecretInput(*, secret_type: Union[str, _models.SecretType], secret_source: _models.ResourceReference, secret_version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Input of the secret to be validated.

All required parameters must be populated in order to send to Azure.

Variables

secret_type (str or SecretType) – The secret type. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}. Required.
secret_version (str) – Secret version, if customer is using a specific version.

Keyword Arguments

secret_type (str or SecretType) – The secret type. Required. Known values are: “UrlSigningKey”, “CustomerCertificate”, “ManagedCertificate”, and “AzureFirstPartyManagedCertificate”.
secret_source (ResourceReference) – Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}. Required.
secret_version (str) – Secret version, if customer is using a specific version.

class azure.mgmt.cdn.models.ValidateSecretOutput(*, status: Optional[Union[str, _models.Status]] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Output of the validated secret.

Variables

status (str or Status) – The validation status. Known values are: “Valid”, “Invalid”, “AccessDenied”, and “CertificateExpired”.
message (str) – Detailed error message.

Keyword Arguments

status (str or Status) – The validation status. Known values are: “Valid”, “Invalid”, “AccessDenied”, and “CertificateExpired”.
message (str) – Detailed error message.

class azure.mgmt.cdn.models.ValidationToken(**kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

The validation token.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: token (str) –

class azure.mgmt.cdn.models.WafAction(value)[source]¶

Bases: str, enum.Enum

WafAction.

ALLOW = 'allow'¶

BLOCK = 'block'¶

LOG = 'log'¶

REDIRECT = 'redirect'¶

class azure.mgmt.cdn.models.WafGranularity(value)[source]¶

Bases: str, enum.Enum

WafGranularity.

P1_D = 'P1D'¶

PT1_H = 'PT1H'¶

PT5_M = 'PT5M'¶

class azure.mgmt.cdn.models.WafMatchVariable(value)[source]¶

Bases: str, enum.Enum

Match variable to compare against.

COOKIES = 'Cookies'¶

POST_ARGS = 'PostArgs'¶

QUERY_STRING = 'QueryString'¶

REMOTE_ADDR = 'RemoteAddr'¶

REQUEST_BODY = 'RequestBody'¶

REQUEST_HEADER = 'RequestHeader'¶

REQUEST_METHOD = 'RequestMethod'¶

REQUEST_URI = 'RequestUri'¶

SOCKET_ADDR = 'SocketAddr'¶

class azure.mgmt.cdn.models.WafMetric(value)[source]¶

Bases: str, enum.Enum

WafMetric.

CLIENT_REQUEST_COUNT = 'clientRequestCount'¶

class azure.mgmt.cdn.models.WafMetricsResponse(*, date_time_begin: Optional[datetime.datetime] = None, date_time_end: Optional[datetime.datetime] = None, granularity: Optional[Union[str, _models.WafMetricsResponseGranularity]] = None, series: Optional[List[_models.WafMetricsResponseSeriesItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Waf Metrics Response.

Variables

date_time_begin (datetime) –
date_time_end (datetime) –
granularity (str or WafMetricsResponseGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”.
series (list[WafMetricsResponseSeriesItem]) –

Keyword Arguments

date_time_begin (datetime) –
date_time_end (datetime) –
granularity (str or WafMetricsResponseGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”.
series (list[WafMetricsResponseSeriesItem]) –

class azure.mgmt.cdn.models.WafMetricsResponseGranularity(value)[source]¶

Bases: str, enum.Enum

WafMetricsResponseGranularity.

P1_D = 'P1D'¶

PT1_H = 'PT1H'¶

PT5_M = 'PT5M'¶

class azure.mgmt.cdn.models.WafMetricsResponseSeriesItem(*, metric: Optional[str] = None, unit: Optional[Union[str, _models.WafMetricsResponseSeriesItemUnit]] = None, groups: Optional[List[_models.WafMetricsResponseSeriesPropertiesItemsItem]] = None, data: Optional[List[_models.Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

WafMetricsResponseSeriesItem.

Variables

metric (str) –
unit (str or WafMetricsResponseSeriesItemUnit) – “count”
groups (list[WafMetricsResponseSeriesPropertiesItemsItem]) –
data (list[Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems]) –

Keyword Arguments

metric (str) –
unit (str or WafMetricsResponseSeriesItemUnit) – “count”
groups (list[WafMetricsResponseSeriesPropertiesItemsItem]) –
data (list[Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems]) –

class azure.mgmt.cdn.models.WafMetricsResponseSeriesItemUnit(value)[source]¶

Bases: str, enum.Enum

WafMetricsResponseSeriesItemUnit.

COUNT = 'count'¶

class azure.mgmt.cdn.models.WafMetricsResponseSeriesPropertiesItemsItem(*, name: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

WafMetricsResponseSeriesPropertiesItemsItem.

Variables

name (str) –
value (str) –

Keyword Arguments

name (str) –
value (str) –

class azure.mgmt.cdn.models.WafRankingGroupBy(value)[source]¶

Bases: str, enum.Enum

WafRankingGroupBy.

CUSTOM_DOMAIN = 'customDomain'¶

HTTP_STATUS_CODE = 'httpStatusCode'¶

class azure.mgmt.cdn.models.WafRankingType(value)[source]¶

Bases: str, enum.Enum

WafRankingType.

ACTION = 'action'¶

CLIENT_IP = 'clientIp'¶

COUNTRY_OR_REGION = 'countryOrRegion'¶

RULE_GROUP = 'ruleGroup'¶

RULE_ID = 'ruleId'¶

RULE_TYPE = 'ruleType'¶

URL = 'url'¶

USER_AGENT = 'userAgent'¶

class azure.mgmt.cdn.models.WafRankingsResponse(*, date_time_begin: Optional[datetime.datetime] = None, date_time_end: Optional[datetime.datetime] = None, groups: Optional[List[str]] = None, data: Optional[List[_models.WafRankingsResponseDataItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

Waf Rankings Response.

Variables

date_time_begin (datetime) –
date_time_end (datetime) –
groups (list[str]) –
data (list[WafRankingsResponseDataItem]) –

Keyword Arguments

date_time_begin (datetime) –
date_time_end (datetime) –
groups (list[str]) –
data (list[WafRankingsResponseDataItem]) –

class azure.mgmt.cdn.models.WafRankingsResponseDataItem(*, group_values: Optional[List[str]] = None, metrics: Optional[List[_models.ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cdn._serialization.Model

WafRankingsResponseDataItem.

Variables

group_values (list[str]) –
metrics (list[ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems]) –

Keyword Arguments

group_values (list[str]) –
metrics (list[ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems]) –

class azure.mgmt.cdn.models.WafRuleType(value)[source]¶

Bases: str, enum.Enum

WafRuleType.

BOT = 'bot'¶

CUSTOM = 'custom'¶

MANAGED = 'managed'¶