class Azure::CDN::Mgmt::V2016_04_02::Models::Endpoint

CDN endpoint is the entity within a CDN profile containing configuration information regarding caching behaviors and origins. The CDN endpoint is exposed using the URL format <endpointname>.azureedge.net by default, but custom domains can also be created.

Attributes

content_types_to_compress[RW]

@return [Array<String>] List of content types on which compression will be applied. The value for the elements should be a valid MIME type.

host_name[RW]

@return [String] The host name of the endpoint {endpointName}.{DNSZone}

is_compression_enabled[RW]

@return [Boolean] Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.

is_http_allowed[RW]

@return [Boolean] 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[RW]

@return [Boolean] Indicates whether https traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

origin_host_header[RW]

@return [String] The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin.

origin_path[RW]

@return [String] The path used for origin requests.

origins[RW]

@return [Array<DeepCreatedOrigin>] The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.

provisioning_state[RW]

@return [ProvisioningState] Provisioning status of the endpoint. Possible values include: 'Creating', 'Succeeded', 'Failed'

query_string_caching_behavior[RW]

@return [QueryStringCachingBehavior] Defines the query string caching behavior. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'

resource_state[RW]

@return [EndpointResourceState] Resource status of the endpoint. Possible values include: 'Creating', 'Deleting', 'Running', 'Starting', 'Stopped', 'Stopping'

Public Class Methods

mapper() click to toggle source

Mapper for Endpoint class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2016-04-02/generated/azure_mgmt_cdn/models/endpoint.rb, line 73
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Endpoint',
    type: {
      name: 'Composite',
      class_name: 'Endpoint',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        host_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        origin_host_header: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.originHostHeader',
          type: {
            name: 'String'
          }
        },
        origin_path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.originPath',
          type: {
            name: 'String'
          }
        },
        content_types_to_compress: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.contentTypesToCompress',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_compression_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isCompressionEnabled',
          type: {
            name: 'Boolean'
          }
        },
        is_http_allowed: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isHttpAllowed',
          type: {
            name: 'Boolean'
          }
        },
        is_https_allowed: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isHttpsAllowed',
          type: {
            name: 'Boolean'
          }
        },
        query_string_caching_behavior: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryStringCachingBehavior',
          type: {
            name: 'Enum',
            module: 'QueryStringCachingBehavior'
          }
        },
        origins: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.origins',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DeepCreatedOriginElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DeepCreatedOrigin'
                }
            }
          }
        },
        resource_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceState',
          type: {
            name: 'Enum',
            module: 'EndpointResourceState'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        }
      }
    }
  }
end