Class: MicrosoftGraph::IdentityGovernance::EntitlementManagement::Assignments::AssignmentsRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb

Overview

Provides operations to manage the assignments property of the microsoft.graph.entitlementManagement entity.

Defined Under Namespace

Classes: AssignmentsRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new AssignmentsRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



61
62
63
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 61

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/identityGovernance/entitlementManagement/assignments{?%24top,%24skip,%24search,%24filter,%24count,%24orderby,%24select,%24expand}")
end

Instance Method Details

#additional_access ⇒ Object

Provides operations to call the additionalAccess method.



25
26
27
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 25

def additional_access()
    return MicrosoftGraph::IdentityGovernance::EntitlementManagement::Assignments::AdditionalAccess::AdditionalAccessRequestBuilder.new(@path_parameters, @request_adapter)
end

#additional_access_with_access_package_id_with_incompatible_access_package_id(access_package_id, incompatible_access_package_id) ⇒ Object

Provides operations to call the additionalAccess method.

Parameters:

  • access_package_id —

    Usage: accessPackageId=‘accessPackageId’

  • incompatible_access_package_id —

    Usage: incompatibleAccessPackageId=‘incompatibleAccessPackageId’

Returns:

  • a additional_access_with_access_package_id_with_incompatible_access_package_id_request_builder

Raises:

  • (StandardError) 


39
40
41
42
43
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 39

def additional_access_with_access_package_id_with_incompatible_access_package_id(access_package_id, incompatible_access_package_id)
    raise StandardError, 'access_package_id cannot be null' if access_package_id.nil?
    raise StandardError, 'incompatible_access_package_id cannot be null' if incompatible_access_package_id.nil?
    return AdditionalAccessWithAccessPackageIdWithIncompatibleAccessPackageIdRequestBuilder.new(@path_parameters, @request_adapter, accessPackageId, incompatibleAccessPackageId)
end

#by_access_package_assignment_id(access_package_assignment_id) ⇒ Object

Provides operations to manage the assignments property of the microsoft.graph.entitlementManagement entity.

Parameters:

  • access_package_assignment_id —

    The unique identifier of accessPackageAssignment

Returns:

  • a access_package_assignment_item_request_builder

Raises:

  • (StandardError) 


49
50
51
52
53
54
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 49

def by_access_package_assignment_id(access_package_assignment_id)
    raise StandardError, 'access_package_assignment_id cannot be null' if access_package_assignment_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["accessPackageAssignment%2Did"] = access_package_assignment_id
    return MicrosoftGraph::IdentityGovernance::EntitlementManagement::Assignments::Item::AccessPackageAssignmentItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



30
31
32
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 30

def count()
    return MicrosoftGraph::IdentityGovernance::EntitlementManagement::Assignments::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#filter_by_current_user_with_on(on) ⇒ Object

Provides operations to call the filterByCurrentUser method.

Parameters:

  • on —

    Usage: on=‘on’

Returns:

  • a filter_by_current_user_with_on_request_builder

Raises:

  • (StandardError) 


69
70
71
72
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 69

def filter_by_current_user_with_on(on)
    raise StandardError, 'on cannot be null' if on.nil?
    return FilterByCurrentUserWithOnRequestBuilder.new(@path_parameters, @request_adapter, on)
end

#get(request_configuration = nil) ⇒ Object

In Azure AD entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: $filter=accessPackage/id eq ‘a914b616-e04e-476b-aa37-91038f0b165b’.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of access_package_assignment_collection_response



78
79
80
81
82
83
84
85
86
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 78

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::AccessPackageAssignmentCollectionResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#post(body, request_configuration = nil) ⇒ Object

Create new navigation property to assignments for identityGovernance

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of access_package_assignment

Raises:

  • (StandardError) 


93
94
95
96
97
98
99
100
101
102
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 93

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::AccessPackageAssignment.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

In Azure AD entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: $filter=accessPackage/id eq ‘a914b616-e04e-476b-aa37-91038f0b165b’.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 108

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_post_request_information(body, request_configuration = nil) ⇒ Object

Create new navigation property to assignments for identityGovernance

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information

Raises:

  • (StandardError) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/identity_governance/entitlement_management/assignments/assignments_request_builder.rb', line 127

def to_post_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :POST
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.set_content_from_parsable(@request_adapter, "application/json", body)
    return request_info
end