azure.mgmt.cdn.models module

class azure.mgmt.cdn.models.Sku(name=None)[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, sku, tags=None)[source]

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

CDN profile represents the top level resource and the entry point into the CDN API. This allows users to set up a logical grouping of endpoints in addition to creating shared configuration settings and selecting pricing tiers and providers.

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.
  • 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) – Resource location.
  • tags (dict) – Resource tags.
  • sku (Sku) – The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.
class azure.mgmt.cdn.models.ProfileUpdateParameters(tags)[source]

Bases: msrest.serialization.Model

Properties required to update a profile.

Parameters:tags (dict) – Profile tags
class azure.mgmt.cdn.models.SsoUri(sso_uri_value=None)[source]

Bases: msrest.serialization.Model

SSO URI required to login to the supplemental portal.

Parameters:sso_uri_value (str) – The URI used to login to the supplemental portal.
class azure.mgmt.cdn.models.DeepCreatedOrigin(name, host_name, http_port=None, https_port=None)[source]

Bases: msrest.serialization.Model

Origin to be added when creating a CDN endpoint.

Parameters:
  • name (str) – Origin name
  • host_name (str) – The address of the origin. It can be a domain names, 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, origins, tags=None, origin_host_header=None, origin_path=None, content_types_to_compress=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, query_string_caching_behavior=None, optimization_type=None, geo_filters=None)[source]

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

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.

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) – Resource location.
  • tags (dict) – Resource tags.
  • origin_host_header (str) – The host header CDN sends along with content requests to origin. The default value is the host name of the origin.
  • origin_path (str) – The path used when CDN sends request to origin.
  • content_types_to_compress (list of 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 the query string caching behavior. Possible values include: ‘IgnoreQueryString’, ‘BypassCaching’, ‘UseQueryString’, ‘NotSet’
  • optimization_type (str) – Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.
  • geo_filters (list of GeoFilter) – List of rules defining user 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/
  • origins (list of DeepCreatedOrigin) – The source of the content being delivered via CDN.
class azure.mgmt.cdn.models.GeoFilter(relative_path, action, country_codes)[source]

Bases: msrest.serialization.Model

Rules defining user geo access within a CDN endpoint.

Parameters:
  • relative_path (str) – Relative path applicable to geo filter. (e.g. ‘/mypictures’, ‘/mypicture/kitty.jpg’, and etc.)
  • action (str or GeoFilterActions) – Action of the geo filter, i.e. allow or block access. Possible values include: ‘Block’, ‘Allow’
  • country_codes (list of str) – Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US.
class azure.mgmt.cdn.models.EndpointUpdateParameters(tags=None, origin_host_header=None, origin_path=None, content_types_to_compress=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, query_string_caching_behavior=None, optimization_type=None, geo_filters=None)[source]

Bases: msrest.serialization.Model

Properties required to create a new endpoint.

Parameters:
  • tags (dict) – Endpoint tags.
  • origin_host_header (str) – The host header CDN sends along with content requests to origin. The default value is the host name of the origin.
  • origin_path (str) – The path used when CDN sends request to origin.
  • content_types_to_compress (list of 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 the query string caching behavior. Possible values include: ‘IgnoreQueryString’, ‘BypassCaching’, ‘UseQueryString’, ‘NotSet’
  • optimization_type (str) – Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.
  • geo_filters (list of GeoFilter) – List of rules defining user 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/
class azure.mgmt.cdn.models.PurgeParameters(content_paths)[source]

Bases: msrest.serialization.Model

Parameters required for content purge.

Parameters:content_paths (list of str) – 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)[source]

Bases: msrest.serialization.Model

Parameters required for content load.

Parameters:content_paths (list of str) – 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, host_name, tags=None, http_port=None, https_port=None)[source]

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

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.
  • 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) – Resource location.
  • tags (dict) – Resource tags.
  • 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.OriginUpdateParameters(host_name=None, http_port=None, https_port=None)[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(location, host_name, tags=None, validation_data=None)[source]

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

Customer provided domain for branding purposes, e.g. www.consoto.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.
  • resource_state (str or CustomDomainResourceState) – Resource status of the custom domain. Possible values include: ‘Creating’, ‘Active’, ‘Deleting’
  • provisioning_state (str) – Provisioning status of the custom domain.
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
  • 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.CustomDomainParameters(host_name)[source]

Bases: msrest.serialization.Model

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

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

Bases: msrest.serialization.Model

Input of the custom domain to be validated for DNS mapping.

Parameters:host_name (str) – The host name of the custom domain. Must be a domain name.
class azure.mgmt.cdn.models.ValidateCustomDomainOutput(custom_domain_validated=None, reason=None, message=None)[source]

Bases: msrest.serialization.Model

Output of custom domain validation.

Parameters:
  • custom_domain_validated (bool) – Indicates whether the custom domain is validated 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)[source]

Bases: msrest.serialization.Model

Input of CheckNameAvailability API.

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

Parameters:name (str) – The resource name to validate.
Variables:type (str) – 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(name_available=None, reason=None, message=None)[source]

Bases: msrest.serialization.Model

Output of check name availability API.

Parameters:
  • 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.ResourceUsage(resource_type=None, unit=None, current_value=None, limit=None)[source]

Bases: msrest.serialization.Model

Output of check resource usage API.

Parameters:
  • resource_type (str) – Resource type of the usages.
  • unit (str) – Unit of the usage. e.g. Count.
  • current_value (int) – Actual value of the resource type.
  • limit (int) – Quota of the resource type.
class azure.mgmt.cdn.models.OperationDisplay(provider=None, resource=None, operation=None)[source]

Bases: msrest.serialization.Model

The object that represents the operation.

Parameters:
  • 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(name=None, display=None)[source]

Bases: msrest.serialization.Model

CDN REST API operation.

Parameters:
  • name (str) – Operation name: {provider}/{resource}/{operation}
  • display (OperationDisplay) – The object that represents the operation.
class azure.mgmt.cdn.models.CidrIpAddress(base_ip_address=None, prefix_length=None)[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=None, ipv4_addresses=None, ipv6_addresses=None)[source]

Bases: msrest.serialization.Model

CDN Ip address group.

Parameters:
  • delivery_region (str) – The delivery region of the ip address group
  • ipv4_addresses (list of CidrIpAddress) – The list of ip v4 addresses.
  • ipv6_addresses (list of CidrIpAddress) – The list of ip v6 addresses.
class azure.mgmt.cdn.models.EdgeNode(location, ip_address_groups, tags=None)[source]

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

Edge node of CDN service.

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

Variables:
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
  • ip_address_groups (list of IpAddressGroup) – List of ip address groups.
class azure.mgmt.cdn.models.EdgenodeResult(value=None)[source]

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

Parameters:value (list of EdgeNode) – Edge node of CDN service.
class azure.mgmt.cdn.models.Resource(location, tags=None)[source]

Bases: msrest.serialization.Model

The Resource definition.

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

Variables:
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
class azure.mgmt.cdn.models.ErrorResponse(code=None, message=None)[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.

Parameters:
  • 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.SkuName[source]

Bases: 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: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: 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: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

microsoft_cdn_profiles_endpoints = 'Microsoft.Cdn/Profiles/Endpoints'