azure_mgmt_consumption 0.17.2 → 0.18.0

data/lib/2019-06-01/generated/azure_mgmt_consumption/marketplaces.rb

@@ -0,0 +1,339 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Consumption::Mgmt::V2019_06_01
+  #
+  # Consumption management client provides access to consumption resources for
+  # Azure Enterprise Subscriptions.
+  #
+  class Marketplaces
+    include MsRestAzure
+
+    #
+    # Creates and initializes a new instance of the Marketplaces class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [ConsumptionManagementClient] reference to the ConsumptionManagementClient
+    attr_reader :client
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param scope [String] The scope associated with marketplace operations. This
+    # 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}'
+    # @param filter [String] May be used to filter marketplaces by
+    # 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'.
+    # @param top [Integer] May be used to limit the number of results to the most
+    # recent N marketplaces.
+    # @param skiptoken [String] Skiptoken is only used if a previous operation
+    # 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.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [Array<Marketplace>] operation results.
+    #
+    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
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param scope [String] The scope associated with marketplace operations. This
+    # 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}'
+    # @param filter [String] May be used to filter marketplaces by
+    # 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'.
+    # @param top [Integer] May be used to limit the number of results to the most
+    # recent N marketplaces.
+    # @param skiptoken [String] Skiptoken is only used if a previous operation
+    # 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.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    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
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param scope [String] The scope associated with marketplace operations. This
+    # 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}'
+    # @param filter [String] May be used to filter marketplaces by
+    # 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'.
+    # @param top [Integer] May be used to limit the number of results to the most
+    # recent N marketplaces.
+    # @param skiptoken [String] Skiptoken is only used if a previous operation
+    # 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.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    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_06_01::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
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param next_page_link [String] The NextLink from the previous successful call
+    # to List operation.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MarketplacesListResult] operation results.
+    #
+    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
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param next_page_link [String] The NextLink from the previous successful call
+    # to List operation.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    def list_next_with_http_info(next_page_link, custom_headers:nil)
+      list_next_async(next_page_link, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param next_page_link [String] The NextLink from the previous successful call
+    # to List operation.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    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_06_01::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
+
+    #
+    # Lists the marketplaces for a scope at the defined scope. Marketplaces are
+    # available via this API only for May 1, 2014 or later.
+    #
+    # @param scope [String] The scope associated with marketplace operations. This
+    # 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}'
+    # @param filter [String] May be used to filter marketplaces by
+    # 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'.
+    # @param top [Integer] May be used to limit the number of results to the most
+    # recent N marketplaces.
+    # @param skiptoken [String] Skiptoken is only used if a previous operation
+    # 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.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MarketplacesListResult] which provide lazy access to pages of the
+    # response.
+    #
+    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
+
+  end
+end

data/lib/2019-06-01/generated/azure_mgmt_consumption/models/balance.rb

@@ -0,0 +1,281 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Consumption::Mgmt::V2019_06_01
+  module Models
+    #
+    # A balance resource.
+    #
+    class Balance < Resource
+
+      include MsRestAzure
+
+      # @return [String] The ISO currency in which the meter is charged, for
+      # example, USD.
+      attr_accessor :currency
+
+      # @return The beginning balance for the billing period.
+      attr_accessor :beginning_balance
+
+      # @return The ending balance for the billing period (for open periods
+      # this will be updated daily).
+      attr_accessor :ending_balance
+
+      # @return Total new purchase amount.
+      attr_accessor :new_purchases
+
+      # @return Total adjustment amount.
+      attr_accessor :adjustments
+
+      # @return Total Commitment usage.
+      attr_accessor :utilized
+
+      # @return Overage for Azure services.
+      attr_accessor :service_overage
+
+      # @return Charges Billed separately.
+      attr_accessor :charges_billed_separately
+
+      # @return serviceOverage + chargesBilledSeparately.
+      attr_accessor :total_overage
+
+      # @return Azure service commitment + total Overage.
+      attr_accessor :total_usage
+
+      # @return Total charges for Azure Marketplace.
+      attr_accessor :azure_marketplace_service_charges
+
+      # @return [BillingFrequency] The billing frequency. Possible values
+      # include: 'Month', 'Quarter', 'Year'
+      attr_accessor :billing_frequency
+
+      # @return [Boolean] Price is hidden or not.
+      attr_accessor :price_hidden
+
+      # @return [Array<BalancePropertiesNewPurchasesDetailsItem>] List of new
+      # purchases.
+      attr_accessor :new_purchases_details
+
+      # @return [Array<BalancePropertiesAdjustmentDetailsItem>] List of
+      # Adjustments (Promo credit, SIE credit etc.).
+      attr_accessor :adjustment_details
+
+
+      #
+      # Mapper for Balance class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Balance',
+          type: {
+            name: 'Composite',
+            class_name: 'Balance',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              type: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'String'
+                }
+              },
+              tags: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'tags',
+                type: {
+                  name: 'Dictionary',
+                  value: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              currency: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.currency',
+                type: {
+                  name: 'String'
+                }
+              },
+              beginning_balance: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.beginningBalance',
+                type: {
+                  name: 'Number'
+                }
+              },
+              ending_balance: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.endingBalance',
+                type: {
+                  name: 'Number'
+                }
+              },
+              new_purchases: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.newPurchases',
+                type: {
+                  name: 'Number'
+                }
+              },
+              adjustments: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.adjustments',
+                type: {
+                  name: 'Number'
+                }
+              },
+              utilized: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.utilized',
+                type: {
+                  name: 'Number'
+                }
+              },
+              service_overage: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.serviceOverage',
+                type: {
+                  name: 'Number'
+                }
+              },
+              charges_billed_separately: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.chargesBilledSeparately',
+                type: {
+                  name: 'Number'
+                }
+              },
+              total_overage: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.totalOverage',
+                type: {
+                  name: 'Number'
+                }
+              },
+              total_usage: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.totalUsage',
+                type: {
+                  name: 'Number'
+                }
+              },
+              azure_marketplace_service_charges: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.azureMarketplaceServiceCharges',
+                type: {
+                  name: 'Number'
+                }
+              },
+              billing_frequency: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'properties.billingFrequency',
+                type: {
+                  name: 'String'
+                }
+              },
+              price_hidden: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.priceHidden',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              new_purchases_details: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.newPurchasesDetails',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'BalancePropertiesNewPurchasesDetailsItemElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'BalancePropertiesNewPurchasesDetailsItem'
+                      }
+                  }
+                }
+              },
+              adjustment_details: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'properties.adjustmentDetails',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'BalancePropertiesAdjustmentDetailsItemElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'BalancePropertiesAdjustmentDetailsItem'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end