Class: Azure::Consumption::Mgmt::V2019_10_01::Marketplaces
- Inherits:
-
Object
- Object
- Azure::Consumption::Mgmt::V2019_10_01::Marketplaces
- Includes:
- MsRestAzure
- Defined in:
- lib/2019-10-01/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(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Array<Marketplace>
Lists the marketplaces for a scope at the defined scope.
-
#list_as_lazy(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope at the defined scope.
-
#list_async(scope, filter: nil, top: nil, skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope at the defined scope.
-
#list_next(next_page_link, custom_headers: nil) ⇒ MarketplacesListResult
Lists the marketplaces for a scope at the defined scope.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the marketplaces for a scope at the defined scope.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the marketplaces for a scope at the defined scope.
-
#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.
Constructor Details
#initialize(client) ⇒ Marketplaces
Creates and initializes a new instance of the Marketplaces class.
18 19 20 |
# File 'lib/2019-10-01/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/2019-10-01/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, ‘/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.
59 60 61 62 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 59 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, ‘/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.
319 320 321 322 323 324 325 326 327 328 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 319 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, ‘/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.
136 137 138 139 140 141 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 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 136 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 = { 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, ) 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_10_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., 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.
202 203 204 205 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 202 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.
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 276 277 278 279 280 281 282 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 233 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::V2019_10_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., 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.
218 219 220 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 218 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, ‘/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.
98 99 100 |
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/marketplaces.rb', line 98 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 |