Class: Azure::Consumption::Mgmt::V2019_06_01::Tags

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_consumption/tags.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) ⇒ Tags

Creates and initializes a new instance of the Tags class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/tags.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-06-01/generated/azure_mgmt_consumption/tags.rb', line 23

def client
  @client
end

Instance Method Details

#get(scope, custom_headers: nil) ⇒ TagsResult

Get all available tag keys for the defined scope

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/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope.. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with tags operations. This

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

    A hash of custom headers that

Returns:

  • (TagsResult) —

    operation results.



45
46
47
48
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/tags.rb', line 45

def get(scope, custom_headers:nil)
  response = get_async(scope, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(scope, custom_headers: nil) ⇒ Concurrent::Promise

Get all available tag keys for the defined scope

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/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope.. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with tags operations. This

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/tags.rb', line 94

def get_async(scope, custom_headers:nil)
  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/tags'

  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: {'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::TagsResult.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

#get_with_http_info(scope, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all available tag keys for the defined scope

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/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope and ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope.. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with tags operations. This

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



70
71
72
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/tags.rb', line 70

def get_with_http_info(scope, custom_headers:nil)
  get_async(scope, custom_headers:custom_headers).value!
end