Class: Azure::ARM::Authorization::RoleDefinitions
- Inherits:
-
Object
- Object
- Azure::ARM::Authorization::RoleDefinitions
- Includes:
- Models, MsRestAzure
- Defined in:
- lib/generated/azure_mgmt_authorization/role_definitions.rb
Overview
Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.
Instance Attribute Summary collapse
-
#client ⇒ AuthorizationManagementClient
readonly
Reference to the AuthorizationManagementClient.
Instance Method Summary collapse
-
#create_or_update(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ RoleDefinition
Creates or updates a role definition.
-
#create_or_update_async(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ Concurrent::Promise
Creates or updates a role definition.
-
#create_or_update_with_http_info(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a role definition.
-
#delete(scope, role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Deletes a role definition.
-
#delete_async(scope, role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Deletes a role definition.
-
#delete_with_http_info(scope, role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a role definition.
-
#get(scope, role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Get role definition by name (GUID).
-
#get_async(scope, role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Get role definition by name (GUID).
-
#get_by_id(role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Gets a role definition by ID.
-
#get_by_id_async(role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Gets a role definition by ID.
-
#get_by_id_with_http_info(role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a role definition by ID.
-
#get_with_http_info(scope, role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get role definition by name (GUID).
-
#initialize(client) ⇒ RoleDefinitions
constructor
Creates and initializes a new instance of the RoleDefinitions class.
-
#list(scope, filter = nil, custom_headers = nil) ⇒ Array<RoleDefinition>
Get all role definitions that are applicable at scope and above.
-
#list_as_lazy(scope, filter = nil, custom_headers = nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
-
#list_async(scope, filter = nil, custom_headers = nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
-
#list_next(next_page_link, custom_headers = nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
-
#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
-
#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
-
#list_with_http_info(scope, filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
Constructor Details
#initialize(client) ⇒ RoleDefinitions
Creates and initializes a new instance of the RoleDefinitions class.
22 23 24 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 22 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ AuthorizationManagementClient (readonly)
Returns reference to the AuthorizationManagementClient.
27 28 29 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 27 def client @client end |
Instance Method Details
#create_or_update(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ RoleDefinition
Creates or updates a role definition.
will be added to the HTTP request.
222 223 224 225 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 222 def create_or_update(scope, role_definition_id, role_definition, custom_headers = nil) response = create_or_update_async(scope, role_definition_id, role_definition, custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ Concurrent::Promise
Creates or updates a role definition.
to the HTTP request.
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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 253 def create_or_update_async(scope, role_definition_id, role_definition, custom_headers = nil) fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_definition_id is nil' if role_definition_id.nil? fail ArgumentError, 'role_definition is nil' if role_definition.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 = RoleDefinition.mapper() request_content = @client.serialize(request_mapper, role_definition, 'role_definition') request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = '/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleDefinitionId' => role_definition_id}, 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, ) 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 = RoleDefinition.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., e.backtrace, result) end end result end promise.execute end |
#create_or_update_with_http_info(scope, role_definition_id, role_definition, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a role definition.
will be added to the HTTP request.
238 239 240 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 238 def create_or_update_with_http_info(scope, role_definition_id, role_definition, custom_headers = nil) create_or_update_async(scope, role_definition_id, role_definition, custom_headers).value! end |
#delete(scope, role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Deletes a role definition.
will be added to the HTTP request.
39 40 41 42 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 39 def delete(scope, role_definition_id, custom_headers = nil) response = delete_async(scope, role_definition_id, custom_headers).value! response.body unless response.nil? end |
#delete_async(scope, role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Deletes a role definition.
to the HTTP request.
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_authorization/role_definitions.rb', line 68 def delete_async(scope, role_definition_id, custom_headers = nil) fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_definition_id is nil' if role_definition_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 = '/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleDefinitionId' => role_definition_id}, 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, ) 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 = RoleDefinition.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., e.backtrace, result) end end result end promise.execute end |
#delete_with_http_info(scope, role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a role definition.
will be added to the HTTP request.
54 55 56 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 54 def delete_with_http_info(scope, role_definition_id, custom_headers = nil) delete_async(scope, role_definition_id, custom_headers).value! end |
#get(scope, role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Get role definition by name (GUID).
will be added to the HTTP request.
130 131 132 133 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 130 def get(scope, role_definition_id, custom_headers = nil) response = get_async(scope, role_definition_id, custom_headers).value! response.body unless response.nil? end |
#get_async(scope, role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Get role definition by name (GUID).
to the HTTP request.
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 203 204 205 206 207 208 209 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 159 def get_async(scope, role_definition_id, custom_headers = nil) fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_definition_id is nil' if role_definition_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 = '/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleDefinitionId' => role_definition_id}, 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, ) 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 = RoleDefinition.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., e.backtrace, result) end end result end promise.execute end |
#get_by_id(role_definition_id, custom_headers = nil) ⇒ RoleDefinition
Gets a role definition by ID.
get. will be added to the HTTP request.
325 326 327 328 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 325 def get_by_id(role_definition_id, custom_headers = nil) response = get_by_id_async(role_definition_id, custom_headers).value! response.body unless response.nil? end |
#get_by_id_async(role_definition_id, custom_headers = nil) ⇒ Concurrent::Promise
Gets a role definition by ID.
get. to the HTTP request.
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 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 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 354 def get_by_id_async(role_definition_id, custom_headers = nil) fail ArgumentError, 'role_definition_id is nil' if role_definition_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 = '/{roleDefinitionId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'roleDefinitionId' => role_definition_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, ) 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 = RoleDefinition.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., e.backtrace, result) end end result end promise.execute end |
#get_by_id_with_http_info(role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a role definition by ID.
get. will be added to the HTTP request.
340 341 342 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 340 def get_by_id_with_http_info(role_definition_id, custom_headers = nil) get_by_id_async(role_definition_id, custom_headers).value! end |
#get_with_http_info(scope, role_definition_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get role definition by name (GUID).
will be added to the HTTP request.
145 146 147 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 145 def get_with_http_info(scope, role_definition_id, custom_headers = nil) get_async(scope, role_definition_id, custom_headers).value! end |
#list(scope, filter = nil, custom_headers = nil) ⇒ Array<RoleDefinition>
Get all role definitions that are applicable at scope and above.
atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
415 416 417 418 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 415 def list(scope, filter = nil, custom_headers = nil) first_page = list_as_lazy(scope, filter, custom_headers) first_page.get_all_items end |
#list_as_lazy(scope, filter = nil, custom_headers = nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
response.
595 596 597 598 599 600 601 602 603 604 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 595 def list_as_lazy(scope, filter = nil, custom_headers = nil) response = list_async(scope, 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(scope, filter = nil, custom_headers = nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
atScopeAndBelow filter to search below the given scope as well. to the HTTP request.
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 446 def list_async(scope, filter = nil, custom_headers = nil) fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} # 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/roleDefinitions' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'scope' => scope}, 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, ) 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 = RoleDefinitionListResult.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., e.backtrace, result) end end result end promise.execute end |
#list_next(next_page_link, custom_headers = nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
to List operation. will be added to the HTTP request.
506 507 508 509 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 506 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
Get all role definitions that are applicable at scope and above.
to List operation. to the HTTP request.
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 535 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 = { 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, ) 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 = RoleDefinitionListResult.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., e.backtrace, result) end end result end promise.execute end |
#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
to List operation. will be added to the HTTP request.
521 522 523 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 521 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(scope, filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
431 432 433 |
# File 'lib/generated/azure_mgmt_authorization/role_definitions.rb', line 431 def list_with_http_info(scope, filter = nil, custom_headers = nil) list_async(scope, filter, custom_headers).value! end |