Class: Azure::Features::Mgmt::V2015_12_01::FeatureClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::Features::Mgmt::V2015_12_01::FeatureClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2015-12-01/generated/azure_mgmt_features/feature_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
The API version to use for this operation.
-
#base_url ⇒ String
The base URI of the service.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#features ⇒ Features
readonly
Features.
-
#generate_client_request_id ⇒ Boolean
generated.
-
#long_running_operation_retry_timeout ⇒ Integer
Operations.
-
#subscription_id ⇒ String
The ID of the target subscription.
Instance Method Summary collapse
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ FeatureClient
constructor
Creates initializes a new instance of the FeatureClient class.
-
#list_operations(custom_headers: nil) ⇒ Array<Operation>
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_as_lazy(custom_headers: nil) ⇒ OperationListResult
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_as_lazy_async(custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_as_lazy_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_async(custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_next(next_page_link, custom_headers: nil) ⇒ OperationListResult
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
-
#list_operations_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
-
#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.
Constructor Details
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ FeatureClient
Creates initializes a new instance of the FeatureClient class.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 47 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 @features = Features.new(self) @api_version = '2015-12-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.
27 28 29 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 27 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns The API version to use for this operation.
24 25 26 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 24 def api_version @api_version end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_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/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 18 def credentials @credentials end |
#features ⇒ Features (readonly)
Returns features.
39 40 41 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 39 def features @features 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.
36 37 38 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 36 def generate_client_request_id @generate_client_request_id end |
#long_running_operation_retry_timeout ⇒ Integer
Operations. Default value is 30.
31 32 33 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 31 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#subscription_id ⇒ String
Returns The ID of the target subscription.
21 22 23 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 21 def subscription_id @subscription_id end |
Instance Method Details
#list_operations(custom_headers: nil) ⇒ Array<Operation>
Lists all of the available Microsoft.Features REST API operations.
will be added to the HTTP request.
128 129 130 131 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 128 def list_operations(custom_headers:nil) first_page = list_operations_as_lazy(custom_headers:custom_headers) first_page.get_all_items end |
#list_operations_as_lazy(custom_headers: nil) ⇒ OperationListResult
Lists all of the available Microsoft.Features REST API operations.
will be added to the HTTP request.
302 303 304 305 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 302 def list_operations_as_lazy(custom_headers:nil) first_page = list_operations_as_lazy_async(custom_headers:custom_headers) first_page.get_all_items end |
#list_operations_as_lazy_async(custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
to the HTTP request.
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 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 327 def list_operations_as_lazy_async(custom_headers:nil) request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' path_template = 'providers/Microsoft.Features/operations' request_url = @base_url || self.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:get, 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 MsRestAzure::AzureOperationError.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::Features::Mgmt::V2015_12_01::Models::OperationListResult.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 |
#list_operations_as_lazy_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
will be added to the HTTP request.
315 316 317 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 315 def list_operations_as_lazy_with_http_info(custom_headers:nil) list_operations_as_lazy_async(custom_headers:custom_headers).value! end |
#list_operations_async(custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
to the HTTP request.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 153 def list_operations_async(custom_headers: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? path_template = 'providers/Microsoft.Features/operations' request_url = @base_url || self.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], query_params: {'api-version' => api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:get, 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 MsRestAzure::AzureOperationError.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::Features::Mgmt::V2015_12_01::Models::OperationListResult.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 |
#list_operations_next(next_page_link, custom_headers: nil) ⇒ OperationListResult
Lists all of the available Microsoft.Features REST API operations.
to List operation. will be added to the HTTP request.
214 215 216 217 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 214 def list_operations_next(next_page_link, custom_headers:nil) response = list_operations_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_operations_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists all of the available Microsoft.Features REST API operations.
to List operation. to the HTTP request.
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 243 def list_operations_next_async(next_page_link, custom_headers:nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.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? path_template = '{nextLink}' request_url = @base_url || self.base_url = { 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 = self.make_request_async(:get, 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 MsRestAzure::AzureOperationError.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::Features::Mgmt::V2015_12_01::Models::OperationListResult.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 |
#list_operations_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
to List operation. will be added to the HTTP request.
229 230 231 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 229 def list_operations_next_with_http_info(next_page_link, custom_headers:nil) list_operations_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_operations_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all of the available Microsoft.Features REST API operations.
will be added to the HTTP request.
141 142 143 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 141 def list_operations_with_http_info(custom_headers:nil) list_operations_async(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, )
78 79 80 81 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 78 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.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 103 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.
90 91 92 93 94 |
# File 'lib/2015-12-01/generated/azure_mgmt_features/feature_client.rb', line 90 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 |