Class: Azure::CDN::Mgmt::V2017_04_02::CdnManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-04-02/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.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 65

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)
  @custom_domains = CustomDomains.new(self)
  @resource_usage_operations = ResourceUsageOperations.new(self)
  @operations = Operations.new(self)
  @edge_nodes = EdgeNodes.new(self)
  @api_version = '2017-04-02'
  @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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



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

def accept_language
  @accept_language
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/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 25

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2017-04-02/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/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 18

def credentials
  @credentials
end

#custom_domains ⇒ CustomDomains (readonly)

Returns custom_domains.

Returns:



48
49
50
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 48

def custom_domains
  @custom_domains
end

#edge_nodes ⇒ EdgeNodes (readonly)

Returns edge_nodes.

Returns:



57
58
59
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 57

def edge_nodes
  @edge_nodes
end

#endpoints ⇒ Endpoints (readonly)

Returns endpoints.

Returns:



42
43
44
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 42

def endpoints
  @endpoints
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



36
37
38
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



32
33
34
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



54
55
56
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 54

def operations
  @operations
end

#origins ⇒ Origins (readonly)

Returns origins.

Returns:



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

def origins
  @origins
end

#profiles ⇒ Profiles (readonly)

Returns profiles.

Returns:



39
40
41
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 39

def profiles
  @profiles
end

#resource_usage_operations ⇒ ResourceUsageOperations (readonly)

Returns resource_usage_operations.

Returns:



51
52
53
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 51

def resource_usage_operations
  @resource_usage_operations
end

#subscription_id ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



21
22
23
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 21

def subscription_id
  @subscription_id
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.



152
153
154
155
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 152

def check_name_availability(check_name_availability_input, custom_headers = nil)
  response = check_name_availability_async(check_name_availability_input, 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.



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
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 183

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 = {}

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

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

  # Serialize Request
  request_mapper = Azure::CDN::Mgmt::V2017_04_02::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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2017_04_02::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.



168
169
170
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 168

def check_name_availability_with_http_info(check_name_availability_input, custom_headers = nil)
  check_name_availability_async(check_name_availability_input, 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.



102
103
104
105
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 102

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.



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 127

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

  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.



114
115
116
117
118
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 114

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.



253
254
255
256
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 253

def validate_probe(validate_probe_input, custom_headers = nil)
  response = validate_probe_async(validate_probe_input, 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.



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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 286

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 = {}

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

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

  # Serialize Request
  request_mapper = Azure::CDN::Mgmt::V2017_04_02::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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2017_04_02::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.



270
271
272
 
# File 'lib/2017-04-02/generated/azure_mgmt_cdn/cdn_management_client.rb', line 270

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