Class: Azure::Consumption::Mgmt::V2018_01_31::Marketplaces
- Inherits:
-
Object
- Object
- Azure::Consumption::Mgmt::V2018_01_31::Marketplaces
- Includes:
- MsRestAzure
- Defined in:
- lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb
Overview
Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
Instance Attribute Summary collapse
-
#client ⇒ ConsumptionManagementClient
readonly
Reference to the ConsumptionManagementClient.
Instance Method Summary collapse
-
#initialize(client) ⇒ Marketplaces
constructor
Creates and initializes a new instance of the Marketplaces class.
-
#list(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>
Lists the marketplaces for a scope by subscriptionId.
-
#list_as_lazy(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by subscriptionId.
-
#list_async(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by subscriptionId.
-
#list_by_billing_period(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_as_lazy(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_async(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_by_billing_period_with_http_info(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by billing period and subscripotionId.
-
#list_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by subscriptionId.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by subscriptionId.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by subscriptionId.
-
#list_with_http_info(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by subscriptionId.
Constructor Details
#initialize(client) ⇒ Marketplaces
Creates and initializes a new instance of the Marketplaces class.
18 19 20 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 18 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ConsumptionManagementClient (readonly)
Returns reference to the ConsumptionManagementClient.
23 24 25 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 23 def client @client end |
Instance Method Details
#list(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
45 46 47 48 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 45 def list(filter:nil, top:nil, skiptoken:nil, custom_headers:nil) first_page = list_as_lazy(filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers) first_page.get_all_items end |
#list_as_lazy(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
response.
484 485 486 487 488 489 490 491 492 493 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 484 def list_as_lazy(filter:nil, top:nil, skiptoken:nil, custom_headers:nil) response = list_async(filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_async(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. to the HTTP request.
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 94 def list_async(filter:nil, top:nil, skiptoken:nil, custom_headers:nil) fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000 fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Consumption/marketplaces' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id}, query_params: {'$filter' => filter,'$top' => top,'$skiptoken' => skiptoken,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.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 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::Consumption::Mgmt::V2018_01_31::Models::MarketplacesListResult.mapper() result.body = @client.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_by_billing_period(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
170 171 172 173 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 170 def list_by_billing_period(billing_period_name, filter:nil, top:nil, skiptoken:nil, custom_headers:nil) first_page = list_by_billing_period_as_lazy(billing_period_name, filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_billing_period_as_lazy(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
response.
517 518 519 520 521 522 523 524 525 526 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 517 def list_by_billing_period_as_lazy(billing_period_name, filter:nil, top:nil, skiptoken:nil, custom_headers:nil) response = list_by_billing_period_async(billing_period_name, filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_billing_period_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_by_billing_period_async(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. to the HTTP request.
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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 221 def list_by_billing_period_async(billing_period_name, filter:nil, top:nil, skiptoken:nil, custom_headers:nil) fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000 fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'billing_period_name is nil' if billing_period_name.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'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'billingPeriodName' => billing_period_name}, query_params: {'$filter' => filter,'$top' => top,'$skiptoken' => skiptoken,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.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 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::Consumption::Mgmt::V2018_01_31::Models::MarketplacesListResult.mapper() result.body = @client.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_by_billing_period_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
381 382 383 384 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 381 def list_by_billing_period_next(next_page_link, custom_headers:nil) response = list_by_billing_period_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_billing_period_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. to the HTTP request.
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 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 412 def list_by_billing_period_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'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.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 = @client.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 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::Consumption::Mgmt::V2018_01_31::Models::MarketplacesListResult.mapper() result.body = @client.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_by_billing_period_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
397 398 399 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 397 def list_by_billing_period_next_with_http_info(next_page_link, custom_headers:nil) list_by_billing_period_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_by_billing_period_with_http_info(billing_period_name, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
196 197 198 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 196 def list_by_billing_period_with_http_info(billing_period_name, filter:nil, top:nil, skiptoken:nil, custom_headers:nil) list_by_billing_period_async(billing_period_name, filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers).value! end |
#list_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
288 289 290 291 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 288 def list_next(next_page_link, custom_headers:nil) response = list_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. to the HTTP request.
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 360 361 362 363 364 365 366 367 368 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 319 def list_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'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.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 = @client.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 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::Consumption::Mgmt::V2018_01_31::Models::MarketplacesListResult.mapper() result.body = @client.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
304 305 306 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 304 def list_next_with_http_info(next_page_link, custom_headers:nil) list_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_with_http_info(filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. recent N marketplaces. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.
70 71 72 |
# File 'lib/2018-01-31/generated/azure_mgmt_consumption/marketplaces.rb', line 70 def list_with_http_info(filter:nil, top:nil, skiptoken:nil, custom_headers:nil) list_async(filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers).value! end |