Class: Azure::ARM::Policy::PolicyAssignments

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

Overview

To manage and control access to your resources, you can define customized policies and assign them at a scope.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PolicyAssignments

Creates and initializes a new instance of the PolicyAssignments class.

Parameters:

  • client —

    service class for accessing basic functionality.



19
20
21
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 19

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ PolicyClient (readonly)

Returns reference to the PolicyClient.

Returns:



24
25
26
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 24

def client
  @client
end

Instance Method Details

#create(scope, policy_assignment_name, parameters, custom_headers = nil) ⇒ PolicyAssignment

Creates a policy assignment.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.

will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment.

  • parameters (PolicyAssignment) —

    Parameters for the policy assignment.

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

    A hash of custom headers that

Returns:



135
136
137
138
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 135

def create(scope, policy_assignment_name, parameters, custom_headers = nil)
  response = create_async(scope, policy_assignment_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_async(scope, policy_assignment_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates a policy assignment.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.

to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment.

  • parameters (PolicyAssignment) —

    Parameters for the policy assignment.

  • 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
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 174

def create_async(scope, policy_assignment_name, parameters, custom_headers = nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'policy_assignment_name is nil' if policy_assignment_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = PolicyAssignment.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/{scope}/providers/Microsoft.Authorization/policyassignments/{policyAssignmentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyAssignmentName' => policy_assignment_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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 == 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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_by_id(policy_assignment_id, parameters, custom_headers = nil) ⇒ PolicyAssignment

Creates a policy assignment by ID.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

create. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

  • parameters (PolicyAssignment) —

    Parameters for policy assignment.

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

    A hash of custom headers that

Returns:



760
761
762
763
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 760

def create_by_id(policy_assignment_id, parameters, custom_headers = nil)
  response = create_by_id_async(policy_assignment_id, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_by_id_async(policy_assignment_id, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates a policy assignment by ID.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

create. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

  • parameters (PolicyAssignment) —

    Parameters for policy assignment.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 811

def create_by_id_async(policy_assignment_id, parameters, custom_headers = nil)
  fail ArgumentError, 'policy_assignment_id is nil' if policy_assignment_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = PolicyAssignment.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/{policyAssignmentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'policyAssignmentId' => policy_assignment_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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 == 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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_by_id_with_http_info(policy_assignment_id, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a policy assignment by ID.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

create. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

  • parameters (PolicyAssignment) —

    Parameters for policy assignment.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



786
787
788
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 786

def create_by_id_with_http_info(policy_assignment_id, parameters, custom_headers = nil)
  create_by_id_async(policy_assignment_id, parameters, custom_headers).value!
end

#create_with_http_info(scope, policy_assignment_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a policy assignment.

Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.

will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment.

  • parameters (PolicyAssignment) —

    Parameters for the policy assignment.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 155

def create_with_http_info(scope, policy_assignment_name, parameters, custom_headers = nil)
  create_async(scope, policy_assignment_name, parameters, custom_headers).value!
end

#delete(scope, policy_assignment_name, custom_headers = nil) ⇒ PolicyAssignment

Deletes a policy assignment.

delete. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    A hash of custom headers that

Returns:



37
38
39
40
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 37

def delete(scope, policy_assignment_name, custom_headers = nil)
  response = delete_async(scope, policy_assignment_name, custom_headers).value!
  response.body unless response.nil?
end

#delete_async(scope, policy_assignment_name, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a policy assignment.

delete. to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
112
113
114
115
116
117
118
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 68

def delete_async(scope, policy_assignment_name, custom_headers = nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'policy_assignment_name is nil' if policy_assignment_name.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 = '/{scope}/providers/Microsoft.Authorization/policyassignments/{policyAssignmentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyAssignmentName' => policy_assignment_name},
      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(:delete, 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#delete_by_id(policy_assignment_id, custom_headers = nil) ⇒ PolicyAssignment

Deletes a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

delete. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

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

    A hash of custom headers that

Returns:



644
645
646
647
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 644

def delete_by_id(policy_assignment_id, custom_headers = nil)
  response = delete_by_id_async(policy_assignment_id, custom_headers).value!
  response.body unless response.nil?
end

#delete_by_id_async(policy_assignment_id, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

delete. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 689

def delete_by_id_async(policy_assignment_id, custom_headers = nil)
  fail ArgumentError, 'policy_assignment_id is nil' if policy_assignment_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 = '/{policyAssignmentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'policyAssignmentId' => policy_assignment_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#delete_by_id_with_http_info(policy_assignment_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

delete. Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



667
668
669
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 667

def delete_by_id_with_http_info(policy_assignment_id, custom_headers = nil)
  delete_by_id_async(policy_assignment_id, custom_headers).value!
end

#delete_with_http_info(scope, policy_assignment_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a policy assignment.

delete. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 53

def delete_with_http_info(scope, policy_assignment_name, custom_headers = nil)
  delete_async(scope, policy_assignment_name, custom_headers).value!
end

#get(scope, policy_assignment_name, custom_headers = nil) ⇒ PolicyAssignment

Gets a policy assignment.

get. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    A hash of custom headers that

Returns:



247
248
249
250
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 247

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

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

Gets a policy assignment.

get. to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



278
279
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
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 278

def get_async(scope, policy_assignment_name, custom_headers = nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'policy_assignment_name is nil' if policy_assignment_name.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 = '/{scope}/providers/Microsoft.Authorization/policyassignments/{policyAssignmentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyAssignmentName' => policy_assignment_name},
      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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_by_id(policy_assignment_id, custom_headers = nil) ⇒ PolicyAssignment

Gets a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to get.

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

    A hash of custom headers that

Returns:



889
890
891
892
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 889

def get_by_id(policy_assignment_id, custom_headers = nil)
  response = get_by_id_async(policy_assignment_id, custom_headers).value!
  response.body unless response.nil?
end

#get_by_id_async(policy_assignment_id, custom_headers = nil) ⇒ Concurrent::Promise

Gets a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to get.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 934

def get_by_id_async(policy_assignment_id, custom_headers = nil)
  fail ArgumentError, 'policy_assignment_id is nil' if policy_assignment_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 = '/{policyAssignmentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'policyAssignmentId' => policy_assignment_id},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignment.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_by_id_with_http_info(policy_assignment_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a policy assignment by ID.

When providing a scope for the assigment, use ‘/subscriptions/subscription-id/’ for subscriptions, ‘/subscriptions/subscription-id/resourceGroups/resource-group-name’ for resource groups, and ‘/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/resource-provider-namespace/resource-type/resource-name’ for resources.

Use the format ‘/scope/providers/Microsoft.Authorization/policyAssignments/policy-assignment-name’. will be added to the HTTP request.

Parameters:

  • policy_assignment_id (String) —

    The ID of the policy assignment to get.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



912
913
914
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 912

def get_by_id_with_http_info(policy_assignment_id, custom_headers = nil)
  get_by_id_async(policy_assignment_id, custom_headers).value!
end

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

Gets a policy assignment.

get. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the policy assignment.

  • policy_assignment_name (String) —

    The name of the policy assignment to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



263
264
265
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 263

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

#list(filter = nil, custom_headers = nil) ⇒ Array<PolicyAssignment>

Gets all the policy assignments for a subscription.

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



549
550
551
552
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 549

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

#list_as_lazy(filter = nil, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets all the policy assignments for a subscription.

will be added to the HTTP request.

the response.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1307

def list_as_lazy(filter = nil, custom_headers = nil)
  response = list_async(filter, 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)
    end
    page
  end
end

#list_async(filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets all the policy assignments for a subscription.

to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 576

def list_async(filter = nil, custom_headers = nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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}/providers/Microsoft.Authorization/policyassignments'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_for_resource(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil) ⇒ Array<PolicyAssignment>

Gets policy assignments for a resource.

the resource. The name is case insensitive. provider. assignments. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • resource_provider_namespace (String) —

    The namespace of the resource

  • parent_resource_path (String) —

    The parent resource path.

  • resource_type (String) —

    The resource type.

  • resource_name (String) —

    The name of the resource with policy

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



441
442
443
444
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 441

def list_for_resource(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil)
  first_page = list_for_resource_as_lazy(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter, custom_headers)
  first_page.get_all_items
end

#list_for_resource_as_lazy(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets policy assignments for a resource.

the resource. The name is case insensitive. provider. assignments. will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • resource_provider_namespace (String) —

    The namespace of the resource

  • parent_resource_path (String) —

    The parent resource path.

  • resource_type (String) —

    The resource type.

  • resource_name (String) —

    The name of the resource with policy

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1286

def list_for_resource_as_lazy(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil)
  response = list_for_resource_async(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_for_resource_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_for_resource_async(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets policy assignments for a resource.

the resource. The name is case insensitive. provider. assignments. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • resource_provider_namespace (String) —

    The namespace of the resource

  • parent_resource_path (String) —

    The parent resource path.

  • resource_type (String) —

    The resource type.

  • resource_name (String) —

    The name of the resource with policy

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 484

def list_for_resource_async(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.nil?
  fail ArgumentError, 'parent_resource_path is nil' if parent_resource_path.nil?
  fail ArgumentError, 'resource_type is nil' if resource_type.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyassignments'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceProviderNamespace' => resource_provider_namespace,'resourceName' => resource_name,'subscriptionId' => @client.subscription_id},
      skip_encoding_path_params: {'parentResourcePath' => parent_resource_path,'resourceType' => resource_type},
      query_params: {'$filter' => filter,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_for_resource_group(resource_group_name, filter = nil, custom_headers = nil) ⇒ Array<PolicyAssignment>

Gets policy assignments for the resource group.

contains policy assignments. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



341
342
343
344
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 341

def list_for_resource_group(resource_group_name, filter = nil, custom_headers = nil)
  first_page = list_for_resource_group_as_lazy(resource_group_name, filter, custom_headers)
  first_page.get_all_items
end

#list_for_resource_group_as_lazy(resource_group_name, filter = nil, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets policy assignments for the resource group.

contains policy assignments. will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1257

def list_for_resource_group_as_lazy(resource_group_name, filter = nil, custom_headers = nil)
  response = list_for_resource_group_async(resource_group_name, filter, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_for_resource_group_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_for_resource_group_async(resource_group_name, filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets policy assignments for the resource group.

contains policy assignments. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

  • 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
422
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 372

def list_for_resource_group_async(resource_group_name, filter = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Authorization/policyAssignments'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      skip_encoding_query_params: {'$filter' => filter},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_for_resource_group_next(next_page_link, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets policy assignments for the resource 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:



994
995
996
997
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 994

def list_for_resource_group_next(next_page_link, custom_headers = nil)
  response = list_for_resource_group_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_for_resource_group_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets policy assignments for the resource 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.



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1023

def list_for_resource_group_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_for_resource_group_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets policy assignments for the resource 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.



1009
1010
1011
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1009

def list_for_resource_group_next_with_http_info(next_page_link, custom_headers = nil)
  list_for_resource_group_next_async(next_page_link, custom_headers).value!
end

#list_for_resource_group_with_http_info(resource_group_name, filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets policy assignments for the resource group.

contains policy assignments. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



357
358
359
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 357

def list_for_resource_group_with_http_info(resource_group_name, filter = nil, custom_headers = nil)
  list_for_resource_group_async(resource_group_name, filter, custom_headers).value!
end

#list_for_resource_next(next_page_link, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets policy assignments for a resource.

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:



1081
1082
1083
1084
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1081

def list_for_resource_next(next_page_link, custom_headers = nil)
  response = list_for_resource_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_for_resource_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets policy assignments for a resource.

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.



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1110

def list_for_resource_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_for_resource_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets policy assignments for a resource.

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.



1096
1097
1098
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1096

def list_for_resource_next_with_http_info(next_page_link, custom_headers = nil)
  list_for_resource_next_async(next_page_link, custom_headers).value!
end

#list_for_resource_with_http_info(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets policy assignments for a resource.

the resource. The name is case insensitive. provider. assignments. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • resource_provider_namespace (String) —

    The namespace of the resource

  • parent_resource_path (String) —

    The parent resource path.

  • resource_type (String) —

    The resource type.

  • resource_name (String) —

    The name of the resource with policy

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



463
464
465
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 463

def list_for_resource_with_http_info(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter = nil, custom_headers = nil)
  list_for_resource_async(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, filter, custom_headers).value!
end

#list_next(next_page_link, custom_headers = nil) ⇒ PolicyAssignmentListResult

Gets all the policy assignments for a subscription.

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:



1168
1169
1170
1171
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1168

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets all the policy assignments for a subscription.

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.



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1197

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyAssignmentListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

Gets all the policy assignments for a subscription.

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.



1183
1184
1185
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 1183

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the policy assignments for a subscription.

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



563
564
565
 
# File 'lib/generated/azure_mgmt_policy/policy_assignments.rb', line 563

def list_with_http_info(filter = nil, custom_headers = nil)
  list_async(filter, custom_headers).value!
end