Class: Azure::CDN::Mgmt::V2020_04_15::CdnManagementClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::CDN::Mgmt::V2020_04_15::CdnManagementClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb
Overview
A service client - single point of access to the REST API.
Instance Attribute Summary collapse
-
#accept_language ⇒ String
The preferred language for the response.
-
#api_version ⇒ String
readonly
Current version is 2017-04-02.
-
#base_url ⇒ String
The base URI of the service.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#custom_domains ⇒ CustomDomains
readonly
Custom_domains.
-
#edge_nodes ⇒ EdgeNodes
readonly
Edge_nodes.
-
#endpoints ⇒ Endpoints
readonly
Endpoints.
-
#generate_client_request_id ⇒ Boolean
generated.
-
#long_running_operation_retry_timeout ⇒ Integer
Operations.
-
#managed_rule_sets ⇒ ManagedRuleSets
readonly
Managed_rule_sets.
-
#operations ⇒ Operations
readonly
Operations.
-
#origin_groups ⇒ OriginGroups
readonly
Origin_groups.
-
#origins ⇒ Origins
readonly
Origins.
-
#policies ⇒ Policies
readonly
Policies.
-
#profiles ⇒ Profiles
readonly
Profiles.
-
#resource_usage_operations ⇒ ResourceUsageOperations
readonly
Resource_usage_operations.
-
#subscription_id ⇒ String
Azure Subscription ID.
Instance Method Summary collapse
-
#check_name_availability(check_name_availability_input, custom_headers: nil) ⇒ CheckNameAvailabilityOutput
Check the availability of a resource name.
-
#check_name_availability_async(check_name_availability_input, custom_headers: nil) ⇒ Concurrent::Promise
Check the availability of a resource name.
-
#check_name_availability_with_http_info(check_name_availability_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Check the availability of a resource name.
-
#check_name_availability_with_subscription(check_name_availability_input, custom_headers: nil) ⇒ CheckNameAvailabilityOutput
Check the availability of a resource name.
-
#check_name_availability_with_subscription_async(check_name_availability_input, custom_headers: nil) ⇒ Concurrent::Promise
Check the availability of a resource name.
-
#check_name_availability_with_subscription_with_http_info(check_name_availability_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Check the availability of a resource name.
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CdnManagementClient
constructor
Creates initializes a new instance of the CdnManagementClient class.
-
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response.
-
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
-
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
-
#validate_probe(validate_probe_input, custom_headers: nil) ⇒ ValidateProbeOutput
Check if the probe path is a valid path and the file can be accessed.
-
#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.
-
#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.
Constructor Details
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CdnManagementClient
Creates initializes a new instance of the CdnManagementClient class.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 75 def initialize(credentials = nil, base_url = nil, = nil) super(credentials, ) @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) @policies = Policies.new(self) @managed_rule_sets = ManagedRuleSets.new(self) @api_version = '2020-04-15' @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.
28 29 30 |
# File 'lib/2020-04-15/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.
25 26 27 |
# File 'lib/2020-04-15/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.
15 16 17 |
# File 'lib/2020-04-15/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.
18 19 20 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 18 def credentials @credentials end |
#custom_domains ⇒ CustomDomains (readonly)
Returns custom_domains.
52 53 54 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 52 def custom_domains @custom_domains end |
#edge_nodes ⇒ EdgeNodes (readonly)
Returns edge_nodes.
61 62 63 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 61 def edge_nodes @edge_nodes end |
#endpoints ⇒ Endpoints (readonly)
Returns endpoints.
43 44 45 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 43 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.
37 38 39 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 37 def generate_client_request_id @generate_client_request_id end |
#long_running_operation_retry_timeout ⇒ Integer
Operations. Default value is 30.
32 33 34 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 32 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#managed_rule_sets ⇒ ManagedRuleSets (readonly)
Returns managed_rule_sets.
67 68 69 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 67 def managed_rule_sets @managed_rule_sets end |
#operations ⇒ Operations (readonly)
Returns operations.
58 59 60 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 58 def operations @operations end |
#origin_groups ⇒ OriginGroups (readonly)
Returns origin_groups.
49 50 51 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 49 def origin_groups @origin_groups end |
#origins ⇒ Origins (readonly)
Returns origins.
46 47 48 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 46 def origins @origins end |
#policies ⇒ Policies (readonly)
Returns policies.
64 65 66 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 64 def policies @policies end |
#profiles ⇒ Profiles (readonly)
Returns profiles.
40 41 42 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 40 def profiles @profiles end |
#resource_usage_operations ⇒ ResourceUsageOperations (readonly)
Returns resource_usage_operations.
55 56 57 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 55 def resource_usage_operations @resource_usage_operations end |
#subscription_id ⇒ String
Returns Azure Subscription ID.
21 22 23 |
# File 'lib/2020-04-15/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.
168 169 170 171 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 168 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.
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 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 199 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_04_15::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 = { 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, ) 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_04_15::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., 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.
184 185 186 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 184 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.
269 270 271 272 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 269 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.
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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 300 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_04_15::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 = { 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, ) 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_04_15::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., 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.
285 286 287 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 285 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"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
115 116 117 118 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 115 def make_request(method, path, = {}) result = make_request_with_http_info(method, path, ) result.body unless result.nil? end |
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 140 def make_request_async(method, path, = {}) fail ArgumentError, 'method is nil' if method.nil? fail ArgumentError, 'path is nil' if path.nil? request_url = [:base_url] || @base_url if(![:headers].nil? && ![:headers]['Content-Type'].nil?) @request_headers['Content-Type'] = [:headers]['Content-Type'] end request_headers = @request_headers request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil? .merge!({headers: request_headers.merge([:headers] || {})}) .merge!({credentials: @credentials}) unless @credentials.nil? super(request_url, method, path, ) end |
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
127 128 129 130 131 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 127 def make_request_with_http_info(method, path, = {}) result = make_request_async(method, path, ).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.
373 374 375 376 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 373 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.
406 407 408 409 410 411 412 413 414 415 416 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 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 406 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_04_15::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 = { 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, ) 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_04_15::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., 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.
390 391 392 |
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/cdn_management_client.rb', line 390 def validate_probe_with_http_info(validate_probe_input, custom_headers:nil) validate_probe_async(validate_probe_input, custom_headers:custom_headers).value! end |