Class: Azure::ARM::CDN::CustomDomains

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_cdn/custom_domains.rb

Overview

Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CustomDomains

Creates and initializes a new instance of the CustomDomains class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CdnManagementClient (readonly)

Returns reference to the CdnManagementClient.

Returns:



25
26
27
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil) ⇒ CustomDomain

Creates a new CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. properties required for creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

  • custom_domain_properties (CustomDomainParameters) —

    Custom domain

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

    A hash of custom headers that

Returns:



372
373
374
375
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 372

def begin_create(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil)
  response = begin_create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil) ⇒ Concurrent::Promise

Creates a new CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. properties required for creation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

  • custom_domain_properties (CustomDomainParameters) —

    Custom domain

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
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
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 417

def begin_create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, 'custom_domain_name is nil' if custom_domain_name.nil?
  fail ArgumentError, 'custom_domain_properties is nil' if custom_domain_properties.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

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

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

  # Serialize Request
  request_mapper = CustomDomainParameters.mapper()
  request_content = @client.serialize(request_mapper,  custom_domain_properties, 'custom_domain_properties')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointName' => endpoint_name,'customDomainName' => custom_domain_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 201 || status_code == 202
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#begin_create_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. properties required for creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

  • custom_domain_properties (CustomDomainParameters) —

    Custom domain

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



395
396
397
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 395

def begin_create_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil)
  begin_create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers).value!
end

#begin_delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ CustomDomain

Deletes an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:



517
518
519
520
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 517

def begin_delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  response = begin_delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers).value!
  response.body unless response.nil?
end

#begin_delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ Concurrent::Promise

Deletes an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 558

def begin_delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, 'custom_domain_name is nil' if custom_domain_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointName' => endpoint_name,'customDomainName' => custom_domain_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 202 || status_code == 204
      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?
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#begin_delete_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



538
539
540
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 538

def begin_delete_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  begin_delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers).value!
end

#create(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil) ⇒ CustomDomain

Creates a new CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. properties required for creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

  • custom_domain_properties (CustomDomainParameters) —

    Custom domain

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

    A hash of custom headers that

Returns:



260
261
262
263
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 260

def create(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil)
  response = create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil) ⇒ Concurrent::Promise

Azure subscription. the resource group. unique globally. endpoint. properties required for creation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

  • custom_domain_properties (CustomDomainParameters) —

    Custom domain

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 282

def create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers = nil)
  # Send request
  promise = begin_create_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_properties, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = CustomDomain.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ CustomDomain

Deletes an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:



316
317
318
319
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 316

def delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  response = delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers).value!
  response.body unless response.nil?
end

#delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ Concurrent::Promise

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 336

def delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = CustomDomain.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ CustomDomain

Gets an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:



147
148
149
150
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 147

def get(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  response = get_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 188

def get_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, 'custom_domain_name is nil' if custom_domain_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointName' => endpoint_name,'customDomainName' => custom_domain_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#get_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an existing CDN custom domain within an endpoint.

Azure subscription. the resource group. unique globally. endpoint. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

  • custom_domain_name (String) —

    Name of the custom domain within an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



168
169
170
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 168

def get_with_http_info(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers = nil)
  get_async(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers).value!
end

#list_by_endpoint(resource_group_name, profile_name, endpoint_name, custom_headers = nil) ⇒ Array<CustomDomain>

Lists the existing CDN custom domains within an endpoint.

Azure subscription. the resource group. unique globally. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

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

    A hash of custom headers that

Returns:



41
42
43
44
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 41

def list_by_endpoint(resource_group_name, profile_name, endpoint_name, custom_headers = nil)
  first_page = list_by_endpoint_as_lazy(resource_group_name, profile_name, endpoint_name, custom_headers)
  first_page.get_all_items
end

#list_by_endpoint_as_lazy(resource_group_name, profile_name, endpoint_name, custom_headers = nil) ⇒ CustomDomainListResult

Lists the existing CDN custom domains within an endpoint.

Azure subscription. the resource group. unique globally. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

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

    A hash of custom headers that

Returns:



714
715
716
717
718
719
720
721
722
723
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 714

def list_by_endpoint_as_lazy(resource_group_name, profile_name, endpoint_name, custom_headers = nil)
  response = list_by_endpoint_async(resource_group_name, profile_name, endpoint_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_endpoint_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_by_endpoint_async(resource_group_name, profile_name, endpoint_name, custom_headers = nil) ⇒ Concurrent::Promise

Lists the existing CDN custom domains within an endpoint.

Azure subscription. the resource group. unique globally. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 78

def list_by_endpoint_async(resource_group_name, profile_name, endpoint_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointName' => endpoint_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomainListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#list_by_endpoint_next(next_page_link, custom_headers = nil) ⇒ CustomDomainListResult

Lists the existing CDN custom domains within an endpoint.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:



622
623
624
625
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 622

def list_by_endpoint_next(next_page_link, custom_headers = nil)
  response = list_by_endpoint_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_by_endpoint_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Lists the existing CDN custom domains within an endpoint.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 651

def list_by_endpoint_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CustomDomainListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#list_by_endpoint_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the existing CDN custom domains within an endpoint.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



637
638
639
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 637

def list_by_endpoint_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_endpoint_next_async(next_page_link, custom_headers).value!
end

#list_by_endpoint_with_http_info(resource_group_name, profile_name, endpoint_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the existing CDN custom domains within an endpoint.

Azure subscription. the resource group. unique globally. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • profile_name (String) —

    Name of the CDN profile which is unique within

  • endpoint_name (String) —

    Name of the endpoint under the profile which is

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/generated/azure_mgmt_cdn/custom_domains.rb', line 60

def list_by_endpoint_with_http_info(resource_group_name, profile_name, endpoint_name, custom_headers = nil)
  list_by_endpoint_async(resource_group_name, profile_name, endpoint_name, custom_headers).value!
end