azure.mgmt.cdn.models module

class azure.mgmt.cdn.models.Sku(*, name=None, **kwargs)[source]

Bases: msrest.serialization.Model

The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.

Parameters:name (str or SkuName) – Name of the pricing tier. Possible values include: ‘Standard_Verizon’, ‘Premium_Verizon’, ‘Custom_Verizon’, ‘Standard_Akamai’, ‘Standard_ChinaCdn’
class azure.mgmt.cdn.models.Profile(*, location: str, sku, tags=None, **kwargs)[source]

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

CDN profile is a logical grouping of endpoints that share the same settings, such as CDN provider and pricing tier.

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.
  • resource_state (str or ProfileResourceState) – Resource status of the profile. Possible values include: ‘Creating’, ‘Active’, ‘Deleting’, ‘Disabled’
  • provisioning_state (str) – Provisioning status of the profile.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • sku (Sku) – Required. The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.
class azure.mgmt.cdn.models.ProfileUpdateParameters(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties required to update a profile.

Parameters:tags (dict[str, str]) – Profile tags
class azure.mgmt.cdn.models.SsoUri(**kwargs)[source]

Bases: msrest.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.SupportedOptimizationTypesListResult(**kwargs)[source]

Bases: msrest.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.DeepCreatedOrigin(*, name: str, host_name: str, http_port: int = None, https_port: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:
  • name (str) – Required. Origin name
  • host_name (str) – Required. The address of the origin. It can be a domain name, IPv4 address, or IPv6 address.
  • 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
class azure.mgmt.cdn.models.Endpoint(*, location: str, origins, tags=None, origin_host_header: str = None, origin_path: str = None, content_types_to_compress=None, is_compression_enabled: bool = None, is_http_allowed: bool = None, is_https_allowed: bool = None, query_string_caching_behavior=None, optimization_type=None, probe_path: str = None, geo_filters=None, delivery_policy=None, **kwargs)[source]

Bases: azure.mgmt.cdn.models.tracked_resource_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.
  • host_name (str) – The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. consoto.azureedge.net
  • resource_state (str or EndpointResourceState) – Resource status of the endpoint. Possible values include: ‘Creating’, ‘Deleting’, ‘Running’, ‘Starting’, ‘Stopped’, ‘Stopping’
  • provisioning_state (str) – Provisioning status of the endpoint.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • 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.
  • origin_path (str) – A directory path on the origin that CDN can use to retreive 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.
  • 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. Possible values include: ‘IgnoreQueryString’, ‘BypassCaching’, ‘UseQueryString’, ‘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. Possible values include: ‘GeneralWebDelivery’, ‘GeneralMediaStreaming’, ‘VideoOnDemandMediaStreaming’, ‘LargeFileDownload’, ‘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.
  • geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/
  • delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
  • origins (list[DeepCreatedOrigin]) – Required. The source of the content being delivered via CDN.
class azure.mgmt.cdn.models.GeoFilter(*, relative_path: str, action, country_codes, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:
  • relative_path (str) – Required. Relative path applicable to geo filter. (e.g. ‘/mypictures’, ‘/mypicture/kitty.jpg’, and etc.)
  • action (str or GeoFilterActions) – Required. Action of the geo filter, i.e. allow or block access. Possible values include: ‘Block’, ‘Allow’
  • country_codes (list[str]) – Required. Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US.
class azure.mgmt.cdn.models.DeliveryRuleAction(**kwargs)[source]

Bases: msrest.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

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

Parameters:name (str) – Required. Constant filled by server.
class azure.mgmt.cdn.models.DeliveryRuleCondition(**kwargs)[source]

Bases: msrest.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: DeliveryRuleUrlPathCondition, DeliveryRuleUrlFileExtensionCondition

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

Parameters:name (str) – Required. Constant filled by server.
class azure.mgmt.cdn.models.DeliveryRule(*, order: int, actions, conditions=None, **kwargs)[source]

Bases: msrest.serialization.Model

A rule that specifies a set of actions and conditions.

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

Parameters:
  • order (int) – Required. 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.
  • actions (list[DeliveryRuleAction]) – Required. A list of actions that are executed when all the conditions of a rule are satisfied.
  • conditions (list[DeliveryRuleCondition]) – A list of conditions that must be matched for the actions to be executed
class azure.mgmt.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy(*, rules, description: str = None, **kwargs)[source]

Bases: msrest.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.

Parameters:
  • description (str) – User-friendly description of the policy.
  • rules (list[DeliveryRule]) – Required. A list of the delivery rules.
class azure.mgmt.cdn.models.EndpointUpdateParameters(*, tags=None, origin_host_header: str = None, origin_path: str = None, content_types_to_compress=None, is_compression_enabled: bool = None, is_http_allowed: bool = None, is_https_allowed: bool = None, query_string_caching_behavior=None, optimization_type=None, probe_path: str = None, geo_filters=None, delivery_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties required to create or update an endpoint.

Parameters:
  • tags (dict[str, str]) – Endpoint tags.
  • 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.
  • origin_path (str) – A directory path on the origin that CDN can use to retreive 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.
  • 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. Possible values include: ‘IgnoreQueryString’, ‘BypassCaching’, ‘UseQueryString’, ‘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. Possible values include: ‘GeneralWebDelivery’, ‘GeneralMediaStreaming’, ‘VideoOnDemandMediaStreaming’, ‘LargeFileDownload’, ‘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.
  • geo_filters (list[GeoFilter]) – List of rules defining the user’s geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/
  • delivery_policy (EndpointPropertiesUpdateParametersDeliveryPolicy) – A policy that specifies the delivery rules to be used for an endpoint.
class azure.mgmt.cdn.models.UrlPathConditionParameters(*, path: str, match_type, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the parameters for the URL path condition.

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:

odatatype (str) – Required. Default value: “Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathConditionParameters” .

Parameters:
  • path (str) – Required. A URL path for the condition of the delivery rule
  • match_type (str or enum) – Required. The match type for the condition of the delivery rule. Possible values include: ‘Literal’, ‘Wildcard’
odatatype = 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathConditionParameters'
class azure.mgmt.cdn.models.DeliveryRuleUrlPathCondition(*, parameters, **kwargs)[source]

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

Defines the URL path condition for the delivery rule.

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

Parameters:
  • name (str) – Required. Constant filled by server.
  • parameters (UrlPathConditionParameters) – Required. Defines the parameters for the condition.
class azure.mgmt.cdn.models.UrlFileExtensionConditionParameters(*, extensions, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the parameters for the URL file extension condition.

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:odatatype (str) – Required. Default value: “Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionConditionParameters” .
Parameters:extensions (list[str]) – Required. A list of extensions for the condition of the delivery rule.
odatatype = 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionConditionParameters'
class azure.mgmt.cdn.models.DeliveryRuleUrlFileExtensionCondition(*, parameters, **kwargs)[source]

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

Defines the URL file extension condition for the delivery rule.

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

Parameters:
class azure.mgmt.cdn.models.CacheExpirationActionParameters(*, cache_behavior, cache_duration: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the parameters for the cache expiration action.

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:
  • odatatype (str) – Required. Default value: “Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters” .
  • cache_type (str) – Required. The level at which the content needs to be cached. Default value: “All” .
Parameters:
  • cache_behavior (str or enum) – Required. Caching behavior for the requests that include query strings. Possible values include: ‘BypassCache’, ‘Override’, ‘SetIfMissing’
  • cache_duration (str) – The duration for which the the content needs to be cached. Allowed format is [d.]hh:mm:ss
cache_type = 'All'
odatatype = 'Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters'
class azure.mgmt.cdn.models.DeliveryRuleCacheExpirationAction(*, parameters, **kwargs)[source]

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

Defines the cache expiration action for the delivery rule.

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

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

Bases: msrest.serialization.Model

Parameters required for content purge.

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

Parameters:content_paths (list[str]) – Required. The path to the content to be purged. Can describe a file path or a wild card directory.
class azure.mgmt.cdn.models.LoadParameters(*, content_paths, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters required for content load.

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

Parameters:content_paths (list[str]) – Required. The path to the content to be loaded. Path should be a relative file URL of the origin.
class azure.mgmt.cdn.models.Origin(*, location: str, host_name: str, tags=None, http_port: int = None, https_port: int = None, **kwargs)[source]

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

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.

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.
  • resource_state (str or OriginResourceState) – Resource status of the origin. Possible values include: ‘Creating’, ‘Active’, ‘Deleting’
  • provisioning_state (str) – Provisioning status of the origin.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • host_name (str) – Required. The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.
  • 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.
class azure.mgmt.cdn.models.OriginUpdateParameters(*, host_name: str = None, http_port: int = None, https_port: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Origin properties needed for origin creation or update.

Parameters:
  • host_name (str) – The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.
  • 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.
class azure.mgmt.cdn.models.CustomDomain(*, host_name: str, validation_data: str = None, **kwargs)[source]

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

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

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.
  • resource_state (str or CustomDomainResourceState) – Resource status of the custom domain. Possible values include: ‘Creating’, ‘Active’, ‘Deleting’
  • custom_https_provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of Custom Https of the custom domain. Possible values include: ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Failed’
  • custom_https_provisioning_substate (str or CustomHttpsProvisioningSubstate) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Possible values include: ‘SubmittingDomainControlValidationRequest’, ‘PendingDomainControlValidationREquestApproval’, ‘DomainControlValidationRequestApproved’, ‘DomainControlValidationRequestRejected’, ‘DomainControlValidationRequestTimedOut’, ‘IssuingCertificate’, ‘DeployingCertificate’, ‘CertificateDeployed’, ‘DeletingCertificate’, ‘CertificateDeleted’
  • provisioning_state (str) – Provisioning status of the custom domain.
Parameters:
  • host_name (str) – Required. 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.CustomDomainParameters(*, host_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:host_name (str) – Required. The host name of the custom domain. Must be a domain name.
class azure.mgmt.cdn.models.ValidateCustomDomainInput(*, host_name: str, **kwargs)[source]

Bases: msrest.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.

Parameters:host_name (str) – Required. The host name of the custom domain. Must be a domain name.
class azure.mgmt.cdn.models.ValidateCustomDomainOutput(**kwargs)[source]

Bases: msrest.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.CheckNameAvailabilityInput(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Input of CheckNameAvailability API.

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.

Parameters:name (str) – Required. The resource name to validate.
Variables:type (str) – Required. The type of the resource whose name is to be validated. Default value: “Microsoft.Cdn/Profiles/Endpoints” .
type = 'Microsoft.Cdn/Profiles/Endpoints'
class azure.mgmt.cdn.models.CheckNameAvailabilityOutput(**kwargs)[source]

Bases: msrest.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.ValidateProbeInput(*, probe_url: str, **kwargs)[source]

Bases: msrest.serialization.Model

Input of the validate probe API.

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

Parameters:probe_url (str) – Required. The probe URL to validate.
class azure.mgmt.cdn.models.ValidateProbeOutput(**kwargs)[source]

Bases: msrest.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.ResourceUsage(**kwargs)[source]

Bases: msrest.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) – Unit of the usage. e.g. 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.OperationDisplay(**kwargs)[source]

Bases: msrest.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.
class azure.mgmt.cdn.models.Operation(*, display=None, **kwargs)[source]

Bases: msrest.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}
Parameters:display (OperationDisplay) – The object that represents the operation.
class azure.mgmt.cdn.models.CidrIpAddress(*, base_ip_address: str = None, prefix_length: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

CIDR Ip address.

Parameters:
  • base_ip_address (str) – Ip adress itself.
  • prefix_length (int) – The length of the prefix of the ip address.
class azure.mgmt.cdn.models.IpAddressGroup(*, delivery_region: str = None, ipv4_addresses=None, ipv6_addresses=None, **kwargs)[source]

Bases: msrest.serialization.Model

CDN Ip address group.

Parameters:
  • 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.EdgeNode(*, ip_address_groups, **kwargs)[source]

Bases: azure.mgmt.cdn.models.proxy_resource_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.

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

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

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

Bases: msrest.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.
class azure.mgmt.cdn.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]

Bases: azure.mgmt.cdn.models.resource_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.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
class azure.mgmt.cdn.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.cdn.models.resource_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.
class azure.mgmt.cdn.models.ErrorResponse(**kwargs)[source]

Bases: msrest.serialization.Model

Error reponse indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

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

Variables:
  • code (str) – Error code.
  • message (str) – Error message indicating why the operation failed.
exception azure.mgmt.cdn.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.mgmt.cdn.models.ProfilePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Profile object

class azure.mgmt.cdn.models.ResourceUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceUsage object

class azure.mgmt.cdn.models.EndpointPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Endpoint object

class azure.mgmt.cdn.models.OriginPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Origin object

class azure.mgmt.cdn.models.CustomDomainPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CustomDomain object

class azure.mgmt.cdn.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.cdn.models.EdgeNodePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EdgeNode object

class azure.mgmt.cdn.models.SkuName[source]

Bases: str, enum.Enum

An enumeration.

custom_verizon = 'Custom_Verizon'
premium_verizon = 'Premium_Verizon'
standard_akamai = 'Standard_Akamai'
standard_china_cdn = 'Standard_ChinaCdn'
standard_verizon = 'Standard_Verizon'
class azure.mgmt.cdn.models.ProfileResourceState[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
class azure.mgmt.cdn.models.OptimizationType[source]

Bases: str, enum.Enum

An enumeration.

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.EndpointResourceState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
running = 'Running'
starting = 'Starting'
stopped = 'Stopped'
stopping = 'Stopping'
class azure.mgmt.cdn.models.QueryStringCachingBehavior[source]

Bases: str, enum.Enum

An enumeration.

bypass_caching = 'BypassCaching'
ignore_query_string = 'IgnoreQueryString'
not_set = 'NotSet'
use_query_string = 'UseQueryString'
class azure.mgmt.cdn.models.GeoFilterActions[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
block = 'Block'
class azure.mgmt.cdn.models.OriginResourceState[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
class azure.mgmt.cdn.models.CustomDomainResourceState[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
class azure.mgmt.cdn.models.CustomHttpsProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
disabling = 'Disabling'
enabled = 'Enabled'
enabling = 'Enabling'
failed = 'Failed'
class azure.mgmt.cdn.models.CustomHttpsProvisioningSubstate[source]

Bases: str, enum.Enum

An enumeration.

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_request_approval = 'PendingDomainControlValidationREquestApproval'
submitting_domain_control_validation_request = 'SubmittingDomainControlValidationRequest'
class azure.mgmt.cdn.models.ResourceType[source]

Bases: str, enum.Enum

An enumeration.

microsoft_cdn_profiles_endpoints = 'Microsoft.Cdn/Profiles/Endpoints'