Class: Azure::PolicyInsights::Mgmt::V2019_10_01::PolicyMetadataOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb

Overview

PolicyMetadataOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PolicyMetadataOperations

Creates and initializes a new instance of the PolicyMetadataOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ PolicyInsightsClient (readonly)

Returns reference to the PolicyInsightsClient.

Returns:



22
23
24
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 22

def client
  @client
end

Instance Method Details

#get_resource(resource_name, custom_headers: nil) ⇒ PolicyMetadata

Get policy metadata resource.

will be added to the HTTP request.

Parameters:

  • resource_name (String) —

    The name of the policy metadata resource.

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

    A hash of custom headers that

Returns:

  • (PolicyMetadata) —

    operation results.



33
34
35
36
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 33

def get_resource(resource_name, custom_headers:nil)
  response = get_resource_async(resource_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_resource_async(resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Get policy metadata resource.

to the HTTP request.

Parameters:

  • resource_name (String) —

    The name of the policy metadata resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 60

def get_resource_async(resource_name, custom_headers:nil)
  fail ArgumentError, 'resource_name is nil' if resource_name.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 = 'providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'resourceName' => resource_name},
      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::PolicyInsights::Mgmt::V2019_10_01::Models::PolicyMetadata.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_resource_with_http_info(resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get policy metadata resource.

will be added to the HTTP request.

Parameters:

  • resource_name (String) —

    The name of the policy metadata resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



47
48
49
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 47

def get_resource_with_http_info(resource_name, custom_headers:nil)
  get_resource_async(resource_name, custom_headers:custom_headers).value!
end

#list(query_options: nil, custom_headers: nil) ⇒ Array<SlimPolicyMetadata>

Get a list of the policy metadata resources.

will be added to the HTTP request.

Parameters:

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (Array<SlimPolicyMetadata>) —

    operation results.



122
123
124
125
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 122

def list(query_options:nil, custom_headers:nil)
  first_page = list_as_lazy(query_options:query_options, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(query_options: nil, custom_headers: nil) ⇒ PolicyMetadataCollection

Get a list of the policy metadata resources.

will be added to the HTTP request.

response.

Parameters:

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (PolicyMetadataCollection) —

    which provide lazy access to pages of the



304
305
306
307
308
309
310
311
312
313
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 304

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

Get a list of the policy metadata resources.

to the HTTP request.

Parameters:

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
196
197
198
199
200
201
202
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 149

def list_async(query_options:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?

  top = nil
  unless query_options.nil?
    top = query_options.Top
  end

  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 = 'providers/Microsoft.PolicyInsights/policyMetadata'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version,'$top' => top},
      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::PolicyInsights::Mgmt::V2019_10_01::Models::PolicyMetadataCollection.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) ⇒ PolicyMetadataCollection

Get a list of the policy metadata resources.

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:

  • (PolicyMetadataCollection) —

    operation results.



214
215
216
217
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 214

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

Get a list of the policy metadata resources.

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.



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
289
290
291
292
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 243

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::PolicyInsights::Mgmt::V2019_10_01::Models::PolicyMetadataCollection.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

Get a list of the policy metadata resources.

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.



229
230
231
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 229

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(query_options: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a list of the policy metadata resources.

will be added to the HTTP request.

Parameters:

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



136
137
138
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/policy_metadata_operations.rb', line 136

def list_with_http_info(query_options:nil, custom_headers:nil)
  list_async(query_options:query_options, custom_headers:custom_headers).value!
end