Class: Azure::CDN::Mgmt::V2020_09_01::CdnManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CdnManagementClient

Creates initializes a new instance of the CdnManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



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
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 118

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @profiles = Profiles.new(self)
  @endpoints = Endpoints.new(self)
  @origins = Origins.new(self)
  @origin_groups = OriginGroups.new(self)
  @custom_domains = CustomDomains.new(self)
  @resource_usage_operations = ResourceUsageOperations.new(self)
  @operations = Operations.new(self)
  @edge_nodes = EdgeNodes.new(self)
  @afdprofiles = AFDProfiles.new(self)
  @afdcustom_domains = AFDCustomDomains.new(self)
  @afdendpoints = AFDEndpoints.new(self)
  @afdorigin_groups = AFDOriginGroups.new(self)
  @afdorigins = AFDOrigins.new(self)
  @routes = Routes.new(self)
  @rule_sets = RuleSets.new(self)
  @rules = Rules.new(self)
  @security_policies = SecurityPolicies.new(self)
  @secrets = Secrets.new(self)
  @validate = Validate.new(self)
  @log_analytics = LogAnalytics.new(self)
  @policies = Policies.new(self)
  @managed_rule_sets = ManagedRuleSets.new(self)
  @api_version = '2020-09-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



35
36
37
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 35

def accept_language
  @accept_language
end

#afdcustom_domains ⇒ AFDCustomDomains (readonly)

Returns afdcustom_domains.

Returns:



74
75
76
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 74

def afdcustom_domains
  @afdcustom_domains
end

#afdendpoints ⇒ AFDEndpoints (readonly)

Returns afdendpoints.

Returns:



77
78
79
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 77

def afdendpoints
  @afdendpoints
end

#afdorigin_groups ⇒ AFDOriginGroups (readonly)

Returns afdorigin_groups.

Returns:



80
81
82
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 80

def afdorigin_groups
  @afdorigin_groups
end

#afdorigins ⇒ AFDOrigins (readonly)

Returns afdorigins.

Returns:



83
84
85
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 83

def afdorigins
  @afdorigins
end

#afdprofiles ⇒ AFDProfiles (readonly)

Returns afdprofiles.

Returns:



71
72
73
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 71

def afdprofiles
  @afdprofiles
end

#api_version ⇒ String (readonly)

Current version is 2017-04-02.

Returns:

  • (String) —

    Version of the API to be used with the client request.



25
26
27
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 25

def api_version
  @api_version
end

#api_version1 ⇒ String

Current version is 2019-09-01.

Returns:

  • (String) —

    Version of the API to be used with the client request.



32
33
34
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 32

def api_version1
  @api_version1
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 18

def credentials
  @credentials
end

#custom_domains ⇒ CustomDomains (readonly)

Returns custom_domains.

Returns:



59
60
61
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 59

def custom_domains
  @custom_domains
end

#edge_nodes ⇒ EdgeNodes (readonly)

Returns edge_nodes.

Returns:



68
69
70
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 68

def edge_nodes
  @edge_nodes
end

#endpoints ⇒ Endpoints (readonly)

Returns endpoints.

Returns:



50
51
52
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 50

def endpoints
  @endpoints
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



44
45
46
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 44

def generate_client_request_id
  @generate_client_request_id
end

#log_analytics ⇒ LogAnalytics (readonly)

Returns log_analytics.

Returns:



104
105
106
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 104

def log_analytics
  @log_analytics
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



39
40
41
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 39

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#managed_rule_sets ⇒ ManagedRuleSets (readonly)

Returns managed_rule_sets.

Returns:



110
111
112
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 110

def managed_rule_sets
  @managed_rule_sets
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



65
66
67
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 65

def operations
  @operations
end

#origin_groups ⇒ OriginGroups (readonly)

Returns origin_groups.

Returns:



56
57
58
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 56

def origin_groups
  @origin_groups
end

#origins ⇒ Origins (readonly)

Returns origins.

Returns:



53
54
55
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 53

def origins
  @origins
end

#policies ⇒ Policies (readonly)

Returns policies.

Returns:



107
108
109
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 107

def policies
  @policies
end

#profiles ⇒ Profiles (readonly)

Returns profiles.

Returns:



47
48
49
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 47

def profiles
  @profiles
end

#resource_usage_operations ⇒ ResourceUsageOperations (readonly)

Returns resource_usage_operations.

Returns:



62
63
64
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 62

def resource_usage_operations
  @resource_usage_operations
end

#routes ⇒ Routes (readonly)

Returns routes.

Returns:



86
87
88
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 86

