Class: Azure::ARM::Web::UsageOperations

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/usage_operations.rb

Overview

Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see <a href=“msdn.microsoft.com/en-us/library/azure/dn790557.aspx”>Authenticating Azure Resource Manager requests.</a>

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ UsageOperations

Creates and initializes a new instance of the UsageOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



25
26
27
 
# File 'lib/generated/azure_mgmt_web/usage_operations.rb', line 25

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the WebSiteManagementClient.

Returns:

  • reference to the WebSiteManagementClient



30
31
32
 
# File 'lib/generated/azure_mgmt_web/usage_operations.rb', line 30

def client
  @client
end

Instance Method Details

#get_usage(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil) ⇒ Object

Returns usage records for specified subscription and resource groups

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • environment_name (String) —

    Environment name

  • last_id (String) —

    Last marker that was returned from the batch

  • batch_size (Integer) —

    size of the batch to be returned.

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



44
45
46
47
 
# File 'lib/generated/azure_mgmt_web/usage_operations.rb', line 44

def get_usage(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil)
  response = get_usage_async(resource_group_name, environment_name, last_id, batch_size, custom_headers).value!
  response.body unless response.nil?
end

#get_usage_async(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil) ⇒ Concurrent::Promise

Returns usage records for specified subscription and resource groups

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • environment_name (String) —

    Environment name

  • last_id (String) —

    Last marker that was returned from the batch

  • batch_size (Integer) —

    size of the batch to be returned.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/generated/azure_mgmt_web/usage_operations.rb', line 77

def get_usage_async(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'environment_name is nil' if environment_name.nil?
  fail ArgumentError, 'last_id is nil' if last_id.nil?
  fail ArgumentError, 'batch_size is nil' if batch_size.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'environmentName' => environment_name,'subscriptionId' => @client.subscription_id},
      query_params: {'lastId' => last_id,'batchSize' => batch_size,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#get_usage_with_http_info(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Returns usage records for specified subscription and resource groups

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • environment_name (String) —

    Environment name

  • last_id (String) —

    Last marker that was returned from the batch

  • batch_size (Integer) —

    size of the batch to be returned.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/generated/azure_mgmt_web/usage_operations.rb', line 61

def get_usage_with_http_info(resource_group_name, environment_name, last_id, batch_size, custom_headers = nil)
  get_usage_async(resource_group_name, environment_name, last_id, batch_size, custom_headers).value!
end