Class: Azure::CDN::Mgmt::V2017_04_02::Models::Endpoint

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb

Overview

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.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Instance Attribute Details

#content_types_to_compress ⇒ Array<String>

applies. The value should be a valid MIME type.

Returns:

  • (Array<String>) —

    List of content types on which compression



28
29
30
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 28

def content_types_to_compress
  @content_types_to_compress
end

#geo_filters ⇒ Array<GeoFilter>

within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/

Returns:

  • (Array<GeoFilter>) —

    List of rules defining the user’s geo access



71
72
73
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 71

def geo_filters
  @geo_filters
end

#host_name ⇒ String

endpointName.DNSZone, e.g. consoto.azureedge.net

Returns:

  • (String) —

    The host name of the endpoint structured as



75
76
77
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 75

def host_name
  @host_name
end

#is_compression_enabled ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Indicates whether content compression is enabled on



35
36
37
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 35

def is_compression_enabled
  @is_compression_enabled
end

#is_http_allowed ⇒ Boolean

endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Returns:

  • (Boolean) —

    Indicates whether HTTP traffic is allowed on the



40
41
42
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 40

def is_http_allowed
  @is_http_allowed
end

#is_https_allowed ⇒ Boolean

endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Returns:

  • (Boolean) —

    Indicates whether HTTPS traffic is allowed on the



45
46
47
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 45

def is_https_allowed
  @is_https_allowed
end

#optimization_type ⇒ OptimizationType

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’

Returns:



61
62
63
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 61

def optimization_type
  @optimization_type
end

#origin_host_header ⇒ String

to origin. The default value is the host name of the origin.

Returns:

  • (String) —

    The host header CDN sends along with content requests



20
21
22
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 20

def origin_host_header
  @origin_host_header
end

#origin_path ⇒ String

retreive content from, e.g. contoso.cloudapp.net/originpath.

Returns:

  • (String) —

    A directory path on the origin that CDN can use to



24
25
26
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 24

def origin_path
  @origin_path
end

#origins ⇒ Array<DeepCreatedOrigin>

delivered via CDN.

Returns:



79
80
81
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 79

def origins
  @origins
end

#probe_path ⇒ String

accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path.

Returns:

  • (String) —

    Path to a file hosted on the origin which helps



66
67
68
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 66

def probe_path
  @probe_path
end

#provisioning_state ⇒ String

Returns Provisioning status of the endpoint.

Returns:

  • (String) —

    Provisioning status of the endpoint.



87
88
89
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 87

def provisioning_state
  @provisioning_state
end

#query_string_caching_behavior ⇒ QueryStringCachingBehavior

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’

Returns:



53
54
55
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 53

def query_string_caching_behavior
  @query_string_caching_behavior
end

#resource_state ⇒ EndpointResourceState

Possible values include: ‘Creating’, ‘Deleting’, ‘Running’, ‘Starting’, ‘Stopped’, ‘Stopping’

Returns:



84
85
86
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 84

def resource_state
  @resource_state
end

Class Method Details

.mapper ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/models/endpoint.rb', line 94

def self.mapper()
  {
    required: false,
    serialized_name: 'Endpoint',
    type: {
      name: 'Composite',
      class_name: 'Endpoint',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        origin_host_header: {
          required: false,
          serialized_name: 'properties.originHostHeader',
          type: {
            name: 'String'
          }
        },
        origin_path: {
          required: false,
          serialized_name: 'properties.originPath',
          type: {
            name: 'String'
          }
        },
        content_types_to_compress: {
          required: false,
          serialized_name: 'properties.contentTypesToCompress',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_compression_enabled: {
          required: false,
          serialized_name: 'properties.isCompressionEnabled',
          type: {
            name: 'Boolean'
          }
        },
        is_http_allowed: {
          required: false,
          serialized_name: 'properties.isHttpAllowed',
          type: {
            name: 'Boolean'
          }
        },
        is_https_allowed: {
          required: false,
          serialized_name: 'properties.isHttpsAllowed',
          type: {
            name: 'Boolean'
          }
        },
        query_string_caching_behavior: {
          required: false,
          serialized_name: 'properties.queryStringCachingBehavior',
          type: {
            name: 'Enum',
            module: 'QueryStringCachingBehavior'
          }
        },
        optimization_type: {
          required: false,
          serialized_name: 'properties.optimizationType',
          type: {
            name: 'String'
          }
        },
        probe_path: {
          required: false,
          serialized_name: 'properties.probePath',
          type: {
            name: 'String'
          }
        },
        geo_filters: {
          required: false,
          serialized_name: 'properties.geoFilters',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'GeoFilterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'GeoFilter'
                }
            }
          }
        },
        host_name: {
          required: false,
          read_only: true,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        origins: {
          required: true,
          serialized_name: 'properties.origins',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'DeepCreatedOriginElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DeepCreatedOrigin'
                }
            }
          }
        },
        resource_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceState',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end