def routes
  @routes
end

#rule_sets ⇒ RuleSets (readonly)

Returns rule_sets.

Returns:



89
90
91
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 89

def rule_sets
  @rule_sets
end

#rules ⇒ Rules (readonly)

Returns rules.

Returns:



92
93
94
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 92

def rules
  @rules
end

#secrets ⇒ Secrets (readonly)

Returns secrets.

Returns:



98
99
100
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 98

def secrets
  @secrets
end

#security_policies ⇒ SecurityPolicies (readonly)

Returns security_policies.

Returns:



95
96
97
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 95

def security_policies
  @security_policies
end

#subscription_id ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



21
22
23
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 21

def subscription_id
  @subscription_id
end

#subscription_id1 ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



28
29
30
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 28

def subscription_id1
  @subscription_id1
end

#validate ⇒ Validate (readonly)

Returns validate.

Returns:



101
102
103
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 101

def validate
  @validate
end

Instance Method Details

#check_name_availability(check_name_availability_input, custom_headers: nil) ⇒ CheckNameAvailabilityOutput

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityOutput) —

    operation results.



223
224
225
226
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 223

def check_name_availability(check_name_availability_input, custom_headers:nil)
  response = check_name_availability_async(check_name_availability_input, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_async(check_name_availability_input, custom_headers: nil) ⇒ Concurrent::Promise

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 254

def check_name_availability_async(check_name_availability_input, custom_headers:nil)
  fail ArgumentError, 'check_name_availability_input is nil' if check_name_availability_input.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::CheckNameAvailabilityInput.mapper()
  request_content = self.serialize(request_mapper,  check_name_availability_input)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.Cdn/checkNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::CheckNameAvailabilityOutput.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#check_name_availability_with_http_info(check_name_availability_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



239
240
241
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 239

def check_name_availability_with_http_info(check_name_availability_input, custom_headers:nil)
  check_name_availability_async(check_name_availability_input, custom_headers:custom_headers).value!
end

#check_name_availability_with_subscription(check_name_availability_input, custom_headers: nil) ⇒ CheckNameAvailabilityOutput

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityOutput) —

    operation results.



324
325
326
327
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 324

def check_name_availability_with_subscription(check_name_availability_input, custom_headers:nil)
  response = check_name_availability_with_subscription_async(check_name_availability_input, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_with_subscription_async(check_name_availability_input, custom_headers: nil) ⇒ Concurrent::Promise

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 355

def check_name_availability_with_subscription_async(check_name_availability_input, custom_headers:nil)
  fail ArgumentError, 'check_name_availability_input is nil' if check_name_availability_input.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::CheckNameAvailabilityInput.mapper()
  request_content = self.serialize(request_mapper,  check_name_availability_input)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::CheckNameAvailabilityOutput.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#check_name_availability_with_subscription_with_http_info(check_name_availability_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



340
341
342
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 340

def check_name_availability_with_subscription_with_http_info(check_name_availability_input, custom_headers:nil)
  check_name_availability_with_subscription_async(check_name_availability_input, custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



170
171
172
173
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 170

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 195

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



182
183
184
185
186
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 182

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

#validate_probe(validate_probe_input, custom_headers: nil) ⇒ ValidateProbeOutput

Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.

will be added to the HTTP request.

Parameters:

  • validate_probe_input (ValidateProbeInput) —

    Input to check.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (ValidateProbeOutput) —

    operation results.



428
429
430
431
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 428

def validate_probe(validate_probe_input, custom_headers:nil)
  response = validate_probe_async(validate_probe_input, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#validate_probe_async(validate_probe_input, custom_headers: nil) ⇒ Concurrent::Promise

Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.

to the HTTP request.

Parameters:

  • validate_probe_input (ValidateProbeInput) —

    Input to check.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 461

def validate_probe_async(validate_probe_input, custom_headers:nil)
  fail ArgumentError, 'validate_probe_input is nil' if validate_probe_input.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::ValidateProbeInput.mapper()
  request_content = self.serialize(request_mapper,  validate_probe_input)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_09_01::Models::ValidateProbeOutput.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#validate_probe_with_http_info(validate_probe_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.

will be added to the HTTP request.

Parameters:

  • validate_probe_input (ValidateProbeInput) —

    Input to check.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



445
446
447
 
# File 'lib/2020-09-01/generated/azure_mgmt_cdn/cdn_management_client.rb', line 445

def validate_probe_with_http_info(validate_probe_input, custom_headers:nil)
  validate_probe_async(validate_probe_input, custom_headers:custom_headers).value!
end