Class: Azure::Consumption::Mgmt::V2019_04_01_preview::Marketplaces

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb

Overview

Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Marketplaces

Creates and initializes a new instance of the Marketplaces class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-04-01-preview/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.

Returns:



23
24
25
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 23

def client
  @client
end

Instance Method Details

#list(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using ‘/providers/Microsoft.Billing/billingPeriods/billingPeriodName’. For e.g. to specify billing period at department scope use ‘/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ 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.

Parameters:

  • scope (String) —

    The scope associated with marketplace operations. This

  • filter (String) (defaults to: nil) —

    May be used to filter marketplaces by

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (Array<Marketplace>) —

    operation results.



61
62
63
64
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 61

def list(scope, filter:nil, top:nil, skiptoken:nil, custom_headers:nil)
  first_page = list_as_lazy(scope, filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using ‘/providers/Microsoft.Billing/billingPeriods/billingPeriodName’. For e.g. to specify billing period at department scope use ‘/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ 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.

Parameters:

  • scope (String) —

    The scope associated with marketplace operations. This

  • filter (String) (defaults to: nil) —

    May be used to filter marketplaces by

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (MarketplacesListResult) —

    which provide lazy access to pages of the



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 327

def list_as_lazy(scope, filter:nil, top:nil, skiptoken:nil, custom_headers:nil)
  response = list_async(scope, 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(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using ‘/providers/Microsoft.Billing/billingPeriods/billingPeriodName’. For e.g. to specify billing period at department scope use ‘/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ 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.

Parameters:

  • scope (String) —

    The scope associated with marketplace operations. This

  • filter (String) (defaults to: nil) —

    May be used to filter marketplaces by

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



142
143
144
145
146
147
148
149
150
151
152
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
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 142

def list_async(scope, 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, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Consumption/marketplaces'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      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, 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?
    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::V2019_04_01_preview::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.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

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:

  • (MarketplacesListResult) —

    operation results.



208
209
210
211
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 208

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 at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

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.



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
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 239

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

  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?
    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::V2019_04_01_preview::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.message, 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 at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

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.



224
225
226
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 224

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(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using ‘/providers/Microsoft.Billing/billingPeriods/billingPeriodName’. For e.g. to specify billing period at department scope use ‘/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ 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.

Parameters:

  • scope (String) —

    The scope associated with marketplace operations. This

  • filter (String) (defaults to: nil) —

    May be used to filter marketplaces by

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



102
103
104
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/marketplaces.rb', line 102

def list_with_http_info(scope, filter:nil, top:nil, skiptoken:nil, custom_headers:nil)
  list_async(scope, filter:filter, top:top, skiptoken:skiptoken, custom_headers:custom_headers).value!
end