Class: Azure::Security::Mgmt::V2017_08_01_preview::InformationProtectionPolicies

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb

Overview

API spec for Microsoft.Security (Azure Security Center) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ InformationProtectionPolicies

Creates and initializes a new instance of the InformationProtectionPolicies class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityCenter (readonly)

Returns reference to the SecurityCenter.

Returns:



22
23
24
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(scope, information_protection_policy_name, custom_headers: nil) ⇒ InformationProtectionPolicy

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    A hash of custom headers that

Returns:

  • (InformationProtectionPolicy) —

    operation results.



139
140
141
142
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 139

def create_or_update(scope, information_protection_policy_name, custom_headers:nil)
  response = create_or_update_async(scope, information_protection_policy_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(scope, information_protection_policy_name, custom_headers: nil) ⇒ Concurrent::Promise

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 174

def create_or_update_async(scope, information_protection_policy_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'information_protection_policy_name is nil' if information_protection_policy_name.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.Security/informationProtectionPolicies/{informationProtectionPolicyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'scope' => scope,'informationProtectionPolicyName' => information_protection_policy_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.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::Security::Mgmt::V2017_08_01_preview::Models::InformationProtectionPolicy.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Security::Mgmt::V2017_08_01_preview::Models::InformationProtectionPolicy.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

#create_or_update_with_http_info(scope, information_protection_policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



157
158
159
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 157

def create_or_update_with_http_info(scope, information_protection_policy_name, custom_headers:nil)
  create_or_update_async(scope, information_protection_policy_name, custom_headers:custom_headers).value!
end

#get(scope, information_protection_policy_name, custom_headers: nil) ⇒ InformationProtectionPolicy

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    A hash of custom headers that

Returns:

  • (InformationProtectionPolicy) —

    operation results.



37
38
39
40
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 37

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

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

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 72

def get_async(scope, information_protection_policy_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'information_protection_policy_name is nil' if information_protection_policy_name.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.Security/informationProtectionPolicies/{informationProtectionPolicyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'scope' => scope,'informationProtectionPolicyName' => information_protection_policy_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 MsRestAzure::AzureOperationError.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::Security::Mgmt::V2017_08_01_preview::Models::InformationProtectionPolicy.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, information_protection_policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Details of the information protection policy.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). protection policy. Possible values include: ‘effective’, ‘custom’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

  • information_protection_policy_name (Enum) —

    Name of the information

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 55

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

#list(scope, custom_headers: nil) ⇒ Array<InformationProtectionPolicy>

Information protection policies of a specific management group.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

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

    A hash of custom headers that

Returns:

  • (Array<InformationProtectionPolicy>) —

    operation results.



249
250
251
252
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 249

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

#list_as_lazy(scope, custom_headers: nil) ⇒ InformationProtectionPolicyList

Information protection policies of a specific management group.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). will be added to the HTTP request.

of the response.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

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

    A hash of custom headers that

Returns:

  • (InformationProtectionPolicyList) —

    which provide lazy access to pages



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 435

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

Information protection policies of a specific management group.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 280

def list_async(scope, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.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.Security/informationProtectionPolicies'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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 MsRestAzure::AzureOperationError.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::Security::Mgmt::V2017_08_01_preview::Models::InformationProtectionPolicyList.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) ⇒ InformationProtectionPolicyList

Information protection policies of a specific management group.

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:

  • (InformationProtectionPolicyList) —

    operation results.



343
344
345
346
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 343

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

Information protection policies of a specific management group.

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.



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 372

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 MsRestAzure::AzureOperationError.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::Security::Mgmt::V2017_08_01_preview::Models::InformationProtectionPolicyList.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

Information protection policies of a specific management group.

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.



358
359
360
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 358

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

Information protection policies of a specific management group.

(/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName). will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query, can be subscription

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



265
266
267
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/information_protection_policies.rb', line 265

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